package.json檔案 -- JavaScript 標準參考教程

JSON JavaScript · 發表 2018-12-03 23:42:32

摘要： package.json檔案概述每個專案的根目錄下面，一般都有一個package.json檔案，定義了這個專案所需要的各種模組，以及專案的配置資訊（比如名稱、版本、許可證等元資料）。npm install命令根據這個配置檔案，自動下載所需的模組，也就是配置專案所需的執行...

package.json檔案

概述

每個專案的根目錄下面，一般都有一個package.json檔案，定義了這個專案所需要的各種模組，以及專案的配置資訊（比如名稱、版本、許可證等元資料）。npm install命令根據這個配置檔案，自動下載所需的模組，也就是配置專案所需的執行和開發環境。

下面是一個最簡單的package.json檔案，只定義兩項元資料：專案名稱和專案版本。

{
"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":"[email protected]"},
"contributors":[{"name":"李四","email":"[email protected]"}],
"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時，所要執行的命令。

下面的設定指定了npm run preinstall、npm run postinstall、npm run start、npm run test時，所要執行的命令。

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

dependencies欄位，devDependencies欄位

dependencies欄位指定了專案執行所依賴的模組，devDependencies指定專案開發所需要的模組。

它們都指向一個物件。該物件的各個成員，分別由模組名和對應的版本要求組成，表示依賴的模組及其版本範圍。

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

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

指定版本：比如1.2.2，遵循“大版本.次要版本.小版本”的格式規定，安裝時只安裝指定版本。
波浪號（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，則插入號的行為與波浪號相同，這是因為此時處於開發階段，即使是次要版本號變動，也可能帶來程式的不相容。
latest：安裝最新版本。

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

$ npm init

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

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

$ npm install

如果一個模組不在package.json檔案之中，可以單獨安裝這個模組，並使用相應的引數，將其寫入package.json檔案之中。

$ npm install express --save

$ npm install express --save-dev

上面程式碼表示單獨安裝express模組，--save引數表示將該模組寫入dependencies屬性，--save-dev表示將該模組寫入devDependencies屬性。

peerDependencies

有時，你的專案和所依賴的模組，都會同時依賴另一個模組，但是所依賴的版本不一樣。比如，你的專案依賴A模組和B模組的1.0版，而A模組本身又依賴B模組的2.0版。

大多數情況下，這不構成問題，B模組的兩個版本可以並存，同時執行。但是，有一種情況，會出現問題，就是這種依賴關係將暴露給使用者。

最典型的場景就是外掛，比如A模組是B模組的外掛。使用者安裝的B模組是1.0版本，但是A外掛只能和2.0版本的B模組一起使用。這時，使用者要是將1.0版本的B的例項傳給A，就會出現問題。因此，需要一種機制，在模板安裝的時候提醒使用者，如果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項用來指定各個內部命令對應的可執行檔案的位置。

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

上面程式碼指定，someTool 命令對應的可執行檔案為 bin 子目錄下的 someTool.js。Npm會尋找這個檔案，在node_modules/.bin/目錄下建立符號連結。在上面的例子中，someTool.js會建立符號連結npm_modules/.bin/someTool。由於node_modules/.bin/目錄會在執行時加入系統的PATH變數，因此在執行npm時，就可以不帶路徑，直接通過命令來呼叫這些指令碼。

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

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欄位用於向環境變數輸出值。

下面是一個package.json檔案。

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

然後，在server.js指令碼就可以引用config欄位的值。

http.createServer(...).listen(process.env.npm_package_config_port)

使用者可以改變這個值。

$ npm config set foo:port 80

其他

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引數），要不要顯示警告，表示該模組的本意就是安裝為全域性模組。

style欄位

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

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

package.json檔案 -- JavaScript 標準參考教程