npm 的 package.json 簡(jiǎn)介

描述

關(guān)于 package.json 文件中需要的內(nèi)容,您只需要了解這個(gè)文檔奔垦。
它必須是標(biāo)準(zhǔn)的JSON仑嗅,而不是JavaScript對(duì)象字面量宴倍。

本文檔中描述的許多行為都受到npm-config中描述的配置設(shè)置的影響张症。

name

如果您計(jì)劃發(fā)布包仓技,那么包中最重要的部分俗他。json是名稱和版本字段脖捻,因?yàn)樗鼈兪潜匦璧恼仔啤CQ和版本一起構(gòu)成一個(gè)標(biāo)識(shí)符地沮,該標(biāo)識(shí)符被認(rèn)為是完全惟一的。對(duì)包的更改應(yīng)該與對(duì)版本的更改一起出現(xiàn)羡亩。如果不打算發(fā)布包摩疑,名稱和版本字段是可選的畏铆。
名字就是你的東西的名字。

規(guī)則

  • 名稱必須小于或等于214個(gè)字符辞居。這包括作用域包的作用域。
  • 名稱不能以點(diǎn)或下劃線開(kāi)頭瓦灶。
  • 新包的名稱中不能有大寫(xiě)字母。
  • 該名稱最終成為URL刃泡、命令行上的參數(shù)和文件夾名稱的一部分巧娱。因此烘贴,名稱不能包含任何非url安全字符。

小貼士

  • 不要使用與核心節(jié)點(diǎn)模塊相同的名稱上荡。
  • 不要在名稱中使用“js”或“node”馒闷。假設(shè)它是js酪捡,因?yàn)槟诰帉?xiě)一個(gè)包纳账。json文件,您可以使用“engine”字段指定引擎永罚。(見(jiàn)下文)卧秘。
  • 名稱可能會(huì)作為參數(shù)傳遞給require(),所以它應(yīng)該是簡(jiǎn)短的翅敌,但也應(yīng)該是合理的描述性的。
  • 在過(guò)于依賴npm注冊(cè)表之前蚯涮,您可能希望檢查npm注冊(cè)表,看看是否已經(jīng)有了這個(gè)名稱遭顶。https://www.npmjs.com/

名稱可以有選擇地用范圍作為前綴,例如@myorg/mypackage喘批。有關(guān)詳細(xì)信息嗦哆,請(qǐng)參見(jiàn)np -scope

version

如果您計(jì)劃發(fā)布包老速,那么包中最重要的部分。json是名稱和版本字段橘券,因?yàn)樗鼈兪潜匦璧那渫隆CQ和版本一起構(gòu)成一個(gè)標(biāo)識(shí)符锋华,該標(biāo)識(shí)符被認(rèn)為是完全惟一的。對(duì)包的更改應(yīng)該與對(duì)版本的更改一起出現(xiàn)衍腥。如果不打算發(fā)布包纳猫,名稱和版本字段是可選的。

版本必須由node-semver解析芜辕,它與npm綁定為依賴項(xiàng)。(npm install semver to use it yourself.)

更多關(guān)于版本號(hào)和范圍的信息請(qǐng)?jiān)L問(wèn)semver.

description

在里面放一段描述倔丈。它是一個(gè)字符串状蜗。這有助于人們發(fā)現(xiàn)你的包,因?yàn)樗性?npm search 結(jié)果里诗舰。

keywords

輸入關(guān)鍵詞。它是一個(gè)字符串?dāng)?shù)組眶根。這有助于人們發(fā)現(xiàn)您的包边琉,因?yàn)樗性趎pm search 結(jié)果里。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末族扰,一起剝皮案震驚了整個(gè)濱河市定欧,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌扩氢,老刑警劉巖爷辱,帶你破解...
    沈念sama閱讀 219,188評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件朦肘,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡双饥,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)趴生,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)昏翰,“玉大人,你說(shuō)我怎么就攤上這事矩父。” “怎么了窍株?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,562評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵球订,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我冒滩,道長(zhǎng),這世上最難降的妖魔是什么因苹? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,893評(píng)論 1 295
  • 正文 為了忘掉前任篇恒,我火速辦了婚禮,結(jié)果婚禮上胁艰,老公的妹妹穿的比我還像新娘。我一直安慰自己奈梳,他們只是感情好解虱,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著饭寺,像睡著了一般叫挟。 火紅的嫁衣襯著肌膚如雪限煞。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,708評(píng)論 1 305
  • 那天奋献,我揣著相機(jī)與錄音旺上,去河邊找鬼。 笑死宣吱,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的杭攻。 我是一名探鬼主播疤坝,決...
    沈念sama閱讀 40,430評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼跑揉!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起现拒,我...
    開(kāi)封第一講書(shū)人閱讀 39,342評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤扮饶,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后甜无,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體哥遮,經(jīng)...
    沈念sama閱讀 45,801評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡眠饮,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了仪召。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片松蒜。...
    茶點(diǎn)故事閱讀 40,115評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡秸苗,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出惊楼,到底是詐尸還是另有隱情秸讹,我是刑警寧澤檀咙,帶...
    沈念sama閱讀 35,804評(píng)論 5 346
  • 正文 年R本政府宣布弧可,位于F島的核電站劣欢,受9級(jí)特大地震影響棕诵,放射性物質(zhì)發(fā)生泄漏氧秘。R本人自食惡果不足惜丸相,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評(píng)論 3 331
  • 文/蒙蒙 一灭忠、第九天 我趴在偏房一處隱蔽的房頂上張望膳算。 院中可真熱鬧弛作,春花似錦、人聲如沸机隙。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,008評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春娱俺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背模庐。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,135評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工僵朗, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人验庙。 一個(gè)月前我還...
    沈念sama閱讀 48,365評(píng)論 3 373
  • 正文 我出身青樓粪薛,卻偏偏與公主長(zhǎng)得像悴了,于是被迫代替她去往敵國(guó)和親违寿。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評(píng)論 2 355

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

  • 這里只截取了部分常用的選項(xiàng)搞莺,全部?jī)?nèi)容戳這里 概述 注意package.json必須是純JSON的掂咒,而不僅僅是一個(gè)J...
    葉夏星辰閱讀 1,768評(píng)論 0 0
  • 概要 64學(xué)時(shí) 3.5學(xué)分 章節(jié)安排 電子商務(wù)網(wǎng)站概況 HTML5+CSS3 JavaScript Node 電子...
    阿啊阿吖丁閱讀 9,208評(píng)論 0 3
  • 前言 package.json是每個(gè)npm包绍刮、基于node的項(xiàng)目中必不可少的配置文件,這里將詳細(xì)介紹出現(xiàn)在pack...
    ITgecko閱讀 4,069評(píng)論 0 4
  • 去年有段時(shí)間得空岁歉,就把谷歌GAE的API權(quán)威指南看了一遍,收獲頗豐锅移,特別是在自己幾乎獨(dú)立開(kāi)發(fā)了公司的云數(shù)據(jù)中心之后...
    騎單車的勛爵閱讀 20,536評(píng)論 0 41
  • 史睿辰頭疼的看著眼前的作業(yè)饱搏,唉~每天都是這樣,白天被老師罵窍帝,晚上又要寫(xiě)作業(yè)诽偷。坤学。 她無(wú)精打采的趴在桌上,沒(méi)錯(cuò)压怠,她是一...
    蘇格拉一沒(méi)有底閱讀 129評(píng)論 0 0