{
"name": "Hello World",
"version": "0.0.1",
"author": "張三",
"description": "程序",
"keywords":["node.js","javascript"],
"main": "index.js",
"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定義了這個(gè)項(xiàng)目所需要的各種模塊,以及項(xiàng)目的配置信息(比如名稱、版本、許可證等元數(shù)據(jù))
package.json文件就是一個(gè)JSON對象,該對象的每一個(gè)成員就是當(dāng)前項(xiàng)目的一項(xiàng)設(shè)置拌消。比如name就是項(xiàng)目名稱,version是版本(遵守“大版本.次要版本.小版本”的格式)安券。
scripts字段
scripts指定了運(yùn)行腳本命令的npm命令行縮寫墩崩,比如start指定了運(yùn)行npm run start時(shí),所要執(zhí)行的命令完疫。
dependencies字段泰鸡,devDependencies字段
dependencies字段指定了項(xiàng)目運(yùn)行所依賴的模塊,devDependencies指定項(xiàng)目開發(fā)所需要的模塊壳鹤。
它們都指向一個(gè)對象盛龄。該對象的各個(gè)成員,分別由模塊名和對應(yīng)的版本要求組成芳誓,表示依賴的模塊及其版本范圍余舶。
依賴范圍
上面的 package.json 文件表明,項(xiàng)目中使用的 mongoose 的版本號是 3.8.3锹淌,但是 3.9.1 和 3.8.4匿值、2.8.1之間有什么不同呢。語義化版本規(guī)則規(guī)定赂摆,版本格式為:主版本號.次版本號.修訂號挟憔,并且版本號的遞增規(guī)則如下:
- 主版本號:當(dāng)你做了不兼容的 API 修改
- 次版本號:當(dāng)你做了向下兼容的功能性新增
- 修訂號:當(dāng)你做了向下兼容的問題修正
主版本號的更新通常意味著大的修改和更新,升級主版本后可能會(huì)使你的程序報(bào)錯(cuò)烟号,因此升級主版本號需謹(jǐn)慎绊谭,但是這往往也會(huì)帶來更好的性能和體驗(yàn)。次版本號的更新則通常意味著新增了某些特性汪拥,比如 mongoose 的版本從 3.8.3升級到 3.9.3达传,之前的 不支持的功能升級后支持了。修訂號的更新則往往意味著進(jìn)行了一些 bug 修復(fù)迫筑。因此次版本號和修訂號應(yīng)該保持更新宪赶,這樣能讓你之前的代碼不會(huì)報(bào)錯(cuò)還能獲取到最新的功能特性。
但是脯燃,往往我們不會(huì)指定依賴的具體版本搂妻,而是指定版本范圍,分別使用了三個(gè)符號來表明依賴的版本范圍辕棚。語義化版本范圍規(guī)定:
~:只升級修訂號
^:升級次版本號和修訂號
*:升級到最新版本
語義化版本規(guī)則定義了一種理想的版本號更新規(guī)則欲主,希望所有的依賴更新都能遵循這個(gè)規(guī)則追他,但是往往會(huì)有許多依賴不是嚴(yán)格遵循這些規(guī)定的。因此岛蚤,如何管理好這些依賴,尤其是這些依賴的版本就顯得尤為重要懈糯,否則一不小心就會(huì)陷入因依賴版本不一致導(dǎo)致的各種問題中涤妒。
peerDependencies
有時(shí),你的項(xiàng)目和所依賴的模塊赚哗,都會(huì)同時(shí)依賴另一個(gè)模塊她紫,但是所依賴的版本不一樣。比如屿储,你的項(xiàng)目依賴A模塊和B模塊的1.0版贿讹,而A模塊本身又依賴B模塊的2.0版。
大多數(shù)情況下够掠,這不構(gòu)成問題民褂,B模塊的兩個(gè)版本可以并存,同時(shí)運(yùn)行疯潭。但是赊堪,有一種情況,會(huì)出現(xiàn)問題竖哩,就是這種依賴關(guān)系將暴露給用戶哭廉。
最典型的場景就是插件,比如A模塊是B模塊的插件相叁。用戶安裝的B模塊是1.0版本遵绰,但是A插件只能和2.0版本的B模塊一起使用。這時(shí)增淹,用戶要是將1.0版本的B的實(shí)例傳給A椿访,就會(huì)出現(xiàn)問題。因此埠通,需要一種機(jī)制赎离,在模板安裝的時(shí)候提醒用戶,如果A和B一起安裝端辱,那么B必須是2.0模塊梁剔。
peerDependencies字段,就是用來供插件指定其所需要的主工具的版本舞蔽。
{
"name": "chai-as-promised",
"peerDependencies": {
"chai": "1.x"
}
}
上面代碼指定荣病,安裝chai-as-promised模塊時(shí),主程序chai必須一起安裝渗柿,而且chai的版本必須是1.x个盆。如果你的項(xiàng)目指定的依賴是chai的2.0版本脖岛,就會(huì)報(bào)錯(cuò)。
注意颊亮,從npm 3.0版開始杆煞,peerDependencies不再會(huì)默認(rèn)安裝了。
bin字段
bin項(xiàng)用來指定各個(gè)內(nèi)部命令對應(yīng)的可執(zhí)行文件的位置脚祟。
"bin": {
"someTool": "./bin/someTool.js"
}
上面代碼指定感帅,someTool 命令對應(yīng)的可執(zhí)行文件為 bin 子目錄下的 someTool.js。Npm會(huì)尋找這個(gè)文件雹有,在node_modules/.bin/目錄下建立符號鏈接偿渡。在上面的例子中,someTool.js會(huì)建立符號鏈接npm_modules/.bin/someTool霸奕。由于node_modules/.bin/目錄會(huì)在運(yùn)行時(shí)加入系統(tǒng)的PATH變量溜宽,因此在運(yùn)行npm時(shí),就可以不帶路徑质帅,直接通過命令來調(diào)用這些腳本适揉。
scripts: {
start: './node_modules/someTool/someTool.js build'
}
// 簡寫為
scripts: {
start: 'someTool build'
}
main字段
main字段指定了加載的入口文件,require('moduleName')就會(huì)加載這個(gè)文件煤惩。這個(gè)字段的默認(rèn)值是模塊根目錄下面的index.js涡扼。
config 字段
config字段用于添加命令行的環(huán)境變量。
browser字段
browser指定該模板供瀏覽器使用的版本盟庞。Browserify這樣的瀏覽器打包工具吃沪,通過它就知道該打包那個(gè)文件。
engines 字段
engines字段指明了該模塊運(yùn)行的平臺什猖,比如 Node 的某個(gè)版本或者瀏覽器票彪。
man字段
man用來指定當(dāng)前模塊的man文檔的位置。
preferGlobal字段
preferGlobal的值是布爾值不狮,表示當(dāng)用戶不將該模塊安裝為全局模塊時(shí)(即不用–global參數(shù))降铸,要不要顯示警告,表示該模塊的本意就是安裝為全局模塊摇零。
style字段
style指定供瀏覽器使用時(shí)推掸,樣式文件所在的位置。樣式文件打包工具parcelify驻仅,通過它知道樣式文件的打包位置谅畅。