主頁 > 知識庫 > 詳解npm腳本和package.json

詳解npm腳本和package.json

npm是什么

npm是前端開發(fā)廣泛使用的包管理工具，它讓js開發(fā)者分享、復用代碼更方便?？梢灾貜偷目蚣艽a被稱為包（package）或者模塊(module),一個包可是是一個文件夾里放著幾個文件夾，還有一個package.json文件。

1、什么是npm腳本

　　在創(chuàng)建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 命令，就可以執(zhí)行這段腳本。

$ npm run build

　　等同于執(zhí)行：

$ node build/build.js

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

　　這些定義在package.json里面的腳本，就稱為npm腳本。項目的相關腳本，可以集中在一個地方；不同項目的腳本命令，只要功能相同，就可以有同樣的對外接口。比如用戶不需要知道怎么測試你的項目，只要運行 npm run dev 即可

　　查看當前項目的所有npm腳本命令，可以使用不帶任何參數(shù)的 npm run 命令。

$ npm run

2、npm原理

　　npm腳本的原理非常簡單。每當執(zhí)行 npm run ，就會自動創(chuàng)建一個shell腳本, 在這個shell里面執(zhí)行指定的腳本命令。因此，只需要是shell (一般是bash) 可以運行的命令，就可以寫在npm腳本里面。

　　比較特別的是，npm run 新建的這個shell, 會將當前目錄的node_modules/.bin 子目錄加入PATH 變量，執(zhí)行結束后，再將PATH變量恢復原樣。還意味著，當前目錄的node_modules/.bin 子目錄里面的所有腳本，都可以直接用腳本名調(diào)用，而不必加上路徑。比如，當前項目的依賴里面有Mocha, 只要直接寫 mocha test 就可以了。

"test": "mocha test"

　　而不用寫成下面這樣。

"test": "./node_modules/.bin/mocha test"

　　由于npm腳本的唯一要求就是可以在shell中執(zhí)行，因此它不一定是Node腳本，任何可執(zhí)行文件都可以寫在里面。npm腳本的退出碼，也遵守shell腳本規(guī)則。如果退出碼不是0，npm 就認為這個腳本執(zhí)行失敗。

3、通配符

　　由于npm腳本就是shell腳本，因此可以使用shell通配符。

"lint": "jshint *.js"
"lint": "jshint **/*.js"

　　上面代碼中，* 表示任意文件名，**表示任意一層子目錄。如果要將通配符傳入原始命令，防止被shell轉(zhuǎn)義，要將*號轉(zhuǎn)義。

"test": "tap test/\*.js"

4、傳參

　　向npm腳本傳入?yún)?shù)，要使用 -- 標明。

"lint": "jshint **.js"

　　向上面的 npm run lint 命令傳入?yún)?shù)，必須寫成下面這樣。

$ npm run lint -- --reporter checkstyle > checkstyle.xml

　也可以再package.json里面封裝一個命令。

"lint": "jshint **.js",
"lint:checkstyle": "npm run lint -- --reporter checkstyle > checkstyle.xml"

5、執(zhí)行順序

　　如果npm腳本里面需要執(zhí)行多個任務，那么需要明確它們的執(zhí)行順序。如果是并行執(zhí)行（即同時的平行執(zhí)行），可以使用符號。

$ npm run script1.js npm run script2.js

　　如果是繼發(fā)執(zhí)行（即只有前一個任務成功，才能執(zhí)行下一個任務），可以使用符號。

$ 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"

　　用戶執(zhí)行npm run build的時候，會自動按照下面的順序執(zhí)行。

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 （不帶任何參數(shù)）命令之前運行。這種行為很容易讓用戶感到困惑，所以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 是一個復合命令，實際上會執(zhí)行三個腳本命令：stop、restart、start 。具體的執(zhí)行順序如下：

prerestart prestop stop poststop restart prestart start poststart postrestart

9、變量

　　npm腳本有一個非常強大的功能，就是可以使用npm的內(nèi)部變量。

首先，通過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

　　上面代碼中，我們通過環(huán)境變量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 命令返回的值。比如，當前模塊的發(fā)行標簽，可以通過npm_config_tag取到。

"view": "echo $npm_config_tag",

　　注意，package.json里面的config對象，可以被環(huán)境變量覆蓋。

{ 
 "name" : "foo",
 "config" : { "port" : "8080" },
 "scripts" : { "start" : "node server.js" }
}

　　上面代碼中，npm_package_config_port 變量返回的是8080。這個值可以用下面的方法覆蓋。

$ npm config set foo:port 80

　　最后，env命令可以列出所有環(huán)境變量。

"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 文件有變動，就重新執(zhí)行構建
"watch:css": "watch 'npm run build:css' assets/styles/",

// 只要 HTML 文件有變動，就重新執(zhí)行構建
"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這些只在開發(fā)環(huán)境中才用到的包，則只需要寫到devDependencies中即可。

　　對于兩種環(huán)境的指定方式，則是通過配置文件中的 process.env.NODE_ENV = 'development' 或 process.env.NODE_ENV = 'production' 來指定是開發(fā)還是生產(chǎn)環(huán)境。

12、package.json中的bin屬性

　　package.json中的bin是命令名和本地文件的映射。如果是全局安裝，則會把文件映射到全局的bin里面去，安裝后，在任意地方打開終端使用命令行執(zhí)行該文件；

如果是本地安裝，則會把文件映射到本項目的./node_modules/.bin文件夾里面，安裝后，在本工程目錄里面使用命令行執(zhí)行該文件。

　　舉例說明：

新建一個文件夾，打開終端，進入該文件夾，通過命令 npm init -y 創(chuàng)建一個package.json文件。然后在package.json文件同級目錄下新建一個index.js文件，加上測試數(shù)據(jù)。注意，index.js文件的頭部必須有這個 #!/usr/bin/env node 節(jié)點。在package.json中增加bin屬性，設置命令名和index.js的映射關系。在終端當前目錄中進行全局安裝： npm install -g 安裝成功后，則在電腦任意文件夾打開終端，執(zhí)行package.json中bin中設置的命令，都會執(zhí)行對應的index.js中的代碼。如下圖