npm scripts 使用指南

1、什么是 npm 脚本？

npm 容许在package.json文件里面，使用scripts字段定义脚本命令。

{
  // ...
  "scripts": {
    "build": "node build.js"
  }
}

上面代码是package.json文件的一个片断，里面的scripts字段是一个对象。它的每个属性，对应一段脚本。好比，build命令对应的脚本是node build.js。

命令行下使用npm run命令，就能够执行这段脚本。

$ npm run build
# 等同于执行
$ node build.js

这些定义在package.json里面的脚本，就称为 npm 脚本。它的优势不少。

1. 项目的相关脚本，能够集中在一个地方。
2. 不一样项目的脚本命令，只要功能相同，就能够有一样的对外接口。用户不须要知道怎么测试你的项目，只要运行npm run test便可。
   能够利用 npm 提供的不少辅助功能。
3. 查看当前项目的全部 npm 脚本命令，可使用不带任何参数的npm run命令。

$ npm run

2、原理

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

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

这意味着，当前目录的node_modules/.bin子目录里面的全部脚本，均可以直接用脚本名调用，而没必要加上路径。好比，当前项目的依赖里面有 Mocha，只要直接写mocha test就能够了。

"test": "mocha test"

而不用写成下面这样。

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

因为 npm 脚本的惟一要求就是能够在 Shell 执行，所以它不必定是 Node 脚本，任何可执行文件均可以写在里面。

npm 脚本的退出码，也遵照 Shell 脚本规则。若是退出码不是0，npm 就认为这个脚本执行失败。

3、通配符

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

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

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

若是要将通配符传入原始命令，防止被 Shell 转义，要将星号转义。

"test": "tap test/\*.js"

4、传参

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

"lint": "jshint **.js"

向上面的npm run lint命令传入参数，必须写成下面这样。

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

也能够在package.json里面再封装一个命令。

"lint": "jshint **.js",
"lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"

5、执行顺序

若是 npm 脚本里面须要执行多个任务，那么须要明确它们的执行顺序。

若是是并行执行（即同时的平行执行），可使用&符号。

$ npm run script1.js & npm run script2.js

若是是继发执行（即只有前一个任务成功，才执行下一个任务），可使用&&符号。

$ npm run script1.js && npm run script2.js

这两个符号是 Bash 的功能。此外，还可使用 node 的任务管理模块：script-runner、npm-run-all、redrun。

6、默认值

通常来讲，npm 脚本由用户提供。可是，npm 对两个脚本提供了默认值。也就是说，这两个脚本不用定义，就能够直接使用。

"start": "node server.js"，
"install": "node-gyp rebuild"

上面代码中，npm run start的默认值是node server.js，前提是项目根目录下有server.js这个脚本；npm run install的默认值是node-gyp rebuild，前提是项目根目录下有binding.gyp文件。

7、钩子

npm 脚本有pre和post两个钩子。举例来讲，build脚本命令的钩子就是prebuild和postbuild。

"prebuild": "echo I run before the build script",
"build": "cross-env NODE_ENV=production webpack",
"postbuild": "echo I run after the build script"

用户执行npm run build的时候，会自动按照下面的顺序执行。

npm run prebuild && npm run build && npm run postbuild

所以，能够在这两个钩子里面，完成一些准备工做和清理工做。下面是一个例子。

"clean": "rimraf ./dist && mkdir dist",
"prebuild": "npm run clean",
"build": "cross-env NODE_ENV=production webpack"

npm 默认提供下面这些钩子。

• prepublish，postpublish
• preinstall，postinstall
• preuninstall，postuninstall
• preversion，postversion
• pretest，posttest
• prestop，poststop
• prestart，poststart
• prerestart，postrestart

自定义的脚本命令也能够加上pre和post钩子。好比，myscript这个脚本命令，也有premyscript和postmyscript钩子。不过，双重的pre和post无效，好比prepretest和postposttest是无效的。

