package.json與package-lock.json
簡介:
-
package.json 檔案一般都在每個專案的根目錄下面,定義了這個專案所需要的各種模組,以及專案的配置資訊(比如名稱、版本、許可證、依賴模組等元資料
)。npm install
命令根據這個配置檔案,
自動下載所需的模組,也就是配置專案所需的執行和開發環境。該檔案會描述這個NPM包的所有相關資訊,包括作者、簡介、包依賴、構建等資訊,格式是嚴格的JSON格式。
-
package-lock.json 是在 `npm install` 時候生成一份檔案,用以記錄當前狀態下實際安裝的各個 npm package 的具體來源和版本號。
package-lock.json作用:
因為npm是一個用於管理package之間依賴關係的管理器,它允許開發者在pacakge.json中間標出自己專案對npm各庫包的依賴,所以就可以實現鎖定安裝時的包的版本號,並且需要上傳到git,以保證其他人在npm install時大家的依賴能保證一致。
你可以選擇以如下方式來標明自己所需要庫包的版本,例如:
"dependencies": { "@types/node": "^8.0.33", },
這裡面的 向上標號^是定義了向後(新)相容依賴,指如果 types/node的版本是超過8.0.33,並在大版本號(8)上相同,就允許下載最新版本的 types/node庫包,例如實際上可能執行npm install時候下載的具體版本是8.0.35。
大多數情況這種向新相容依賴下載最新庫包的時候都沒有問題,可是因為npm是開源世界,各庫包的版本語義可能並不相同,有的庫包開發者並不遵守嚴格這一原則:不同時間或者不同npm下載源之下,下到的各依賴庫包版本可能有所不同,因此其依賴庫包行為特徵也不同有時候甚至完全不相容。-...- npm最新的版本就開始提供自動生成package-lock.json功能,為的是讓開發者知道只要你儲存了原始檔,到一個新的機器上、或者新的下載源,只要按照這個package-lock.json所標示的具體版本下載依賴庫包,就能確保所有庫包與你上次安裝的完全一樣。
那如果我們安裝時的包有bug,後面需要更新怎麼辦?
在以前可能就是直接改package.json裡面的版本,然後再npm install了,但是5版本後就不支援這樣做了,因為版本已經鎖定在package-lock.json裡了,所以我們只能npm install [email protected] 這樣去更新我們的依賴,然後package-lock.json也能隨之更新。
假設我們已經安裝了jquery 2.1.4這個版本,從git更新了package.json和package-lock.json,我們使用npm install能覆蓋掉node_modules裡面的依賴嗎?
其實我也有這個疑問,所以做了測試,在直接更新package.json和package-loc.json這兩個檔案後,npm install是可以直接覆蓋掉原先的版本的,所以在協作開發時,這兩個檔案如果有更新,你的開發環境應該npm install一下才對。
package.json用法?
常用命令:
- npm i --save packageName 安裝依賴包
- npm i --save-dev packageName
- npm i [email protected] 安裝指定版本的包,版本號用@符號連線
- npm install 模組名 -s/--save 把模組寫進依賴檔案
- npm install 模組名 -g/--global 安裝的是工具,全域性安裝
- 解除安裝:npm uninstall --global|-g 模組包名稱
- npm init (-y) 初始化一個node專案(一步到位)
name(包名) 和 version(包的版本號。如"1.0.0")是package.json中最重要的兩個欄位,也是釋出到NPM平臺上的唯一標識,
如果沒有正確設定這兩個欄位,包就不能釋出和被下載。 是兩項元資料:專案名稱和專案版本 description(包的描述資訊),將會在npm search
的返回結果中顯示,以幫助使用者選擇合適的包。
下面是一個更完整的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:安裝最新版本。
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會建立符號連結node_modules/.bin/someTool
。由於node_modules/.bin/
目錄會在執行時加入系統的PATH變數,因此在執行npm時,就可以不帶路徑,直接通過命令來呼叫這些指令碼。因此,像下面這樣的寫法可以採用簡寫。
scripts: {
start: './node_modules/bin/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 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引數),要不要顯示警告,表示該模組的本意就是安裝為全域性模組。style欄位
style指定供瀏覽器使用時,樣式檔案所在的位置。樣式檔案打包工具parcelify,通過它知道樣式檔案的打包位置。"style": [
"./node_modules/tipso/src/tipso.css"
]