貼士:package.json 字段解析

name

必須字段野舶。提示:

  • 不要在name中包含 jsnode 字樣宰衙;
  • 這個名字最終會是 URL 的一部分平道,命令行的參數,目錄名供炼,所以不能以點號或下劃線開頭一屋;
  • 這個名字可能在 require 方法中被調用,所以應該盡可能短袋哼;
  • 如果要發(fā)布為一個 NPM 包冀墨,則該名字必須為唯一;

version

必須字段涛贯,版本號诽嘉,字符串格式,如:

"version": "1.0.0"

description

可選字段弟翘,字符串格式虫腋,如:

"description": "簡單描述當前應用或 package"

keywords

可選字段,數組格式稀余,如:

"keywords": [“關鍵字”,“keyword”]

homepage

可選字段悦冀,項目主頁 URL,如:

"homepage": "https://github.com/github/github"

bugs

可選字段睛琳,問題追蹤系統的URL或郵箱地址盒蟆;npm bugs用的上。

{
  "url" :"http://github.com/owner/project/issues",
  "email" :"project@hostname.com"
}

license

可選字段师骗。如果是使用一個普遍的license历等,比如 BSD-3-ClauseMIT,直接使用:

{ "license" : "BSD-3-Clause" }

author, contributors

都是可選字段辟癌。author 作者募闲,contributors 貢獻者。
author的格式如下:

{ 
  "name" : "Barney Rubble",
  "email" : "b@rubble.com",
  "url" : "http://barnyrubble.tumblr.com/"
}

這種格式也可以:

"Barney Rubble <b@rubble.com> (http://barnyrubble.tumblr.com/)"

貢獻者:

"contributors": [
    "?ndrew Rininsland <aendrew.rininsland@thetimes.co.uk> (http://www.aendrew.com)",
    "Aurelio De Rosa <a.derosa@audero.it> (http://www.audero.it/)",
    "Clay Reimann <clayreimann@gmail.com> (http://clayreimann.me)",
    "Michael Aufreiter (http://substance.io)",
    "Mathieu Dutour <mathieu@dutour.me> (https://github.com/mathieudutour)"
  ],

files

可選字段愿待,項目包含的一組文件浩螺。如果是文件夾,文件夾下的文件也會被包含仍侥。如果需要把某些文件不包含在項目中要出,添加一個 .npmignore 文件。這個文件和.gitignore類似农渊,如:

"files": [
  "dist/*"
],

main

可選字段患蹂,建議必填或颊。這個字段的值是你程序主入口模塊的ID

  • 如果其他用戶需要你的包传于,當用戶調用 require() 方法時囱挑,返回的就是這個模塊的導出(exports);
  • 如果發(fā)布為一個 NPM Package,則 require 為該屬性指定的文件沼溜;
  • 如果未指定該屬性平挑,則默認為根目錄下的 index.js 或 index.node;
    示例:
"main": "dist/components/GitHub.js",
"main": "index.js",
"main": "app.js",

scripts

可選系草,對象格式通熄,如:

 "scripts":{
  "start": "node app.js",
  "server": "node server/server.js",
  "preinstall":"node-gyp rebuild"
}

可在終端使用 npm run start 來執(zhí)行指定的腳本。如果包里有 binding.gyp找都,npm 默認在 preinstall 命令時唇辨,使用 node-gyp 做編譯。

bin

可選字段能耻。很多的包都會有執(zhí)行文件需要安裝到 PATH 中去赏枚。
這個字段對應的是一個Map,每個元素對應一個{ 命令名:文件名 }晓猛。

{
  "bin" : {
    "npm": "./cli.js"
  }
}

directories

用于指示包的目錄結構:

directories.lib

指示庫文件的位置饿幅。

directories.bin

和前面的bin是一樣的,但如果前面已經有bin鞍帝,那么這個就無效诫睬。
除了以上兩個煞茫,還有Directories.doc帕涌、Directories.manDirectories.example续徽。

repository

可選字段蚓曼。用于指示代碼存放的位置。

"repository": {
  "type": "git",
  "url": "http://github.com/npm/npm.git"
}

或使用SVN:

"repository": {
  "type": "svn",
  "url": "http://v8.googlecode.com/svn/trunk/"
}

config

可選字段钦扭,object纫版。config 對象中的值在 Scripts 的整個周期中皆可用,專門用于給 Scripts 提供配置參數客情。

dependencies

可選字段其弊,指示當前包所依賴的其他包。

{
  "dependencies": {
    "foo": "1.0.0 - 2.9999.9999",
    "bar": ">=1.0.2 <2.1.2"
  }
}

版本格式可以是下面任一種:

  • version 完全匹配
  • >version 大于這個版本
  • >=version 大于或等于這個版本
  • <version 小于這個版本
  • <=version 小于或等于這個版本
  • ~version 非常接近這個版本
  • ^version 與當前版本兼容
  • 1.2.x X代表任意數字膀斋,因此 1.2.1, 1.2.3 等都可以梭伐。
  • http://... Unix 系統下使用的 tarball 的 URL。
  • * 任何版本都可以
  • "" 任何版本都可以
  • version1 - version2 等價于 >=version1 <=version2
  • range1 || range2 滿足任意一個即可
  • git... Git地址
  • user/repo

devDependencies

可選字段仰担,開發(fā)環(huán)境下的依賴包糊识,格式同 dependencies 屬性。

peerDependencies

可選字段。兼容性依賴赂苗。如果你的包是插件愉耙,適合這種方式。

bundledDependencies

