title: npm script
tags:

  • 前端
  • npm script
    categories:
  • 前端
    date: 2020-01-20 10:09:00

原理

npm脚本的原理非常简单。每当执行npm run，就会自动新建一个 Shell，在这个Shell里面执行指定的脚本命令。因此，只要是Shell（一般是 Bash）可以运行的命令，就可以写在 npm脚本里面。

比较特别的是，npm run新建的这个Shell，会将当前目录的node_modules/.bin子目录加入PATH变量，执行结束后，再将PATH变量恢复原样。

这意味着，当前目录的node_modules/.bin子目录里面的所有脚本，都可以直接用脚本名调用，而不必加上路径。比如，当前项目的依赖里面有Mocha，只要直接写mocha test就可以了。
例如

  1. "test": "mocha test"

而不用写成下面这样。

"test": "./node_modules/.bin/mocha test"

npm通配符

由于npm脚本就是Shell脚本，因为可以使用Shell通配符。

  1. "lint": "jshint *.js"
  2. "lint": "jshint **/*.js"

上面代码中，*表示任意文件名，**表示任意一层子目录。

npm传参

向npm脚本传入参数，要使用--标明。

"lint": "jshint **.js"
向上面的npm run lint命令传入参数，必须写成下面这样。

$ npm run lint -- --reporter checkstyle > checkstyle.xml