手把手教你發(fā)布自己的NPM包

前言

當你在完成一個個工程項目時,忽然發(fā)現(xiàn)需要某個需求實現(xiàn)工具,恰好此時你發(fā)現(xiàn)npm或者git上還沒有這樣的工具,或者沒有完全滿足你要求的工具。
是時候展現(xiàn)真正的技術(shù)了,你可以自己實現(xiàn)它,并且發(fā)布到npm上,作為一個輪子供其他人使用,這將是一件令程序員興奮的事。
在你發(fā)布的npm包右側(cè)可以看到每天的下載量。這在你的簡歷里也是一個亮點。
下面,我將手把手教你發(fā)布自己的NPM包!

1.注冊NPM 賬號

注冊地址:www.npmjs.com/

2.初始化自己要發(fā)布的項目

搭建本地環(huán)境:安裝node.js,包含了npm命令。 新建目錄,在該目錄下,初始化項目:npm init。 按照提示填寫初始化信息,我的模塊名稱為:node-cpdir,初始版本號:v1.0.0。 模塊名稱需遵循相關(guān)政策要求:www.npmjs.com/policies , 不能夠與已有NPM模塊名沖突等等。

{
  "name": "node-cpdir",
  "version": "1.0.0",
  "description": "A tool to copy a directory to another.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["copydir", "copydir", "moveDir"],
  "author": "Young",
  "license": "ISC"
}
  • name 你的模塊名, 需要保證唯一,npm倉庫上的模塊名是不能重復(fù)的
  • main描述了當你用require('modulename')引用這個模塊的時候,引用的是哪個文件,這個字段的值你可以采用默認的或者修改成你項目中任何一個有效的文件
  • keywords為別人搜索到你的包的關(guān)鍵字
  • author就是你了,但是如果你的項目不是你一個人來發(fā)的,那么你也應(yīng)該將你的開發(fā)伙伴一起添加進去

3.登錄npm,發(fā)布自己的npm包。

npm login

根據(jù)提示輸入之前注冊的賬號、密碼。 發(fā)布npm包到公共平臺:

npm publish --access=public

此時在自己個人的npm賬號主頁可以看到該包。

4.使用自己發(fā)布的包(模塊)的示例代碼:

安裝之前發(fā)布的npm包:

npm install node-cpdir

5.更新自己的NPM包(模塊)及 readme文件

修改代碼和readme.md后,執(zhí)行命令:

npm version patch
npm publish

npm version后面參數(shù)說明:

patch:小變動,比如修復(fù)bug等,版本號變動 v1.0.0->v1.0.1

minor:增加新功能,不影響現(xiàn)有功能,版本號變動 v1.0.0->v1.1.0

major:破壞模塊對向后的兼容性,版本號變動 v1.0.0->v2.0.0

6.發(fā)包常見錯誤:

  • 處于錯誤的npm源:
    npm ERR! 403 Forbidden - PUT http://registry.npm.pt.mi.com/copydir - no_perms
    此時需要使用nrm切換到正確的官方npm源npm -------- https://registry.npmjs.org/
  • 未登錄或切換源后未重新登錄
    npm ERR! 401 Unauthorized - PUT https://registry.npmjs.org/cpdir - You must be logged in to publish packages.
    需要重新npm login
  • 包名重復(fù)
    npm ERR! 403 Forbidden - PUT https://registry.npmjs.org/cpdir - You do not have permission to publish "cpdir". Are you logged in as the correct user?
    需要重命名你的package.json中的name。即使你在npm官網(wǎng)沒有搜到你預(yù)設(shè)的包名,它可能也被發(fā)布占用過,需要重新考慮。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,363評論 6 532
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,497評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,305評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,962評論 1 311
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,727評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,193評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,257評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,411評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,945評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,777評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,978評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,519評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,216評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,657評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,960評論 2 373

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