npm是什麼

npm是前端開發廣泛使用的包管理工具，它讓js開發者分享、複用程式碼更方便。可以重複的框架程式碼被稱為包（package）或者模組(module),一個包可是是一個資料夾裡放著幾個資料夾，還有一個package.json檔案。

1、什麼是npm指令碼

　　在建立node.js專案如一個vue專案，或一個react專案時，專案都會生成一個描述檔案package.json 。

比如npm允許在package.json檔案裡面，使用scripts欄位定義指令碼命令。

{
//...
"scripts": {
 "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js","start": "npm run dev","e2e": "node test/e2e/runner.js","test": "npm run e2e","lint": "eslint --ext .js,.vue src test/e2e/specs","build": "node build/build.js"
 },}

　　上面程式碼是package.json檔案的一個片段，裡面的scripts欄位是一個物件。它的每一個屬性，對應一段指令碼。比如，build命令對應的指令碼是node build.js 。

　　命令列下使用npm run 命令，就可以執行這段指令碼。

$ npm run build

　　等同於執行：

$ node build/build.js

　　同理，上面的那段scripts中， npm run test 等同於 npm run e2e,等同於 node test/e2e/runner.js

　　這些定義在package.json裡面的指令碼，就稱為npm指令碼。專案的相關指令碼，可以集中在一個地方；不同專案的指令碼命令，只要功能相同，就可以有同樣的對外介面。比如使用者不需要知道怎麼測試你的專案，只要執行 npm run dev 即可

　　檢視當前專案的所有npm指令碼命令，可以使用不帶任何引數的 npm run 命令。

$ npm run

2、npm原理

　　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

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 。具體的執行順序如下：

prerestart prestop stop poststop restart prestart start poststart 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、package.json其他配置項說明

　　對於dependencies和devDependencies的一些說明：

　　使用npm安裝依賴時，如果使用--save安裝的依賴，會被寫到dependencies模組裡面去；

　　而使用--save-dev安裝的依賴，則會被寫到devDependencies模組裡面去；如果什麼都不寫，則預設安裝到dependencies裡面去。

　　比如我們使用的一些構建工具例如glup、webpack這些只在開發環境中才用到的包，則只需要寫到devDependencies中即可。

　　對於兩種環境的指定方式，則是通過配置檔案中的 process.env.NODE_ENV = 'development' 或 process.env.NODE_ENV = 'production' 來指定是開發還是生產環境。

12、package.json中的bin屬性

　　package.json中的bin是命令名和本地檔案的對映。如果是全域性安裝，則會把檔案對映到全域性的bin裡面去，安裝後，在任意地方開啟終端使用命令列執行該檔案；

如果是本地安裝，則會把檔案對映到本專案的./node_modules/.bin資料夾裡面，安裝後，在本工程目錄裡面使用命令列執行該檔案。

　　舉例說明：

新建一個資料夾，開啟終端，進入該資料夾，通過命令 npm init -y 建立一個package.json檔案。然後在package.json檔案同級目錄下新建一個index.js檔案，加上測試資料。注意，index.js檔案的頭部必須有這個 #!/usr/bin/env node 節點。在package.json中增加bin屬性，設定命令名和index.js的對映關係。在終端當前目錄中進行全域性安裝： npm install -g 安裝成功後，則在電腦任意資料夾開啟終端，執行package.json中bin中設定的命令，都會執行對應的index.js中的程式碼。 如下圖

　　同時，我們開啟全域性的bin資料夾，可以發現bin下面的剛剛新增的全域性命令 tan-temp-bin

　　像我們一些常用vue、vue-cli、create-react-app等都是通過bin屬性將命令對映到了全域性上的

總結

以上所述是小編給大家介紹的npm指令碼和package.json，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回覆大家的。在此也非常感謝大家對我們網站的支援！如果你覺得本文對你有幫助，歡迎轉載，煩請註明出處，謝謝！