Node.js package.json文件

概述

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

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

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

上面代碼說明，package.json文件內部就是一個json對象，該對象的每一個成員就是當前項目的一項設置。比如name就是項目名稱，version是版本（遵守“大版本.次要版本.小版本”的格式）。

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

{
    "name": "Hello World",
    "version": "0.0.1",
    "author": "張三",
    "description": "第一個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",
    }
}

下面詳細解釋package.json文件的成員。

scripts

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

下面的設置指定了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ā)所需要的模塊。

dependencies和devDependencies這兩項，都指向一個對象。該對象的各個成員，分別由模塊名和對應的版本要求組成。對應的版本可以加上各種限定，主要有以下幾種：

• 指定版本：比如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：安裝最新版本。

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

npm init

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

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

npm install

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

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

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

bin

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

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

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

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

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

// 簡寫為

scripts: {  
  start: 'someTool build'
}

所有node_modules/.bin/目錄下的命令，都可以用npm run [命令]的格式運行。在命令行下，鍵入npm run，然后按tab鍵，就會顯示所有可以使用的命令。

其他

browser

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

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

engines

engines指明了該項目所需要的node.js版本。

man

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

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

preferGlobal

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

style

style指定供瀏覽器使用時，樣式文件所在的位置。樣式文件打包工具parcelify，通過它知道樣式文件的打包位置。

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