Node 开发离不开 npm，而脚本功能是 npm 最强大、最常用的功能之一。
本文介绍如何使用 npm 脚本（npm scripts）。
一、什么是 npm 脚本？
npm 允许在package.json文件里面，使用scripts字段定义脚本命令。
上面代码是package.json文件的一个片段，里面的scripts字段是一个对象。它的每一个属性，对应一段脚本。比如，build命令对应的脚本是node build.js。
命令行下使用npm run命令，就可以执行这段脚本。
这些定义在package.json里面的脚本，就称为 npm 脚本。它的优点很多。
项目的相关脚本，可以集中在一个地方。
不同项目的脚本命令，只要功能相同，就可以有同样的对外接口。用户不需要知道怎么测试你的项目，只要运行npm run test即可。
可以利用 npm 提供的很多辅助功能。
查看当前项目的所有 npm 脚本命令，可以使用不带任何参数的npm run命令。
二、原理
npm 脚本的原理非常简单。每当执行npm run，就会自动新建一个 Shell，在这个 Shell 里面执行指定的脚本命令。因此，只要是 Shell（一般是 Bash）可以运行的命令，就可以写在 npm 脚本里面。
比较特别的是，npm run新建的这个 Shell，会将当前目录的node_modules/.bin子目录加入PATH变量，执行结束后，再将PATH变量恢复原样。
这意味着，当前目录的node_modules/.bin子目录里面的所有脚本，都可以直接用脚本名调用，而不必加上路径。比如，当前项目的依赖里面有 Mocha，只要直接写mocha test就可以了。
而不用写成下面这样。
由于 npm 脚本的唯一要求就是可以在 Shell 执行，因此它不一定是 Node 脚本，任何可执行文件都可以写在里面。
npm 脚本的退出码，也遵守 Shell 脚本规则。如果退出码不是0，npm 就认为这个脚本执行失败。
三、通配符
由于 npm 脚本就是 Shell 脚本，因为可以使用 Shell 通配符。
上面代码中，*表示任意文件名，**表示任意一层子目录。
如果要将通配符传入原始命令，防止被 Shell 转义，要将星号转义。
四、传参
向 npm 脚本传入参数，要使用--标明。
向上面的npm run lint命令传入参数，必须写成下面这样。
也可以在package.json里面再封装一个命令。
五、执行顺序
如果 npm 脚本里面需要执行多个任务，那么需要明确它们的执行顺序。
如果是并行执行（即同时的平行执行），可以使用&符号。
如果是继发执行（即只有前一个任务成功，才执行下一个任务），可以使用&&符号。
这两个符号是 Bash 的功能。此外，还可以使用 node 的任务管理模块：script-runner、npm-run-all、redrun。
六、默认值
一般来说，npm 脚本由用户提供。但是，npm 对两个脚本提供了默认值。也就是说，这两个脚本不用定义，就可以直接使用。
上面代码中，npm run start的默认值是node server.js，前提是项目根目录下有server.js这个脚本；npm run install的默认值是node-gyp rebuild，前提是项目根目录下有binding.gyp文件。
七、钩子
npm 脚本有pre和post两个钩子。举例来说，build脚本命令的钩子就是prebuild和postbuild。
用户执行npm run build的时候，会自动按照下面的顺序执行。
因此，可以在这两个钩子里面，完成一些准备工作和清理工作。下面是一个例子。
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命令编写代码。请看下面的例子。
八、简写形式
四个常用的 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_package_前缀，npm 脚本可以拿到package.json里面的字段。比如，下面是一个package.json。
那么，变量npm_package_name返回foo，变量npm_package_version返回1.2.5。
上面代码中，我们通过环境变量process.env对象，拿到package.json的字段值。如果是 Bash 脚本，可以用$npm_package_name和$npm_package_version取到这两个值。
npm_package_前缀也支持嵌套的package.json字段。
上面代码中，repository字段的type属性，可以通过npm_package_repository_type取到。
下面是另外一个例子。
上面代码中，npm_package_scripts_install变量的值等于foo.js。
然后，npm 脚本还可以通过npm_config_前缀，拿到 npm 的配置变量，即npm config get xxx命令返回的值。比如，当前模块的发行标签，可以通过npm_config_tag取到。
注意，package.json里面的config对象，可以被环境变量覆盖。
上面代码中，npm_package_config_port变量返回的是8080。这个值可以用下面的方法覆盖。
最后，env命令可以列出所有环境变量。
十、常用脚本示例
十一、参考链接
How to Use npm as a Build Tool, by Keith Cirkel
Awesome npm scripts, by Ryan Zimmerman
（完）
文档信息
版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）
发表日期： 2016年10月11日
更多内容： 档案 »
JavaScript
购买文集： 《如何变得有思想》
社交媒体： twitter， weibo
Feed订阅：