NPM 커스텀 명령어

NPM 커스텀 명령어

NPM 커스텀 명령어란 사용자가 임의로 명령어의 이름과 동작을 정의해서 사용할 수 있는 기능을 의미한다.

// package.json
{
  ...
  "scripts": {
    "hello": "echo hi"
  }
}

NPM 패키지 관리 파일인 package.json에 위와 같이 scripts라는 속성을 추가할 수 있다. 그리고 아래의 명령어를 실행하면 콘솔에 hi가 출력된다.

npm run hello

NPM 커스텀 명령어는 모두 npm run 명령어 이름 형식으로 실행할 수 있다.

"scripts": {
  "dev": "node server.js",
  "build": "webpack --mode=none",
}

위 코드는 서버를 실행하는 dev 명령어와 웹팩으로 빌드하는 build명령어를 정의한 코드이다. 사용자는 매번 node server.js와 webpack --mode=none를 칠 필요 없이 npm run dev와 npm run build를 입력하면 된다.

다른 커스텀 명령어 조합

"scripts": {
  "build": "webpack",
  "deploy": "npm run build -- --mode production"
}

npm run deploy

먼저 build에 정의한 webpack명령어가 실행되면서 명령어 뒤쪽에 붙은 실행 옵션들이 수행된다.

 

참고 사이트

https://joshua1988.github.io/webpack-guide/build/npm-custom-commands.html#npm-커스텀-명령어-실제-사례

NPM Custom Commands | 웹팩 핸드북