npm script详解

什么是 npm script

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脚本。它的优势不少。

• 项目的相关脚本，能够集中在一个地方。
• 不一样项目的脚本命令，只要功能相同，就能够有一样的对外接口。
• 用户不须要知道怎么测试你的项目，只要运行npm run test便可。
• 能够利用 npm 提供的不少辅助功能。

查看当前项目的全部 npm 脚本命令，可使用不带任何参数的npm run命令。

$ npm run
复制代码

---

原理

npm run 其实是 npm run-script 命令的简写

• 从 package.json 文件中读取 scripts 对象里面的所有配置；
• 以传给 npm run 的第一个参数做为键，如dev，在 scripts 对象里面获取对应的值做为接下来要执行的命令，若是没找到直接报错；

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

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

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

"test": "mocha test"
复制代码

通配符

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

"lint": "jshint *.js"
"lint": "jshint **/*.js"
复制代码

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

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

"test": "tap test/\*.js"
复制代码

---

传参

给 npm script 传递参数 给 npm script 传递参数 eslint 内置了代码风格自动修复模式，只需给它传入 --fix 参数便可，在 scripts 中声明检查代码命令的同时你可能也须要声明修复代码的命令，面对这种需求，大多数同窗可能会忍不住复制粘贴，以下：

@@ -5,6 +5,7 @@
     "lint:js": "eslint *.js",
+    "lint:js:fix": "eslint *.js --fix",
复制代码

在 lint:js 命令比较短的时候复制粘贴的方法简单粗暴有效，可是当 lint:js 命令变的很长以后，不免后续会有人改了 lint:js 而忘记修改 lint:js:fix（别问我为啥，我就是踩着坑过来的），更健壮的作法是，在运行 npm script 时给定额外的参数，代码修改以下：

@@ -5,6 +5,7 @@
     "lint:js": "eslint *.js",
+    "lint:js:fix": "npm run lint:js -- --fix",
复制代码

要格外注意 --fix 参数前面的 -- 分隔符，意指要给 npm run lint:js 实际指向的命令传递额外的参数。

---

注释

"test": "# 运行全部代码检查和单元测试 \n npm-run-all --parallel lint:* mocha"
复制代码

或者在单独的文件中能够自由给它添加注释

---

日志

npm run test --loglevel silent
npm run test --slient
npm run test -s
复制代码

这个日志级别，只有命令自己的输出，读起来很是的简洁

npm run test --loglevel verbose
npm run test --verbose
npm run test -d
复制代码

这个日志级别，详细打印出了每一个步骤的参数、返回值

---

执行顺序

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

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

$ npm run script1.js & npm run script2.js
复制代码

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

$ npm run script1.js && npm run script2.js
复制代码

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

// 串行
{
-    "test": "npm run lint:js && npm run lint:css && npm run lint:json && npm run lint:markdown"
+    "test": "npm-run-all lint:js lint:css lint:json lint:markdown"
   },
// 并行 --parallel
{
-    "test": "npm-run-all lint:*"
+    "test": "npm-run-all --parallel lint:* mocha"
}
复制代码

---

默认值

通常来讲，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文件。

---

钩子

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命令以前运行。

---

简写形式

四个经常使用的 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。具体的执行顺序以下。

prerestart
prestop
stop
poststop
restart
prestart
start
poststart
postrestart
复制代码

---

变量

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

运行 npm run env能拿到完整的变量列表

使用npm run env | grep npm_package | sort 拿到部分排序后的环境变量

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

{
  "name": "foo", 
  "version": "1.2.5",
  "config" : { "port" : "8080" },
  "scripts" : { "start" : "node server.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_scripts_start

---

结合 npm script 和 git-hooks

Git 在代码版本管理以外，也提供了相似 npm script 里 pre、post 的钩子机制，叫作 Git Hooks，钩子机制能让咱们在代码 commit、push 以前（后）作本身想作的事情。

前端社区里有多种结合 npm script 和 git-hooks 的方案，好比 pre-commit、husky，相比较而言 husky 更好用，它支持更多的 Git Hooks 种类，再结合 lint-staged 使用就更好了。

了解更多

---

经常使用脚本示例

// 删除目录
"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",
复制代码