npm 腳本命令 學習筆記

什麼是 npm 腳本？

在package.json文件裏面，使用scripts字段定義的腳本命令

{
  // ...
  "scripts": {
    "build": "node build.js"
  }
}

如何執行是 npm 腳本？

$ npm run build
# 等同於執行
$ node build.js

不知道有什麼 npm 腳本？？

#查看當前項目的全部 npm 腳本命令
#(其實也能夠在package.json的看scripts對象裏有什麼屬性)
npm run

npm的原理？？

每當執行npm run，就會自動新建一個 Shell，在這個 Shell 裏面執行指定的腳本命令。
所以，只要是 Shell（通常是 Bash）能夠運行的命令，就能夠寫在 npm 腳本里面。

比較特別的是，npm run新建的這個 Shell，會將當前目錄的node_modules/.bin子目錄加入PATH變量，執行結束後，再將PATH變量恢復原樣。這意味着，當前目錄的node_modules/.bin子目錄裏面的全部腳本，均可以直接用腳本名調用，而沒必要加上路徑。

因爲 npm 腳本的惟一要求就是能夠在 Shell 執行，所以它不必定是 Node 腳本，任何可執行文件均可以寫在裏面。npm 腳本的退出碼，也遵照 Shell 腳本規則。若是退出碼不是0，npm 就認爲這個腳本執行失敗。

通配符&轉義

同shell

// *表示任意文件名，**表示任意一層子目錄
"lint": "jshint *.js"
"lint": "jshint **/*.js"
// 將通配符傳入原始命令，防止被 Shell 轉義，要將星號轉義
"test": "tap test/\*.js"

傳參

向 npm 腳本傳入參數，要使用--標明

# package.json
"deploy": "gulp deploy",
# 命令行
$ npm run deploy -- --test

一個命令執行多個任務？？

#並行執行（即同時的平行執行），使用&符號
$ npm run serve & npm run dev
#繼發執行（即只有前一個任務成功，才執行下一個任務），使用&&符號
$ npm run build && npm run deploy

默認腳本

不用定義，就能夠直接使用(前提是項目根目錄下有server.js腳本和rebuild文件)

"start": "node server.js"，
"install": "node-gyp rebuild"

鉤子

npm 腳本有pre和post兩個鉤子

例子

# package.json
"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

自定義的腳本命令也能夠加上pre和post鉤子。好比，myscript這個腳本命令，也有premyscript和postmyscript鉤子。不過，雙重的pre和post無效，好比prepretest和postposttest是無效的。

默認的鉤子

prepublish，postpublish
preinstall，postinstall
preuninstall，postuninstall
preversion，postversion
pretest，posttest
prestop，poststop
prestart，poststart
prerestart，postrestart

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 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的簡寫

執行順序
1 prerestart
2 prestop
3 stop
4 poststop
5 restart
6 prestart
7 start
8 poststart
9 postrestart

npm 的內部變量

經過npm_package_前綴，npm 腳本能夠拿到package.json裏面的字段
(若是是 Bash 腳本，能夠用$npm_package_前綴取值)

// package.json
{
  "name": "foo", 
  "version": "1.2.5",
  "config" : { "port" : "8080" },
  "scripts": {
    "view": "node view.js",
    "start" : "node server.js"
  }
}

// view.js
console.log(process.env.npm_package_name); // foo
console.log(process.env.npm_package_version_view); // node view.js

npm 腳本還能夠經過npm_config_前綴，拿到 npm 的配置變量，即npm config get xxx命令返回的值。
好比，當前模塊的發行標籤，能夠經過npm_config_tag取到。

"view": "echo $npm_config_tag",

注意 package.json裏面的config對象，能夠被環境變量覆蓋。

$ npm config set foo:port 80

列出全部環境變量

"env": "env"

經常使用腳本示例

// 刪除目錄
"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",