如何將自己寫的插件年鸳,上傳至npm?

作為前端趴久,我們經(jīng)常在npm上面下載各種各樣各路大神的插件,安裝至我們的項目中搔确,方便又快捷彼棍。下面就簡單介紹一下如何將我們自己寫的小插件上傳至npm,供自己和大家下載使用膳算。

前提需要在自己的電腦下載node.js ,下載完自動會有npm.( 自行下載 )

首先需要在npm官網(wǎng)注冊一個賬號座硕。(https://www.npmjs.com/signup,自行注冊涕蜂,不多介紹)华匾。

注冊完后,使用cmd終端的方式登錄 npm login ,如圖

登錄報錯.png

依次輸入用戶名机隙,密碼蜘拉,郵箱

輸入成功后如出現(xiàn)以上報錯信息:大概意思是我們吧npm倉庫指向成了淘寶鏡像庫了,這可能是因為我們以前安裝了cnpm有鹿,我們需要吧設置成npm倉庫旭旭,解決如下:

cmd執(zhí)行:?npm config set registry=http://registry.npmjs.org? ? ?如圖:


設置完后.png

設置完成后,使用命令? ?npm config get registry? ? 查看印颤,成功指向了npm您机。

以上終端登錄完成 接下來開始編碼我們需要上傳的插件吧穿肄!

首先新建一個空文件夾年局,我這里是myTestPlugin际看,終端進入當前文件夾,初始化項目? npm init

需要填寫的信息依次是:

package name:? ?包的名稱

version:? ? ? ? ? 版本號

description:? ? ?包的描述

entry point:? ? ? 入口文件矢否,默認是index.js

test command:? ?測試命令仲闽,可以不填直接回車

git repository:? ? 提供git個人倉庫,可以不填僵朗,直接回車

keywords:? ? ?testplugin?(項目的關鍵詞赖欣,npm搜索關鍵詞)

author:? ? ? ? ? ? 作者名稱

license: (ISC)? ? ?包遵循的開源協(xié)議,默認是ISC


init.png

以上填寫完畢后會出現(xiàn)剛才填寫的項目結(jié)構验庙,is this ok ? 是否確定顶吮,直接回車即可.

回到自己的文件夾,會多出現(xiàn)一個package.json文件粪薛,就是我們剛才填的項目信息悴了,如圖:


init.png

此時我們在當前文件夾下面新建一個index.js的入口文件,寫上一個簡單的方法违寿,如圖:


fn.png

此時打開我們的終端湃交,進入當前文件夾,輸入命令 npm publish? 發(fā)布至npm : 成功后如圖:


success.png

然后我們進入npm 官網(wǎng)(https://www.npmjs.com)藤巢,搜索我們剛剛發(fā)布的插件搞莺。如圖

plugin.png

接下來就是在我們自己的項目里面安裝我們的插件:

新建項目,進入該項目cmd,執(zhí)行? ?npm install?test-plugin-xyp? ?安裝我們的插件掂咒,然后引入調(diào)用才沧。(我這里是使用node命令執(zhí)行)如圖:

我們的插件也被安裝在node_modules文件夾下面了。

如上圖绍刮,調(diào)用成功糜工,出現(xiàn)幾個warning警告,是因為項目沒有執(zhí)行 npm init 初始化生成package.json 項目配置文件录淡。因為我是使用node啟動程序的捌木。需要的同學可以?npm init。?

如果今后我們在插件源碼上面新增了功能嫉戚,發(fā)布前需要在源碼文件夾的package.json文件下修改下?version 屬性值(版本號),然后在重新執(zhí)行命令 npm?publish ,發(fā)布成功后刨裆,則可以在npm官網(wǎng)搜到我們的更新版本號相關信息。 然后在我們自己的項目中重新npm install? 插件名 彬檀,就可以使用我們新添加的功能啦帆啃。

至此,演示完畢窍帝。


當然啦努潘,也有發(fā)布失敗的情況下,下面貼幾種常見的失敗場景:

1:未登錄npm情況下報錯,解決方法:先登錄疯坤。(上文可查看登錄方法)

nologin

2:因為倉庫指向了淘寶鏡像庫报慕,需要設置成npm,執(zhí)行圖中綠色線压怠,然后重新登錄即可

loginSuccess.png

3:大概意思就是你的插件名在npm上已經(jīng)被占用啦眠冈,進入文件目錄下package.json 里面修改?name 屬性值

duplicateName.png

4:此報錯信息是因為新注冊的賬號,還未經(jīng)過驗證菌瘫,需要注冊時的郵箱驗證蜗顽,復制鏈接,并登錄后雨让,才算驗證完畢雇盖,驗證后,重新npm publish


unverified.png
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末栖忠,一起剝皮案震驚了整個濱河市刊懈,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌娃闲,老刑警劉巖虚汛,帶你破解...
    沈念sama閱讀 222,590評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異皇帮,居然都是意外死亡卷哩,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,157評論 3 399
  • 文/潘曉璐 我一進店門属拾,熙熙樓的掌柜王于貴愁眉苦臉地迎上來将谊,“玉大人,你說我怎么就攤上這事渐白∽鹋ǎ” “怎么了?”我有些...
    開封第一講書人閱讀 169,301評論 0 362
  • 文/不壞的土叔 我叫張陵纯衍,是天一觀的道長栋齿。 經(jīng)常有香客問我,道長襟诸,這世上最難降的妖魔是什么瓦堵? 我笑而不...
    開封第一講書人閱讀 60,078評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮歌亲,結(jié)果婚禮上菇用,老公的妹妹穿的比我還像新娘。我一直安慰自己陷揪,他們只是感情好惋鸥,可當我...
    茶點故事閱讀 69,082評論 6 398
  • 文/花漫 我一把揭開白布杂穷。 她就那樣靜靜地躺著,像睡著了一般卦绣。 火紅的嫁衣襯著肌膚如雪耐量。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,682評論 1 312
  • 那天迎卤,我揣著相機與錄音,去河邊找鬼玷坠。 笑死蜗搔,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的八堡。 我是一名探鬼主播樟凄,決...
    沈念sama閱讀 41,155評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼兄渺!你這毒婦竟也來了缝龄?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,098評論 0 277
  • 序言:老撾萬榮一對情侶失蹤挂谍,失蹤者是張志新(化名)和其女友劉穎叔壤,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體口叙,經(jīng)...
    沈念sama閱讀 46,638評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡炼绘,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,701評論 3 342
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了妄田。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片俺亮。...
    茶點故事閱讀 40,852評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖疟呐,靈堂內(nèi)的尸體忽然破棺而出脚曾,到底是詐尸還是另有隱情,我是刑警寧澤启具,帶...
    沈念sama閱讀 36,520評論 5 351
  • 正文 年R本政府宣布本讥,位于F島的核電站,受9級特大地震影響鲁冯,放射性物質(zhì)發(fā)生泄漏囤踩。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,181評論 3 335
  • 文/蒙蒙 一晓褪、第九天 我趴在偏房一處隱蔽的房頂上張望堵漱。 院中可真熱鬧,春花似錦涣仿、人聲如沸勤庐。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,674評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽愉镰。三九已至米罚,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間丈探,已是汗流浹背录择。 一陣腳步聲響...
    開封第一講書人閱讀 33,788評論 1 274
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留碗降,地道東北人隘竭。 一個月前我還...
    沈念sama閱讀 49,279評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像讼渊,于是被迫代替她去往敵國和親动看。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,851評論 2 361

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