【譯】發(fā)布你自己的npm包

banner

備注:npm模塊有個(gè)神奇的樣板别威。這篇文章是基于我從設(shè)置中學(xué)到的東西母谎。

如今埂蕊,NPM已經(jīng)成為javascript庫(kù)的事實(shí)上的注冊(cè)表揪利。特別是React,Angular和其他前端庫(kù)主導(dǎo)的網(wǎng)絡(luò)和node.js接管的服務(wù)器端,NPM軟件包比以往任何時(shí)候都更受歡迎笛坦。通常区转,我們會(huì)在代碼中引入實(shí)用包,比如typy版扩,sugar废离,并輕松的使用它們。

那么礁芦,你有沒(méi)有想過(guò)編寫(xiě)自己的實(shí)用程序/庫(kù)蜻韭,并將其發(fā)布到NPM上面,以便在世界任何的地方可以重復(fù)使用它柿扣?如果是肖方,那就繼續(xù)閱讀。?

我們將在本文中介紹以下部分未状。

  1. 為什么俯画?
  2. 發(fā)布的步驟
  3. 樣板文件

為什么?

當(dāng)你在多個(gè)項(xiàng)目中工作時(shí)司草,你經(jīng)常發(fā)現(xiàn)自己在多個(gè)項(xiàng)目中重復(fù)簡(jiǎn)單的事情艰垂。舉個(gè)例子,以你想要的方式解析日期并對(duì)其進(jìn)行格式化埋虹。大多數(shù)開(kāi)發(fā)者只是從一個(gè)項(xiàng)目復(fù)制代碼到另一個(gè)項(xiàng)目中使用它猜憎,因?yàn)樗皇菐仔写a。但更好的方法是提取代碼并將其放在一個(gè)公共的位置吨岭,以便你可以從任何項(xiàng)目中訪問(wèn)它拉宗。NPM是一個(gè)理想且不斷發(fā)展的生態(tài)系統(tǒng)峦树,并且可以免費(fèi)使用它辣辫。所以,從長(zhǎng)遠(yuǎn)看魁巩,將所有可重用代碼作為npm包發(fā)布上去將會(huì)幫助到你急灭。

無(wú)論代碼有多少,無(wú)論是一行還是一千行谷遂,都可以將其作為包發(fā)布葬馋,以便在多個(gè)代碼庫(kù)中輕松使用。

此外,你還可以成為這個(gè)庫(kù)的作者畴嘶。多么酷暗坝狻!??

發(fā)布的步驟

發(fā)布通常是一個(gè)簡(jiǎn)單的過(guò)程窗悯。

code => test => publish => revise code => test => publish new version ...

入口

創(chuàng)建一個(gè)新目錄(区匣,進(jìn)入目錄)并從終端輸入以下命令。

npm init

(根據(jù)提示)輸入有意義的包名稱和包的相應(yīng)詳細(xì)信息蒋院。這將為你創(chuàng)建package.json亏钩。所有NPM包都需要main鍵。這定義了我們庫(kù)的入口點(diǎn)欺旧。默認(rèn)情況下姑丑,這入口點(diǎn)將是index.js,但是你可以根據(jù)你自己的情況來(lái)更改入口點(diǎn)(文件)辞友。

對(duì)于Babel或基于bundle的庫(kù)栅哀,入口點(diǎn)通常位于構(gòu)建目錄中。

源碼

如果你正在編寫(xiě)一個(gè)小型庫(kù)称龙,則可以將所有代碼放入index.js中昌屉。但是,更常見(jiàn)的是茵瀑,我們將抽象代碼并將其放入單獨(dú)的文件中间驮。所以,理想的方法是將所有源代碼保存在src中马昨。

這是目前最廣泛使用和推薦的源代碼設(shè)置竞帽,盡管它從一個(gè)庫(kù)到另一個(gè)庫(kù)中有所不同。

我們大多數(shù)的人已經(jīng)知道(上面)這些事鸿捧,所以屹篓,我僅僅列出來(lái),把它們留給你弄清楚匙奴。

測(cè)試

你需要進(jìn)行全面測(cè)試堆巧,以確保你的代碼按照預(yù)期工作。有各種測(cè)試設(shè)置泼菌。你可以使用最適合你需求的谍肤。那么,廣泛使用的測(cè)試設(shè)置有

... 等等

如果你需要代碼覆蓋率哗伯,我很喜歡(覆蓋率)荒揣,Istanbul是任何JavaScript項(xiàng)目的最佳覆蓋工具之一。我非常喜歡它焊刹。

