一徒河、概述

每個項目的根目錄下面，一般都有一個package.json文件痴突，定義了這個項目所需要的各種模塊搂蜓，以及項目的配置信息（比如名稱、版本辽装、許可證等元數(shù)據(jù)）帮碰。npm install命令根據(jù)這個配置文件，自動下載所需的模塊如迟，也就是配置項目所需的運行和開發(fā)環(huán)境。

下面是一個最簡單的package.json文件攻走，只定義兩項元數(shù)據(jù)：項目名稱和項目版本殷勘。

{
  "name" : "xxx",
  "version" : "0.0.0",
}

package.json文件就是一個JSON對象，該對象的每一個成員就是當前項目的一項設(shè)置昔搂。比如name就是項目名稱玲销，version是版本（遵守“大版本.次要版本.小版本”的格式）

下面是一個更完整的package.json文件。

{
    "name": "Hello World",
    "version": "0.0.1",
    "author": "JC",
    "description": "nodejs demo程序",
    "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",
    }
}

二摘符、scripts字段

scripts指定了運行腳本命令的npm命令行縮寫贤斜，比如start指定了運行npm run start時，所要執(zhí)行的命令逛裤。

下面的設(shè)置指定了npm run preinstall瘩绒、npm run postinstall、npm run start带族、npm run test時锁荔，所要執(zhí)行的命令。

"scripts": {
    "preinstall": "echo here it comes!",
    "postinstall": "echo there it goes!",
    "start": "node index.js",
    "test": "tap test/*.js"
}

三蝙砌、dependencies字段阳堕，devDependencies字段

dependencies字段指定了項目運行所依賴的模塊，devDependencies指定項目開發(fā)所需要的模塊择克。

它們都指向一個對象恬总。該對象的各個成員，分別由模塊名和對應(yīng)的版本要求組成肚邢，表示依賴的模塊及其版本范圍壹堰。

{
  "devDependencies": {
    "browserify": "~13.0.0",
    "karma-browserify": "~5.0.1"
  }
}

對應(yīng)的版本可以加上各種限定，主要有以下幾種：

• 指定版本：比如1.2.2，遵循“大版本.次要版本.小版本”的格式規(guī)定缀旁，安裝時只安裝指定版本记劈。
• 波浪號（tilde）+指定版本：比如~1.2.2，表示安裝1.2.x的最新版本（不低于1.2.2）并巍，但是不安裝1.3.x目木，也就是說安裝時不改變大版本號和次要版本號。
• 插入號（caret）+指定版本：比如?1.2.2懊渡，表示安裝1.x.x的最新版本（不低于1.2.2）刽射，但是不安裝2.x.x，也就是說安裝時不改變大版本號剃执。需要注意的是誓禁，如果大版本號為0，則插入號的行為與波浪號相同肾档，這是因為此時處于開發(fā)階段摹恰，即使是次要版本號變動，也可能帶來程序的不兼容怒见。
• latest：安裝最新版本俗慈。

四、peerDependencies

有時遣耍，你的項目和所依賴的模塊闺阱，都會同時依賴另一個模塊，但是所依賴的版本不一樣舵变。比如酣溃，你的項目依賴A模塊和B模塊的1.0版，而A模塊本身又依賴B模塊的2.0版纪隙。

大多數(shù)情況下赊豌，這不構(gòu)成問題，B模塊的兩個版本可以并存绵咱，同時運行亿絮。但是，有一種情況麸拄，會出現(xiàn)問題派昧，就是這種依賴關(guān)系將暴露給用戶。

最典型的場景就是插件拢切，比如A模塊是B模塊的插件蒂萎。用戶安裝的B模塊是1.0版本，但是A插件只能和2.0版本的B模塊一起使用淮椰。這時五慈，用戶要是將1.0版本的B的實例傳給A纳寂，就會出現(xiàn)問題。因此泻拦，需要一種機制毙芜，在模板安裝的時候提醒用戶，如果A和B一起安裝争拐，那么B必須是2.0模塊腋粥。

peerDependencies字段，就是用來供插件指定其所需要的主工具的版本架曹。

{
  "name": "chai-as-promised",
  "peerDependencies": {
    "chai": "1.x"
  }
}

