1.概述
每個(gè)項(xiàng)目的根目錄下面坷澡，一般都有一個(gè)package.json文件，定義了這個(gè)項(xiàng)目所需要的各種模塊含蓉，以及項(xiàng)目的配置信息（比如名稱频敛、版本、許可證等元數(shù)據(jù)）馅扣。npm install命令根據(jù)這個(gè)配置文件斟赚，自動(dòng)下載所需的模塊，也就是配置項(xiàng)目所需的運(yùn)行和開(kāi)發(fā)環(huán)境岂嗓。
下面是一個(gè)最簡(jiǎn)單的package.json文件，只定義兩項(xiàng)元數(shù)據(jù)：項(xiàng)目名稱和項(xiàng)目版本鹊碍。
{
"name" : "xxx",
"version" : "0.0.0",
}
package.json文件就是一個(gè)JSON對(duì)象厌殉，該對(duì)象的每一個(gè)成員就是當(dāng)前項(xiàng)目的一項(xiàng)設(shè)置。比如name就是項(xiàng)目名稱侈咕，version是版本（遵守“大版本.次要版本.小版本”的格式）公罕。
下面是一個(gè)更完整的package.json文件。
{
"name": "Hello World",
"version": "0.0.1",
"author": "張三",
"description": "第一個(gè)node.js程序",
"keywords":["node.js","javascript"],
"repository": {
"type": "git",
"url": "https://path/to/url"
},
"license":"MIT",
"engines": {"node": "0.10.x"},
"bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
"contributors":[{"name":"李四","email":"lisi@example.com"}],
"scripts": {
"start": "node index.js"
},
"dependencies": {
"express": "latest",
"mongoose": "~3.8.3",
"handlebars-runtime": "~1.0.12",
"express3-handlebars": "~0.5.0",
"MD5": "~1.2.0"
},
"devDependencies": {
"bower": "~1.2.8",
"grunt": "~0.4.1",
"grunt-contrib-concat": "~0.3.0",
"grunt-contrib-jshint": "~0.7.2",
"grunt-contrib-uglify": "~0.2.7",
"grunt-contrib-clean": "~0.5.0",
"browserify": "2.36.1",
"grunt-browserify": "~1.3.0",
}
}
下面詳細(xì)解釋package.json文件的各個(gè)字段耀销。
2.scripts字段
scripts指定了運(yùn)行腳本命令的npm命令行縮寫(xiě)楼眷，比如start指定了運(yùn)行npm run start時(shí)，所要執(zhí)行的命令。
下面的設(shè)置指定了npm run preinstall罐柳、npm run postinstall掌腰、npm run start、npm run test時(shí)张吉，所要執(zhí)行的命令齿梁。
"scripts": {
"preinstall": "echo here it comes!",
"postinstall": "echo there it goes!",
"start": "node index.js",
"test": "tap test/*.js"
}
3.dependencies字段，devDependencies字段
dependencies字段指定了項(xiàng)目運(yùn)行所依賴的模塊肮蛹，devDependencies指定項(xiàng)目開(kāi)發(fā)所需要的模塊勺择。
它們都指向一個(gè)對(duì)象。該對(duì)象的各個(gè)成員伦忠，分別由模塊名和對(duì)應(yīng)的版本要求組成省核，表示依賴的模塊及其版本范圍。
{
"devDependencies": {
"browserify": "~13.0.0",
"karma-browserify": "~5.0.1"
}
}
對(duì)應(yīng)的版本可以加上各種限定昆码，主要有以下幾種：
@ 指定版本：比如1.2.2气忠，遵循“大版本.次要版本.小版本”的格式規(guī)定，安裝時(shí)只安裝指定版本未桥。
~ 波浪號(hào)（tilde）+指定版本：比如~1.2.2笔刹，表示安裝1.2.x的最新版本（不低于1.2.2），但是不安裝1.3.x冬耿，也就是說(shuō)安裝時(shí)不改變大版本號(hào)和次要版本號(hào)舌菜。
? 插入號(hào)（caret）+指定版本：比如?1.2.2，表示安裝1.x.x的最新版本（不低于1.2.2）亦镶，但是不安裝2.x.x日月，也就是說(shuō)安裝時(shí)不改變大版本號(hào)。需要注意的是缤骨，如果大版本號(hào)為0爱咬，則插入號(hào)的行為與波浪號(hào)相同，這是因?yàn)榇藭r(shí)處于開(kāi)發(fā)階段绊起，即使是次要版本號(hào)變動(dòng)精拟，也可能帶來(lái)程序的不兼容。
latest：安裝最新版本虱歪。
package.json文件可以手工編寫(xiě)蜂绎，也可以使用npm init命令自動(dòng)生成。
$ npm init
這個(gè)命令采用互動(dòng)方式笋鄙，要求用戶回答一些問(wèn)題师枣，然后在當(dāng)前目錄生成一個(gè)基本的package.json文件。所有問(wèn)題之中萧落，只有項(xiàng)目名稱（name）和項(xiàng)目版本（version）是必填的践美，其他都是選填的洗贰。
有了package.json文件，直接使用npm install命令陨倡，就會(huì)在當(dāng)前目錄中安裝所需要的模塊敛滋。
$ npm install
如果一個(gè)模塊不在package.json文件之中，可以單獨(dú)安裝這個(gè)模塊玫膀，并使用相應(yīng)的參數(shù)矛缨，將其寫(xiě)入package.json文件之中。
$ npm install express --save
$ npm install express --save-dev
上面代碼表示單獨(dú)安裝express模塊帖旨，--save參數(shù)表示將該模塊寫(xiě)入dependencies屬性箕昭，--save-dev表示將該模塊寫(xiě)入devDependencies屬性。
4.peerDependencies
有時(shí)解阅，你的項(xiàng)目和所依賴的模塊落竹，都會(huì)同時(shí)依賴另一個(gè)模塊，但是所依賴的版本不一樣货抄。比如述召，你的項(xiàng)目依賴A模塊和B模塊的1.0版，而A模塊本身又依賴B模塊的2.0版蟹地。
大多數(shù)情況下积暖，這不構(gòu)成問(wèn)題，B模塊的兩個(gè)版本可以并存怪与，同時(shí)運(yùn)行夺刑。但是，有一種情況分别，會(huì)出現(xiàn)問(wèn)題遍愿，就是這種依賴關(guān)系將暴露給用戶。
最典型的場(chǎng)景就是插件耘斩，比如A模塊是B模塊的插件沼填。用戶安裝的B模塊是1.0版本，但是A插件只能和2.0版本的B模塊一起使用括授。這時(shí)坞笙，用戶要是將1.0版本的B的實(shí)例傳給A，就會(huì)出現(xiàn)問(wèn)題荚虚。因此薛夜，需要一種機(jī)制，在模板安裝的時(shí)候提醒用戶曲管，如果A和B一起安裝却邓，那么B必須是2.0模塊硕糊。
peerDependencies字段院水，就是用來(lái)供插件指定其所需要的主工具的版本腊徙。
{
"name": "chai-as-promised",
"peerDependencies": {
"chai": "1.x"
}
}
上面代碼指定，安裝chai-as-promised模塊時(shí)檬某，主程序chai必須一起安裝撬腾，而且chai的版本必須是1.x。如果你的項(xiàng)目指定的依賴是chai的2.0版本恢恼，就會(huì)報(bào)錯(cuò)民傻。
注意，從npm 3.0版開(kāi)始场斑，peerDependencies不再會(huì)默認(rèn)安裝了漓踢。
5.bin字段
bin項(xiàng)用來(lái)指定各個(gè)內(nèi)部命令對(duì)應(yīng)的可執(zhí)行文件的位置。
"bin": {
"someTool": "./bin/someTool.js"
}
上面代碼指定漏隐，someTool命令對(duì)應(yīng)的可執(zhí)行文件為 bin 子目錄下的 someTool.js喧半。Npm會(huì)尋找這個(gè)文件，在node_modules/.bin/目錄下建立符號(hào)鏈接青责。在上面的例子中挺据，someTool.js會(huì)建立符號(hào)鏈接npm_modules/.bin/someTool。由于node_modules/.bin/目錄會(huì)在運(yùn)行時(shí)加入系統(tǒng)的PATH變量脖隶，因此在運(yùn)行npm時(shí)扁耐，就可以不帶路徑，直接通過(guò)命令來(lái)調(diào)用這些腳本产阱。
因此婉称，像下面這樣的寫(xiě)法可以采用簡(jiǎn)寫(xiě)。
scripts: {
start: './node_modules/someTool/someTool.js build'
}
// 簡(jiǎn)寫(xiě)為
scripts: {
start: 'someTool build'
}
所有node_modules/.bin/目錄下的命令心墅，都可以用npm run [命令]的格式運(yùn)行酿矢。在命令行下，鍵入npm run怎燥，然后按tab鍵瘫筐，就會(huì)顯示所有可以使用的命令。
6.main字段
main字段指定了加載的入口文件铐姚，require('moduleName')就會(huì)加載這個(gè)文件策肝。這個(gè)字段的默認(rèn)值是模塊根目錄下面的index.js。
7.config 字段
config字段用于添加命令行的環(huán)境變量隐绵。
下面是一個(gè)package.json文件之众。
{
"name" : "foo",
"config" : { "port" : "8080" },
"scripts" : { "start" : "node server.js" }
}
然后，在server.js腳本就可以引用config字段的值依许。
http
.createServer(...)
.listen(process.env.npm_package_config_port)
用戶執(zhí)行npm run start命令時(shí)棺禾，這個(gè)腳本就可以得到值。
$ npm run start
用戶可以改變這個(gè)值峭跳。
$ npm config set foo:port 80
8. 其他
8.1 browser字段
browser指定該模板供瀏覽器使用的版本膘婶。Browserify這樣的瀏覽器打包工具缺前，通過(guò)它就知道該打包那個(gè)文件。
"browser": {
"tipso": "./node_modules/tipso/src/tipso.js"
},
8.2 engines 字段
engines字段指明了該模塊運(yùn)行的平臺(tái)悬襟，比如 Node 的某個(gè)版本或者瀏覽器衅码。
{ "engines" : { "node" : ">=0.10.3 <0.12" } }
該字段也可以指定適用的npm版本。
{ "engines" : { "npm" : "~1.0.20" } }
8.3 man字段
man用來(lái)指定當(dāng)前模塊的man文檔的位置脊岳。
"man" :[ "./doc/calc.1" ]
8.4 preferGlobal字段
preferGlobal的值是布爾值逝段，表示當(dāng)用戶不將該模塊安裝為全局模塊時(shí)（即不用–global參數(shù)），要不要顯示警告割捅，表示該模塊的本意就是安裝為全局模塊奶躯。
8.5 style字段
style指定供瀏覽器使用時(shí)，樣式文件所在的位置亿驾。樣式文件打包工具parcelify巫糙，通過(guò)它知道樣式文件的打包位置。
"style": [
"./node_modules/tipso/src/tipso.css"
]
