每個Nodejs項(xiàng)目的根目錄下面俄精,一般都會有一個package.json文件询筏。該文件可以由npm init
生成,定義了項(xiàng)目所需要的各種模塊竖慧,以及項(xiàng)目的配置信息(比如名稱嫌套、版本、許可證等元數(shù)據(jù))圾旨。
package.json文件內(nèi)部就是一個JSON對象踱讨,該對象的每一個成員就是當(dāng)前項(xiàng)目的一項(xiàng)設(shè)置。
基本字段
-
name
項(xiàng)目名稱(npm包名)砍的。必需字段
-
version
項(xiàng)目版本痹筛。必需字段。
版本號的格式為"1.0.0",分別代表“主版本號.次版本號.修訂號”廓鞠。它的遞增規(guī)則如下:- 主版本號:當(dāng)你做了不兼容的API 修改帚稠;
- 次版本號:當(dāng)你做了向下兼容的功能性新增;
- 修訂號:當(dāng)你做了向下兼容的問題修正床佳。
在實(shí)際使用中滋早,一般可以看到各種形式的版本號:
*: 任意版本 1.1.0: 指定版本 ~1.1.0: 1.1.0 <= 版本 < 1.2.0 ^1.1.0: 1.1.0 <= 版本 < 2.0.0 latest:安裝最新版本。
-
*
表示任意版本砌们; -
~
前綴表示杆麸,安裝大于指定的這個版本搁进,并且匹配到 x.y.z 中 z 最新的版本; -
^
前綴在 ^0.y.z 時的表現(xiàn)和 ~0.y.z 是一樣的角溃,然而 ^1.y.z 的時候拷获,就會匹配到 y 和 z 都是最新的版本; - 特殊的是减细,當(dāng)版本號為 ^0.0.z 或者 ~0.0.z 的時候,考慮到 0.0.z 是一個不穩(wěn)定版本赢笨, 所以它們都相當(dāng)于 =0.0.z未蝌。
-
author && contributors
項(xiàng)目作者以及貢獻(xiàn)者。author是字符串形式的作者名茧妒,contributors是一個項(xiàng)目貢獻(xiàn)者數(shù)組萧吠。
-
description && keywords
項(xiàng)目描述和項(xiàng)目關(guān)鍵字。幫助人們在使用npm search時找到這個包桐筏。
-
license
許可證纸型。
功能性字段
-
scripts
定義腳本命令。它的每一個屬性梅忌,對應(yīng)一段腳本狰腌。并且可以在命令行下使用npm run命令執(zhí)行這段腳本。
npm 腳本的原理非常簡單牧氮。每當(dāng)執(zhí)行npm run琼腔,就會自動新建一個 Shell,在這個 Shell 里面執(zhí)行指定的腳本命令踱葛。因此丹莲,只要是 Shell(一般是 Bash)可以運(yùn)行的命令,就可以寫在 npm 腳本里面尸诽。
比較特別的是甥材,npm run新建的這個 Shell,會將當(dāng)前目錄的node_modules/.bin子目錄加入PATH變量性含,執(zhí)行結(jié)束后洲赵,再將PATH變量恢復(fù)原樣。
更多可參考阮老師的 npm scripts 使用指南
-
dependencies && devDependencies
npm install
在安裝node模塊時胶滋,有兩種命令參數(shù)可以把它們的信息寫入package.json文件:–save
以及–save-dev
板鬓。–save
會把依賴包名稱添加到package.json文件dependencies
鍵下,–save-dev
則添加到package.json文件devDependencies
鍵下究恤。dependencies
字段指定了項(xiàng)目生產(chǎn)環(huán)境中需要的依賴俭令,即正常運(yùn)行該包時所依賴的模塊,devDependencies
指定項(xiàng)目開發(fā)所需要的依賴項(xiàng)部宿,像一些進(jìn)行單元測試之類的包抄腔,比如grunt-contrib-uglify瓢湃,我們用它混淆js文件,它們不會被部署到生產(chǎn)環(huán)境赫蛇。它們都指向一個對象绵患。該對象的各個成員,分別由模塊名和對應(yīng)的版本要求組成悟耘,表示依賴的模塊及其版本范圍落蝙。
-
bin
用來指定各個內(nèi)部命令對應(yīng)的可執(zhí)行文件的位置。
例如:
"bin": { "someTool": "./bin/someTool.js" }
上面代碼指定暂幼,someTool 命令對應(yīng)的可執(zhí)行文件為 bin 子目錄下的 someTool.js
-
main
指定包的入口程序文件筏勒。這個字段的默認(rèn)值是模塊根目錄下面的index.js。
-
config
用于向環(huán)境變量輸出值旺嬉。
比如:
{ // ... "config" : { "port" : "8080" }, }
然后通過
process.env.npm_package_config_port
讀取該值管行。
其他字段
-
engines
指定node的工作版本
-
man
指定當(dāng)前模塊的man文檔的位置。
-
preferGlobal
布爾類型值邪媳,表示當(dāng)用戶不將該模塊安裝為全局模塊時(即不用–global參數(shù))捐顷,要不要顯示警告。
...