備注: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ù)閱讀。?
我們將在本文中介紹以下部分未状。
- 為什么俯画?
- 發(fā)布的步驟
- 樣板文件
為什么?
當(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ā)布了恳蹲。
- 在npmjs.com中創(chuàng)建一個(gè)賬號(hào)。
- 在控制臺(tái)上運(yùn)行下面的指令
npm login
輸入你的用戶名和密碼俩滥。這將存儲(chǔ)憑據(jù)嘉蕾,因此你不必為每次發(fā)布輸入憑據(jù)。
- 現(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 minor
和npm 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ù)啊@~@!)