在npm發(fā)布可安裝的代碼

前言

當看到別人的代碼你只需要使用一行類似這樣的命令:

npm install xxx

就能把代碼全部下載下來。你是否也想著自己的代碼也能這么便捷的被下載。這就是npm的魅力。

關于npm

npm大家應該都了解,它是node.js官方的包管理工具。我們只需要在控制臺輸入一些簡單的命令就能使用它來更新,下載,上傳node包(https://www.npmjs.com )。
關于如何安裝Node.jsnpm本文就不再贅述,大家可以在網(wǎng)上查找資料跟著安裝。如果你還沒有玩過node,就裝一個并跟著我發(fā)布上去試試看,保證這是一片廣闊的天空。

在npm發(fā)布自己的代碼

1.驗證npm

新建一個文件夾用來存包,進入該文件夾(windows的同學可以按住shift鍵+右鍵,選擇在此處打開命令窗口來快速調(diào)出控制臺)。
首先需要驗證一下你是否安裝了npm,如果確認已裝請?zhí)^此步,在控制臺輸入命令:

npm -v

如果顯示了一些版本號,就說明你已經(jīng)安裝:


2.新建package.json

在項目根目錄下新建一個package.json,這是一個用來描述你的包的json文件,例如包名,依賴的其他包,作者等等。
借助npm來初始化可快速新建,在根目錄下輸入命令:

npm init

接著npm會提示你輸入一些關于你的包的信息,如果你暫時不知道怎么填那一項就直接按回車就好:


你會發(fā)現(xiàn)你的根目錄下多了一個package.json文件。
當然name要注意填,它將是你發(fā)布出去的npm包名,如果不小心填錯了,可以直接在新建好的package.json修改name字段。

3.編寫代碼

雖然npm是允許發(fā)布一個空包(只含有package.json的包),但是這樣的一個包是沒有意義的。
我們?nèi)绻麤]有代碼,可以先加一個README.md(給使用者看的說明書)來說明一下自己的包:
在根目錄下新建一個README.md文件,輸入如下內(nèi)容:

# 這是我的一個npm包
未完待續(xù)...

如果你想好了寫說明代碼(js,html,css等)請試著放進來。

4.創(chuàng)建npm賬號

如果你沒有創(chuàng)建過npm賬號,可輸入如下命令添加一個npm賬號,并跟著提示填寫要注冊的賬號和密碼:

npm adduser

5.發(fā)布!

現(xiàn)在可以發(fā)布了。還是在根目錄下輸入命令:

npm publish

如果看到這樣的提示,那么恭喜你已經(jīng)發(fā)布了一個npm包:


這樣你就可以在https://www.npmjs.com搜索并找到你剛才發(fā)布的npm包名(例如我的是:article-npm-publish,如果需要登錄,請使用剛才你在控制臺注冊的賬號):

現(xiàn)在,你可以試著使用npm install xxx(xxx為你的包名)來安裝自己的包啦。

常見問題

1.如果需要更新包,在修改完代碼后請記得修改package.json包的version字段,然后 npm publish。否則會無法發(fā)布;
2.如果在發(fā)布中顯示類似'請確認你是否有權限更新xxx包'的英文提示,這就說明你的包名有人使用了。換個名字就好啦。
3.如果你想刪除一個自己發(fā)布過的包,請使用命令 npm unpublish --force xxx (xxx為包名),一些沒有意義的包還是建議刪掉。

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

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