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",
複製代碼