npm 提供一个npm_lifecycle_event变量，返回当前正在运行的脚本名称，好比pretest、test、posttest等等。因此，能够利用这个变量，在同一个脚本文件里面，为不一样的npm scripts命令编写代码。请看下面的例子。

const TARGET = process.env.npm_lifecycle_event;

if (TARGET === 'test') {
  console.log(`Running the test task!`);
}

if (TARGET === 'pretest') {
  console.log(`Running the pretest task!`);
}

if (TARGET === 'posttest') {
  console.log(`Running the posttest task!`);
}

注意，prepublish这个钩子不只会在npm publish命令以前运行，还会在npm install（不带任何参数）命令以前运行。这种行为很容易让用户感到困惑，因此 npm 4 引入了一个新的钩子prepare，行为等同于prepublish，而从 npm 5 开始，prepublish将只在npm publish命令以前运行。

8、简写形式

四个经常使用的 npm 脚本有简写形式。

• npm start是npm run start
• npm stop是npm run stop的简写
• npm test是npm run test的简写
• npm restart是npm run stop && npm run restart && npm run start的简写

npm start、npm stop和npm restart都比较好理解，而npm restart是一个复合命令，实际上会执行三个脚本命令：stop、restart、start。具体的执行顺序以下。

1. prerestart
2. prestop
3. stop
4. poststop
5. restart
6. prestart
7. start
8. poststart
9. postrestart

9、变量

npm 脚本有一个很是强大的功能，就是可使用 npm 的内部变量。

首先，经过npm_package_前缀，npm 脚本能够拿到package.json里面的字段。好比，下面是一个package.json。

{
  "name": "foo", 
  "version": "1.2.5",
  "scripts": {
    "view": "node view.js"
  }
}

那么，变量npm_package_name返回foo，变量npm_package_version返回1.2.5。

// view.js
console.log(process.env.npm_package_name); // foo
console.log(process.env.npm_package_version); // 1.2.5

上面代码中，咱们经过环境变量process.env对象，拿到package.json的字段值。若是是 Bash 脚本，能够用$npm_package_name和$npm_package_version取到这两个值。

npm_package_前缀也支持嵌套的package.json字段。

"repository": {
    "type": "git",
    "url": "xxx"
  },
  scripts: {
    "view": "echo $npm_package_repository_type"
  }

上面代码中，repository字段的type属性，能够经过npm_package_repository_type取到。

下面是另一个例子。

"scripts": {
  "install": "foo.js"
}

上面代码中，npm_package_scripts_install变量的值等于foo.js。

而后，npm 脚本还能够经过npm_config_前缀，拿到 npm 的配置变量，即npm config get xxx命令返回的值。好比，当前模块的发行标签，能够经过npm_config_tag取到。

"view": "echo $npm_config_tag",

注意，package.json里面的config对象，能够被环境变量覆盖。

{ 
  "name" : "foo",
  "config" : { "port" : "8080" },
  "scripts" : { "start" : "node server.js" }
}

上面代码中，npm_package_config_port变量返回的是8080。这个值能够用下面的方法覆盖。

$ npm config set foo:port 80

最后，env命令能够列出全部环境变量。

"env": "env"

10、经常使用脚本示例

// 删除目录
"clean": "rimraf dist/*",

// 本地搭建一个 HTTP 服务
"serve": "http-server -p 9090 dist/",

// 打开浏览器
"open:dev": "opener http://localhost:9090",

// 实时刷新
"livereload": "live-reload --port 9091 dist/",

// 构建 HTML 文件
"build:html": "jade index.jade > dist/index.html",

// 只要 CSS 文件有变更，就从新执行构建
"watch:css": "watch 'npm run build:css' assets/styles/",

// 只要 HTML 文件有变更，就从新执行构建
"watch:html": "watch 'npm run build:html' assets/html",

// 部署到 Amazon S3
"deploy:prod": "s3-cli sync ./dist/ s3://example-com/prod-site/",

// 构建 favicon
"build:favicon": "node scripts/favicon.js",

11、参考连接

• How to Use npm as a Build Tool, by Keith Cirkel
• Awesome npm scripts, by Ryan Zimmerman