發(fā)布

一旦你的代碼通過(guò)了測(cè)試系任,那么可以準(zhǔn)備發(fā)布了恳蹲。

  1. npmjs.com中創(chuàng)建一個(gè)賬號(hào)。
  2. 在控制臺(tái)上運(yùn)行下面的指令
npm login

輸入你的用戶名和密碼俩滥。這將存儲(chǔ)憑據(jù)嘉蕾,因此你不必為每次發(fā)布輸入憑據(jù)。

  1. 現(xiàn)在去發(fā)布霜旧,運(yùn)行(下面指令)
npm publish

這會(huì)將你的包發(fā)布到NPM注冊(cè)表荆针。發(fā)布完成后(不到一分鐘),你可以在鏈接https://www.npmjs.com/~{username}/{package-name}中查看你的包颁糟。

如果你想對(duì)包進(jìn)行更改航背,則必須更改版本號(hào)并再次發(fā)布。

請(qǐng)記住使用npm命令npm version patch棱貌,npm version minornpm verson major來(lái)自動(dòng)更新版本玖媚,而不是手動(dòng)更新它們。這些命令是基于語(yǔ)義版本控制婚脱。

樣板文件

我有一些我自己的npm軟件包今魔,并在線研究了創(chuàng)建NPM軟件包的所有最佳實(shí)踐,并專門(mén)為此創(chuàng)建了樣板文件障贸。它具有預(yù)先設(shè)置的所有功能错森,以便你可以在幾秒鐘內(nèi)開(kāi)始使用。如果你正在尋找編寫(xiě)JavaScript util包篮洁,它可能只是你的樣板涩维。

樣板文件的鏈接 -- npm-module-boilerplate

你是最棒的袁波!祝你度過(guò)美好的一天瓦阐!??

后話

原文:https://hackernoon.com/publish-your-own-npm-package-946b19df577e

文章首發(fā):https://github.com/reng99/blogs/issues/25

同步掘金:https://juejin.im/post/5ce4ce0f51882572e42300bd

更多內(nèi)容:https://github.com/reng99/blogs (客官可否star下倉(cāng)庫(kù)啊@~@!)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市篷牌,隨后出現(xiàn)的幾起案子睡蟋,更是在濱河造成了極大的恐慌,老刑警劉巖枷颊,帶你破解...
    沈念sama閱讀 218,755評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件戳杀,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡夭苗,警方通過(guò)查閱死者的電腦和手機(jī)信卡,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)听诸,“玉大人坐求,你說(shuō)我怎么就攤上這事蚕泽∩卫妫” “怎么了桥嗤?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,138評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)仔蝌。 經(jīng)常有香客問(wèn)我泛领,道長(zhǎng),這世上最難降的妖魔是什么敛惊? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,791評(píng)論 1 295
  • 正文 為了忘掉前任渊鞋,我火速辦了婚禮,結(jié)果婚禮上瞧挤,老公的妹妹穿的比我還像新娘锡宋。我一直安慰自己,他們只是感情好特恬,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布执俩。 她就那樣靜靜地躺著,像睡著了一般癌刽。 火紅的嫁衣襯著肌膚如雪役首。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,631評(píng)論 1 305
  • 那天显拜,我揣著相機(jī)與錄音衡奥,去河邊找鬼。 笑死远荠,一個(gè)胖子當(dāng)著我的面吹牛矮固,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播譬淳,決...
    沈念sama閱讀 40,362評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼乏屯,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了瘦赫?” 一聲冷哼從身側(cè)響起辰晕,我...
    開(kāi)封第一講書(shū)人閱讀 39,264評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎确虱,沒(méi)想到半個(gè)月后含友,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡校辩,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年窘问,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片宜咒。...
    茶點(diǎn)故事閱讀 40,040評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡惠赫,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出故黑,到底是詐尸還是另有隱情儿咱,我是刑警寧澤庭砍,帶...
    沈念sama閱讀 35,742評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站混埠,受9級(jí)特大地震影響怠缸,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜钳宪,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評(píng)論 3 330
  • 文/蒙蒙 一揭北、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧吏颖,春花似錦搔体、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,944評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至奉呛,卻和暖如春计螺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背瞧壮。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,060評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工登馒, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人咆槽。 一個(gè)月前我還...
    沈念sama閱讀 48,247評(píng)論 3 371
  • 正文 我出身青樓陈轿,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親秦忿。 傳聞我的和親對(duì)象是個(gè)殘疾皇子麦射,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評(píng)論 2 355

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