npm run-script 全方位解讀

本文參考了NPM中文文檔寫做而成的

npm run-script 功能

運行 package.json 裏面的 scripts

npm run-script使用

npm run-script <command> [--silent][-- <args>...]

alias: npm run

npm run-script 說明

這將從包的"scripts"對象運行任意命令。

若是未 "command"提供，它將列出可用的腳本。

run[-script]由測試，啓動，從新啓動和中止命令使用，但也能夠直接調用。

打印軟件包中的腳本後，它們將分爲生命週期（測試，啓動，從新啓動）和直接運行的腳本。

從開始 npm@2.0.0，您能夠在執行腳本時使用自定義參數。 特殊選項-由getopt用來分隔選項的結尾。 npm將-以後的全部參數直接傳遞給您的腳本：

npm run test -- --grep="pattern"

參數將僅傳遞到後面指定的腳本，npm run 而不會傳遞到任何前置或後置腳本。

該 env 腳本是一個特殊的內置命令，可用於列出運行時腳本可以使用的環境變量。若是您的軟件包中定義了「 env」命令，它將優先於內置命令。

除了外殼的預先存在的 PATH，npm run 增長了 node_modules/.bin 對 PATH 提供給腳本。本地安裝的依賴項提供的任何二進制文件均可以不帶 node_modules/.bin 前綴使用。例如，若是包裝中有 devDependencyon tap，則應輸入：

"scripts": {"test": "tap test/\*.js"}

代替

"scripts": {"test": "node_modules/.bin/tap test/\*.js"}

運行測試。

您的腳本在其中運行的實際外殼取決於平臺。默認狀況下，在相似 Unix 的系統上，它是/bin/sh 命令；在 Windows 上，它是命令 cmd.exe。所引用的實際 shell /bin/sh 也取決於系統。

從那時起，npm@5.1.0 您能夠使用 script-shell 配置自定義外殼。

腳本從模塊的根目錄運行，而無論調用時當前的工做目錄是什麼 npm run。

若是您但願腳本根據您所在的子目錄使用不一樣的行爲，則能夠使用 INIT_CWD 環境變量，該變量保存您運行時所在的完整路徑 npm run。

npm run 將 NODE 環境變量設置爲 node 可執行的可執行文件 npm。

另外，若是--scripts-prepend-node-path 經過，則將 node 駐留的目錄添加到中 PATH。

若是--scripts-prepend-node-path=auto 經過了（這是 npmv3 中的默認值），則僅當在中 node 找不到該可執行文件時才執行此操做 PATH。

若是您嘗試在沒有 node_modules 目錄的狀況下運行腳本，

但腳本失敗，則會警告您運行 npm install，以防萬一您忘記了。

您能夠使用該--silent 標誌來防止 npm ERR!錯誤顯示輸出。

您能夠使用該--if-present 標誌來避免在腳本未定義時以非零的退出代碼退出。

這使您能夠運行可能未定義的腳本，而無需中斷執行鏈。

本文參考NPM中文文檔