一、什么是 npm 腳本？
npm 允許在package.json文件里面贞瞒，使用scripts字段定義腳本命令。
{ // ... "scripts": { "build": "node build.js" } }
上面代碼是package.json文件的一個(gè)片段趁曼，里面的scripts字段是一個(gè)對(duì)象军浆。它的每一個(gè)屬性，對(duì)應(yīng)一段腳本挡闰。比如乒融，build命令對(duì)應(yīng)的腳本是node build.js。
命令行下使用npm run命令摄悯，就可以執(zhí)行這段腳本赞季。
$ npm run build # 等同于執(zhí)行 $ node build.js
這些定義在package.json里面的腳本，就稱為 npm 腳本射众。它的優(yōu)點(diǎn)很多碟摆。
- 項(xiàng)目的相關(guān)腳本，可以集中在一個(gè)地方叨橱。
- 不同項(xiàng)目的腳本命令典蜕，只要功能相同舀奶，就可以有同樣的對(duì)外接口。用戶不需要知道怎么測(cè)試你的項(xiàng)目刊棕，只要運(yùn)行
npm run test即可察郁。- 可以利用 npm 提供的很多輔助功能。
查看當(dāng)前項(xiàng)目的所有 npm 腳本命令轩缤，可以使用不帶任何參數(shù)的npm run命令命迈。
$ npm run
二、原理
npm 腳本的原理非常簡(jiǎn)單火的。每當(dāng)執(zhí)行npm run壶愤，就會(huì)自動(dòng)新建一個(gè) Shell，在這個(gè) Shell 里面執(zhí)行指定的腳本命令馏鹤。因此征椒，只要是 Shell（一般是 Bash）可以運(yùn)行的命令，就可以寫在 npm 腳本里面湃累。
比較特別的是勃救，npm run新建的這個(gè) Shell，會(huì)將當(dāng)前目錄的node_modules/.bin子目錄加入PATH變量治力，執(zhí)行結(jié)束后蒙秒，再將PATH變量恢復(fù)原樣。
這意味著宵统，當(dāng)前目錄的node_modules/.bin子目錄里面的所有腳本晕讲，都可以直接用腳本名調(diào)用，而不必加上路徑马澈。比如益兄，當(dāng)前項(xiàng)目的依賴?yán)锩嬗?Mocha，只要直接寫mocha test就可以了箭券。
"test": "mocha test"
而不用寫成下面這樣净捅。
"test": "./node_modules/.bin/mocha test"
由于 npm 腳本的唯一要求就是可以在 Shell 執(zhí)行，因此它不一定是 Node 腳本辩块，任何可執(zhí)行文件都可以寫在里面蛔六。
npm 腳本的退出碼，也遵守 Shell 腳本規(guī)則废亭。如果退出碼不是0国章，npm 就認(rèn)為這個(gè)腳本執(zhí)行失敗。
三豆村、通配符
由于 npm 腳本就是 Shell 腳本液兽，因?yàn)榭梢允褂?Shell 通配符。
"lint": "jshint *.js" "lint": "jshint **/*.js"
上面代碼中，*表示任意文件名四啰，**表示任意一層子目錄宁玫。
如果要將通配符傳入原始命令，防止被 Shell 轉(zhuǎn)義柑晒，要將星號(hào)轉(zhuǎn)義欧瘪。
"test": "tap test/\*.js"
四、傳參
向 npm 腳本傳入?yún)?shù)匙赞，要使用--標(biāo)明佛掖。
"lint": "jshint **.js"
向上面的npm run lint命令傳入?yún)?shù)，必須寫成下面這樣涌庭。
$ npm run lint -- --reporter checkstyle > checkstyle.xml
也可以在package.json里面再封裝一個(gè)命令芥被。
"lint": "jshint **.js", "lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"
五、執(zhí)行順序
如果 npm 腳本里面需要執(zhí)行多個(gè)任務(wù)坐榆，那么需要明確它們的執(zhí)行順序撕彤。
如果是并行執(zhí)行（即同時(shí)的平行執(zhí)行），可以使用&符號(hào)猛拴。
$ npm run script1.js & npm run script2.js
如果是繼發(fā)執(zhí)行（即只有前一個(gè)任務(wù)成功，才執(zhí)行下一個(gè)任務(wù)）蚀狰，可以使用&&符號(hào)愉昆。
$ npm run script1.js && npm run script2.js
這兩個(gè)符號(hào)是 Bash 的功能。此外麻蹋，還可以使用 node 的任務(wù)管理模塊：script-runner跛溉、npm-run-all、redrun扮授。
六芳室、默認(rèn)值
一般來說，npm 腳本由用戶提供刹勃。但是堪侯，npm 對(duì)兩個(gè)腳本提供了默認(rèn)值。也就是說荔仁，這兩個(gè)腳本不用定義伍宦，就可以直接使用。
"start": "node server.js"乏梁， "install": "node-gyp rebuild"
上面代碼中次洼，npm run start的默認(rèn)值是node server.js，前提是項(xiàng)目根目錄下有server.js這個(gè)腳本遇骑；npm run install的默認(rèn)值是node-gyp rebuild卖毁，前提是項(xiàng)目根目錄下有binding.gyp文件。
七落萎、鉤子
npm 腳本有pre和post兩個(gè)鉤子亥啦。舉例來說炭剪，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"
用戶執(zhí)行npm run build的時(shí)候禁悠，會(huì)自動(dòng)按照下面的順序執(zhí)行念祭。
npm run prebuild && npm run build && npm run postbuild
因此，可以在這兩個(gè)鉤子里面碍侦，完成一些準(zhǔn)備工作和清理工作粱坤。下面是一個(gè)例子。
"clean": "rimraf ./dist && mkdir dist", "prebuild": "npm run clean", "build": "cross-env NODE_ENV=production webpack"
npm 默認(rèn)提供下面這些鉤子瓷产。
- prepublish站玄，postpublish
- preinstall，postinstall
- preuninstall濒旦，postuninstall
- preversion株旷，postversion
- pretest，posttest
- prestop尔邓，poststop
- prestart晾剖，poststart
- prerestart，postrestart
自定義的腳本命令也可以加上pre和post鉤子梯嗽。比如齿尽，myscript這個(gè)腳本命令，也有premyscript和postmyscript鉤子灯节。不過循头，雙重的pre和post無效，比如prepretest和postposttest是無效的炎疆。
npm 提供一個(gè)npm_lifecycle_event變量卡骂，返回當(dāng)前正在運(yùn)行的腳本名稱，比如pretest形入、test全跨、posttest等等。所以亿遂，可以利用這個(gè)變量螟蒸，在同一個(gè)腳本文件里面，為不同的npm scripts命令編寫代碼崩掘。請(qǐng)看下面的例子七嫌。
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這個(gè)鉤子不僅會(huì)在npm publish命令之前運(yùn)行苞慢，還會(huì)在npm install（不帶任何參數(shù)）命令之前運(yùn)行诵原。這種行為很容易讓用戶感到困惑，所以 npm 4 引入了一個(gè)新的鉤子prepare，行為等同于prepublish绍赛，而從 npm 5 開始蔓纠，prepublish將只在npm publish命令之前運(yùn)行。
八吗蚌、簡(jiǎn)寫形式
四個(gè)常用的 npm 腳本有簡(jiǎn)寫形式腿倚。
npm start是npm run startnpm stop是npm run stop的簡(jiǎn)寫npm test是npm run test的簡(jiǎn)寫npm restart是npm run stop && npm run restart && npm run start的簡(jiǎn)寫
npm start、npm stop和npm restart都比較好理解蚯妇，而npm restart是一個(gè)復(fù)合命令敷燎，實(shí)際上會(huì)執(zhí)行三個(gè)腳本命令：stop、restart箩言、start硬贯。具體的執(zhí)行順序如下。
- prerestart
- prestop
- stop
- poststop
- restart
- prestart
- start
- poststart
- postrestart
九陨收、變量
npm 腳本有一個(gè)非常強(qiáng)大的功能饭豹，就是可以使用 npm 的內(nèi)部變量。
首先务漩，通過npm_package_前綴拄衰，npm 腳本可以拿到package.json里面的字段。比如饵骨，下面是一個(gè)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
上面代碼中包吝，我們通過環(huán)境變量process.env對(duì)象饼煞，拿到package.json的字段值。如果是 Bash 腳本诗越，可以用$npm_package_name和$npm_package_version取到這兩個(gè)值砖瞧。
npm_package_前綴也支持嵌套的package.json字段。
"repository": { "type": "git", "url": "xxx" }, scripts: { "view": "echo $npm_package_repository_type" }
上面代碼中嚷狞，repository字段的type屬性块促，可以通過npm_package_repository_type取到。
下面是另外一個(gè)例子床未。
"scripts": { "install": "foo.js" }
上面代碼中竭翠，npm_package_scripts_install變量的值等于foo.js。
然后薇搁，npm 腳本還可以通過npm_config_前綴斋扰，拿到 npm 的配置變量，即npm config get xxx命令返回的值。比如传货，當(dāng)前模塊的發(fā)行標(biāo)簽屎鳍，可以通過npm_config_tag取到。
"view": "echo $npm_config_tag",
注意问裕，package.json里面的config對(duì)象逮壁，可以被環(huán)境變量覆蓋。
{ "name" : "foo", "config" : { "port" : "8080" }, "scripts" : { "start" : "node server.js" } }
上面代碼中粮宛，npm_package_config_port變量返回的是8080窥淆。這個(gè)值可以用下面的方法覆蓋。
$ npm config set foo:port 80
最后窟勃，env命令可以列出所有環(huán)境變量祖乳。
"env": "env"
十、常用腳本示例
// 刪除目錄 "clean": "rimraf dist/*", // 本地搭建一個(gè) HTTP 服務(wù) "serve": "http-server -p 9090 dist/", // 打開瀏覽器 "open:dev": "opener http://localhost:9090", // 實(shí)時(shí)刷新 "livereload": "live-reload --port 9091 dist/", // 構(gòu)建 HTML 文件 "build:html": "jade index.jade > dist/index.html", // 只要 CSS 文件有變動(dòng)秉氧，就重新執(zhí)行構(gòu)建 "watch:css": "watch 'npm run build:css' assets/styles/", // 只要 HTML 文件有變動(dòng)眷昆，就重新執(zhí)行構(gòu)建 "watch:html": "watch 'npm run build:html' assets/html", // 部署到 Amazon S3 "deploy:prod": "s3-cli sync ./dist/ s3://example-com/prod-site/", // 構(gòu)建 favicon "build:favicon": "node scripts/favicon.js",
十一、參考鏈接
- How to Use npm as a Build Tool, by Keith Cirkel
- Awesome npm scripts, by Ryan Zimmerman