上面代碼指定隘冲，安裝chai-as-promised模塊時，主程序chai必須一起安裝绑雄，而且chai的版本必須是1.x展辞。如果你的項目指定的依賴是chai的2.0版本，就會報錯万牺。

注意罗珍，從npm 3.0版開始，peerDependencies不再會默認安裝了脚粟。

五覆旱、bin字段

bin項用來指定各個內(nèi)部命令對應(yīng)的可執(zhí)行文件的位置。

"bin": {
  "someTool": "./bin/someTool.js"
}

上面代碼指定珊楼，someTool 命令對應(yīng)的可執(zhí)行文件為 bin 子目錄下的 someTool.js通殃。Npm會尋找這個文件度液，在node_modules/.bin/目錄下建立符號鏈接厕宗。在上面的例子中，someTool.js會建立符號鏈接npm_modules/.bin/someTool堕担。由于node_modules/.bin/目錄會在運行時加入系統(tǒng)的PATH變量已慢，因此在運行npm時，就可以不帶路徑霹购，直接通過命令來調(diào)用這些腳本佑惠。

因此，像下面這樣的寫法可以采用簡寫齐疙。

scripts: {  
  start: './node_modules/someTool/someTool.js build'
}

// 簡寫為
scripts: {  
  start: 'someTool build'
}

所有node_modules/.bin/目錄下的命令膜楷，都可以用npm run [命令]的格式運行。在命令行下贞奋，鍵入npm run赌厅，然后按tab鍵轿塔，就會顯示所有可以使用的命令特愿。

六仲墨、main字段

main字段指定了加載的入口文件，require('moduleName')就會加載這個文件揍障。這個字段的默認值是模塊根目錄下面的index.js目养。

七、config 字段

config字段用于添加命令行的環(huán)境變量毒嫡。
下面是一個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命令時匈勋，這個腳本就可以得到值。

$ npm run start

用戶可以改變這個值膳叨。

$ npm config set foo:port 80

八洽洁、其他

• browser字段
  browser指定該模板供瀏覽器使用的版本。Browserify這樣的瀏覽器打包工具菲嘴，通過它就知道該打包那個文件饿自。

"browser": {
  "tipso": "./node_modules/tipso/src/tipso.js"
},

• engines字段
  engines字段指明了該模塊運行的平臺，比如 Node 的某個版本或者瀏覽器龄坪。

{ "engines" : { "node" : ">=0.10.3 <0.12" } }

該字段也可以指定適用的npm版本昭雌。

{ "engines" : { "npm" : "~1.0.20" } }

• man字段
  man用來指定當前模塊的man文檔的位置。

"man" :[ "./doc/calc.1" ]

• preferGlobal字段
  preferGlobal的值是布爾值健田，表示當用戶不將該模塊安裝為全局模塊時（即不用–global參數(shù)）烛卧，要不要顯示警告，表示該模塊的本意就是安裝為全局模塊

• style字段
  style指定供瀏覽器使用時妓局，樣式文件所在的位置总放。樣式文件打包工具parcelify，通過它知道樣式文件的打包位置好爬。

"style": [
  "./node_modules/tipso/src/tipso.css"
]

九局雄、package.json生成

package.json文件可以手工編寫，也可以使用npm init命令自動生成存炮。

$ npm init

這個命令采用互動方式炬搭，要求用戶回答一些問題，然后在當前目錄生成一個基本的package.json文件穆桂。所有問題之中宫盔，只有項目名稱（name）和項目版本（version）是必填的，其他都是選填的享完。

有了package.json文件灼芭，直接使用npm install命令，就會在當前目錄中安裝所需要的模塊驼侠。

$ npm install

如果一個模塊不在package.json文件之中姿鸿，可以單獨安裝這個模塊谆吴，并使用相應(yīng)的參數(shù)，將其寫入package.json文件之中苛预。

$ npm install express --save
$ npm install express --save-dev

上面代碼表示單獨安裝express模塊句狼，--save參數(shù)表示將該模塊寫入dependencies屬性，--save-dev表示將該模塊寫入devDependencies屬性热某。

原文參考：
package.json文件