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