可選字段拌滋。發(fā)布包時同時打包的其他依賴朴沿。

optionalDependencies

可選字段。如果你想在某些依賴即使沒有找到鸠真,或則安裝失敗的情況下悯仙,npm 都繼續(xù)執(zhí)行。那么這些依賴適合放在這里吠卷。

engines

可選字段锡垄。既可以指定 node 版本:

{ "engines" : {"node" : ">=0.10.3 <0.12" } }

也可以指定npm版本:

{ "engines" : {"npm" : "~1.0.20" } }

engineStrick

可選字段,布爾值祭隔。如果你肯定你的程序只能在制定的 engine 上運行货岭,設置為 true

os

可選字段疾渴。指定模塊可以在什么操作系統上運行:

"os" : [ "darwin","linux" ]
"os" : [ "!win32" ]

CPU

可選字段千贯。指定CPU型號。

"cpu" : [ "x64","ia32" ]
"cpu" : [ "!arm","!mips" ]

preferGlobal

可選字段搞坝,布爾值搔谴。如果你的包是個命令行應用程序,需要全局安裝桩撮,就可以設為 true敦第。

private

可選字段,布爾值店量。如果 private 為 true芜果,npm 會拒絕發(fā)布。這可以防止私有 repositories 不小心被發(fā)布出去融师,示例:

"private": true

publishConfig

可選字段右钾。發(fā)布時使用的配置值。

資料

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末旱爆,一起剝皮案震驚了整個濱河市舀射,隨后出現的幾起案子,更是在濱河造成了極大的恐慌怀伦,老刑警劉巖脆烟,帶你破解...
    沈念sama閱讀 210,835評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現場離奇詭異空镜,居然都是意外死亡浩淘,警方通過查閱死者的電腦和手機捌朴,發(fā)現死者居然都...
    沈念sama閱讀 89,900評論 2 383
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來张抄,“玉大人砂蔽,你說我怎么就攤上這事∈鸸撸” “怎么了左驾?”我有些...
    開封第一講書人閱讀 156,481評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長极谊。 經常有香客問我诡右,道長,這世上最難降的妖魔是什么轻猖? 我笑而不...
    開封第一講書人閱讀 56,303評論 1 282
  • 正文 為了忘掉前任帆吻,我火速辦了婚禮,結果婚禮上咙边,老公的妹妹穿的比我還像新娘猜煮。我一直安慰自己,他們只是感情好败许,可當我...
    茶點故事閱讀 65,375評論 5 384
  • 文/花漫 我一把揭開白布王带。 她就那樣靜靜地躺著,像睡著了一般市殷。 火紅的嫁衣襯著肌膚如雪愕撰。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,729評論 1 289
  • 那天醋寝,我揣著相機與錄音搞挣,去河邊找鬼。 笑死甥桂,一個胖子當著我的面吹牛柿究,可吹牛的內容都是我干的邮旷。 我是一名探鬼主播黄选,決...
    沈念sama閱讀 38,877評論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼婶肩!你這毒婦竟也來了办陷?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 37,633評論 0 266
  • 序言:老撾萬榮一對情侶失蹤律歼,失蹤者是張志新(化名)和其女友劉穎民镜,沒想到半個月后,有當地人在樹林里發(fā)現了一具尸體险毁,經...
    沈念sama閱讀 44,088評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡制圈,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,443評論 2 326
  • 正文 我和宋清朗相戀三年们童,在試婚紗的時候發(fā)現自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片鲸鹦。...
    茶點故事閱讀 38,563評論 1 339
  • 序言:一個原本活蹦亂跳的男人離奇死亡慧库,死狀恐怖,靈堂內的尸體忽然破棺而出馋嗜,到底是詐尸還是另有隱情齐板,我是刑警寧澤,帶...
    沈念sama閱讀 34,251評論 4 328
  • 正文 年R本政府宣布葛菇,位于F島的核電站甘磨,受9級特大地震影響,放射性物質發(fā)生泄漏眯停。R本人自食惡果不足惜济舆,卻給世界環(huán)境...
    茶點故事閱讀 39,827評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望莺债。 院中可真熱鬧吗冤,春花似錦、人聲如沸九府。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,712評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽侄旬。三九已至肺蔚,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間儡羔,已是汗流浹背宣羊。 一陣腳步聲響...
    開封第一講書人閱讀 31,943評論 1 264
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留汰蜘,地道東北人仇冯。 一個月前我還...
    沈念sama閱讀 46,240評論 2 360
  • 正文 我出身青樓而叼,卻偏偏與公主長得像寞忿,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子胯究,可洞房花燭夜當晚...
    茶點故事閱讀 43,435評論 2 348

推薦閱讀更多精彩內容

  • 原文鏈接:http://www.mujiang.info/translation/npmjs/files/pack...
    R_X閱讀 1,023評論 0 1
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理色难,服務發(fā)現泼舱,斷路器,智...
    卡卡羅2017閱讀 134,626評論 18 139
  • 什么是 NPM npm之于Node枷莉,就像pip之于Python,gem之于Ruby,composer之于PHP娇昙。 ...
    ihoey閱讀 6,249評論 2 36
  • linux資料總章2.1 1.0寫的不好抱歉 但是2.0已經改了很多 但是錯誤還是無法避免 以后資料會慢慢更新 大...
    數據革命閱讀 12,145評論 2 34
  • npm是什么 NPM的全稱是Node Package Manager,是隨同NodeJS一起安裝的包管理和分發(fā)工具...
    build1024閱讀 7,864評論 0 9