在一個(gè)Node.js項(xiàng)目中蔫慧,
package.json
幾乎是一個(gè)必須的文件蟀架,它的主要作用就是管理項(xiàng)目中所使用到的外部依賴包寝蹈,同時(shí)它也是npm
命令的入口文件兑障。
npm
目前支持以下幾類依賴包管理:
dependencies
devDependencies
peerDependencies
optionalDependencies
-
bundledDependencies
/bundleDependencies
如果你想使用哪種依賴管理调俘,那么你可以將它放在package.json
中對(duì)應(yīng)的依賴對(duì)象中,比如:
"devDependencies": {
"fw2": "^0.3.2",
"grunt": "^1.0.1",
"webpack": "^3.6.0"
},
"dependencies": {
"gulp": "^3.9.1",
"hello-else": "^1.0.0"
},
"peerDependencies": { },
"optionalDependencies": { },
"bundledDependencies": []
下面我們一一來(lái)看:
dependencies
應(yīng)用依賴旺垒,或者叫做業(yè)務(wù)依賴彩库,這是我們最常用的依賴包管理對(duì)象!它用于指定應(yīng)用依賴的外部包先蒋,這些依賴是應(yīng)用發(fā)布后正常執(zhí)行時(shí)所需要的骇钦,但不包含測(cè)試時(shí)或者本地打包時(shí)所使用的包【貉可使用下面的命令來(lái)安裝:
npm install packageName --save
dependencies
是一個(gè)簡(jiǎn)單的JSON對(duì)象眯搭,包含包名
與包版本
窥翩,其中包版本
可以是版本號(hào)或者URL地址。比如:
{
"dependencies" :{
"foo" : "1.0.0 - 2.9999.9999", // 指定版本范圍
"bar" : ">=1.0.2 <2.1.2",
"baz" : ">1.0.2 <=2.3.4",
"boo" : "2.0.1", // 指定版本
"qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0",
"asd" : "http://asdf.com/asdf.tar.gz", // 指定包地址
"til" : "~1.2", // 最近可用版本
"elf" : "~1.2.3",
"elf" : "^1.2.3", // 兼容版本
"two" : "2.x", // 2.1鳞仙、2.2寇蚊、...、2.9皆可用
"thr" : "*", // 任意版本
"thr2": "", // 任意版本
"lat" : "latest", // 當(dāng)前最新
"dyl" : "file:../dyl", // 本地地址
"xyz" : "git+ssh://git@github.com:npm/npm.git#v1.0.27", // git 地址
"fir" : "git+ssh://git@github.com:npm/npm#semver:^5.0",
"wdy" : "git+https://isaacs@github.com/npm/npm.git",
"xxy" : "git://github.com/npm/npm.git#v1.0.27",
}
}
devDependencies
開(kāi)發(fā)環(huán)境依賴棍好,僅次于dependencies的使用頻率仗岸!它的對(duì)象定義和dependencies
一樣,只不過(guò)它里面的包只用于開(kāi)發(fā)環(huán)境借笙,不用于生產(chǎn)環(huán)境扒怖,這些包通常是單元測(cè)試或者打包工具等,例如gulp, grunt, webpack, moca, coffee
等业稼,可使用以下命令來(lái)安裝:
npm install packageName --save-dev
舉個(gè)栗子:
{ "name": "ethopia-waza",
"description": "a delightfully fruity coffee varietal",
"version": "1.2.3",
"devDependencies": {
"coffee-script": "~1.6.3"
},
"scripts": {
"prepare": "coffee -o lib/ -c src/waza.coffee"
},
"main": "lib/waza.js"
}
prepare
腳本會(huì)在發(fā)布前運(yùn)行盗痒,因此使用者在編譯項(xiàng)目是不用依賴它。在開(kāi)發(fā)模式下低散,運(yùn)行npm install
, 同時(shí)也會(huì)執(zhí)行prepare
腳本俯邓,開(kāi)發(fā)時(shí)可以很容易的測(cè)試。
至此熔号,你理解了
--save
和--save-dev
的區(qū)別了嗎稽鞭?
peerDependencies
同等依賴,或者叫同伴依賴跨嘉,用于指定當(dāng)前包(也就是你寫(xiě)的包)兼容的宿主版本川慌。如何理解呢吃嘿? 試想一下祠乃,我們編寫(xiě)一個(gè)gulp的插件,而gulp卻有多個(gè)主版本兑燥,我們只想兼容最新的版本亮瓷,此時(shí)就可以用同等依賴(peerDependencies
)來(lái)指定:
{
"name": "gulp-my-plugin",
"version": "0.0.1",
"peerDependencies": {
"gulp": "3.x"
}
}
當(dāng)別人使用我們的插件時(shí),peerDependencies
就會(huì)告訴明確告訴使用方降瞳,你需要安裝該插件哪個(gè)宿主版本嘱支。
通常情況下,我們會(huì)在一個(gè)項(xiàng)目里使用一個(gè)宿主(比如gulp
)的很多插件挣饥,如果相互之間存在宿主不兼容除师,在執(zhí)行npm install
時(shí),cli
會(huì)拋出錯(cuò)誤信息來(lái)告訴我們扔枫,比如:
npm ERR! peerinvalid The package gulp does not satisfy its siblings' peerDependencies requirements!
npm ERR! peerinvalid Peer gulp-cli-config@0.1.3 wants gulp@~3.1.9
npm ERR! peerinvalid Peer gulp-cli-users@0.1.4 wants gulp@~2.3.0
運(yùn)行命令npm install gulp-my-plugin --save-dev
來(lái)安裝我們插件汛聚,我們來(lái)看下依賴圖譜:
├── gulp-my-plugin@0.0.1
└── gulp@3.9.1
OK, Nice!
注意,npm 1 與 npm 2 會(huì)自動(dòng)安裝同等依賴短荐,npm 3 不再自動(dòng)安裝倚舀,會(huì)產(chǎn)生警告叹哭!手動(dòng)在
package.json
文件中添加依賴項(xiàng)可以解決。
optionalDependencies
可選依賴痕貌,如果有一些依賴包即使安裝失敗风罩,項(xiàng)目仍然能夠運(yùn)行或者希望npm
繼續(xù)運(yùn)行,就可以使用optionalDependencies
舵稠。另外optionalDependencies
會(huì)覆蓋dependencies
中的同名依賴包超升,所以不要在兩個(gè)地方都寫(xiě)。
舉個(gè)栗子柱查,可選依賴包就像程序的插件一樣廓俭,如果存在就執(zhí)行存在的邏輯,不存在就執(zhí)行另一個(gè)邏輯唉工。
try {
var foo = require('foo')
var fooVersion = require('foo/package.json').version
} catch (er) {
foo = null
}
if ( notGoodFooVersion(fooVersion) ) {
foo = null
}
// .. then later in your program ..
if (foo) {
foo.doFooThings()
}
bundledDependencies / bundleDependencies
打包依賴研乒,bundledDependencies
是一個(gè)包含依賴包名的數(shù)組對(duì)象,在發(fā)布時(shí)會(huì)將這個(gè)對(duì)象中的包打包到最終的發(fā)布包里淋硝。如:
{
"name": "fe-weekly",
"description": "ELSE 周刊",
"version": "1.0.0",
"main": "index.js",
"devDependencies": {
"fw2": "^0.3.2",
"grunt": "^1.0.1",
"webpack": "^3.6.0"
},
"dependencies": {
"gulp": "^3.9.1",
"hello-else": "^1.0.0"
},
"bundledDependencies": [
"fw2",
"hello-else"
]
}
執(zhí)行打包命令npm pack
, 在生成的fe-weekly-1.0.0.tgz
包中雹熬,將包含fw2
和hello-else
。 但是值得注意的是谣膳,這兩個(gè)包必須先在devDependencies
或dependencies
聲明過(guò)竿报,否則打包會(huì)報(bào)錯(cuò)。
總結(jié)
以上就是目前npm支持的依賴管理继谚,如有不明白或者錯(cuò)誤之處烈菌,請(qǐng)?jiān)谠u(píng)論區(qū)留言。
歡迎關(guān)注我們專欄:ELSE