你需要知道的幾類npm依賴包管理

NPM

在一個(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包中雹熬,將包含fw2hello-else。 但是值得注意的是谣膳,這兩個(gè)包必須先在devDependenciesdependencies聲明過(guò)竿报,否則打包會(huì)報(bào)錯(cuò)。

總結(jié)

以上就是目前npm支持的依賴管理继谚,如有不明白或者錯(cuò)誤之處烈菌,請(qǐng)?jiān)谠u(píng)論區(qū)留言。

歡迎關(guān)注我們專欄:ELSE

更多參考:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末花履,一起剝皮案震驚了整個(gè)濱河市芽世,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌诡壁,老刑警劉巖济瓢,帶你破解...
    沈念sama閱讀 212,454評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異妹卿,居然都是意外死亡旺矾,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,553評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門(mén)夺克,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)箕宙,“玉大人,你說(shuō)我怎么就攤上這事铺纽〖砼粒” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 157,921評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)雕崩。 經(jīng)常有香客問(wèn)我魁索,道長(zhǎng),這世上最難降的妖魔是什么盼铁? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,648評(píng)論 1 284
  • 正文 為了忘掉前任粗蔚,我火速辦了婚禮,結(jié)果婚禮上饶火,老公的妹妹穿的比我還像新娘鹏控。我一直安慰自己,他們只是感情好肤寝,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,770評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布当辐。 她就那樣靜靜地躺著,像睡著了一般鲤看。 火紅的嫁衣襯著肌膚如雪缘揪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,950評(píng)論 1 291
  • 那天义桂,我揣著相機(jī)與錄音找筝,去河邊找鬼。 笑死慷吊,一個(gè)胖子當(dāng)著我的面吹牛袖裕,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播溉瓶,決...
    沈念sama閱讀 39,090評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼急鳄,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了堰酿?” 一聲冷哼從身側(cè)響起疾宏,我...
    開(kāi)封第一講書(shū)人閱讀 37,817評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎胞锰,沒(méi)想到半個(gè)月后灾锯,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體兢榨,經(jīng)...
    沈念sama閱讀 44,275評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡嗅榕,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,592評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了吵聪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片凌那。...
    茶點(diǎn)故事閱讀 38,724評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖吟逝,靈堂內(nèi)的尸體忽然破棺而出帽蝶,到底是詐尸還是另有隱情,我是刑警寧澤块攒,帶...
    沈念sama閱讀 34,409評(píng)論 4 333
  • 正文 年R本政府宣布励稳,位于F島的核電站佃乘,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏驹尼。R本人自食惡果不足惜趣避,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,052評(píng)論 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望新翎。 院中可真熱鬧程帕,春花似錦、人聲如沸地啰。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,815評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)亏吝。三九已至岭埠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蔚鸥,已是汗流浹背枫攀。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,043評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留株茶,地道東北人来涨。 一個(gè)月前我還...
    沈念sama閱讀 46,503評(píng)論 2 361
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像启盛,于是被迫代替她去往敵國(guó)和親蹦掐。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,627評(píng)論 2 350

推薦閱讀更多精彩內(nèi)容