如何發布一個自定義Node.js模塊到NPM(詳細步驟,附Git使用方法)


 

咱們閑話不多說,直接開始!

 

由於我從沒有使用過MAC,所以我不保證本文中介紹的操作與MAC一致。

文章開始我先假定各位已經在window全局安裝了Node.js,下面開始進行詳細步驟介紹:

本文本着,以極少的文字說明以及極少的代碼書寫為原則來給大家演示!

文章中上傳的模塊不具備任何意義!

 

 

一、封裝node.js模塊時的必需項

1.創建package.json

每一個完整封裝的node模塊,必須含有一個參數明確的package.json文件!

以下為package.json的最精簡配置:

{   
"name": "npmdesc", "version": "0.0.1",
"main": "npmdesc.js" }

package.json詳細配置參照表:

 

2.創建npmdesc.js

exports.desc = function() { 
    console.log("如何發布一個自定義Node.js模塊到NPM"); 
} 

 

3.創建README.md文件,文件內容可以留白(該文件的作用是放置你願意寫的任何自述說明)

 

 

二、在github上建立包含該模塊代碼的公共存儲庫

1.注冊github賬戶(這里不做詳細闡述,假定你已經有了github賬戶)

 

2.創建項目

 

3.如果你初次使用git,請自行了解git的使用方法(這里僅做簡單描述)

這里推薦查看廖雪峰老師對git的講解:http://www.liaoxuefeng.com/wiki/0013739516305929606dd18361248578c67b8067c8c017b000

1.ssh-keygen -t rsa -C "你注冊所使用的郵箱"
2.登陸GitHub,打開“Account settings”,“SSH Keys”頁面點“Add SSH Key”,填上ssh,在Key文本框里粘貼id_rsa.pub文件的內容。

以上步驟是使你的賬戶與git建立通訊的核心步驟!
僅用這些操作遠遠不夠,如果你初次使用git,那么這一步可能將會使你看的雲里霧里摸不清頭腦,甚至失去繼續了解下文的信心,所以我建議初學者先進行git的簡單了解。

 

4.推送項目到剛剛創建的公共存儲庫(這里假定你已完成以上所有內容,並對git的使用有了簡單的認識)

在你的項目根目錄中依次運行以下git命令:

1.git init
2.git add npmdesc.js
git add package.json
git add README.md
3.git remote add origin git@github.com:BGOnline-CN/npmdesc.git
4.git commit -m "如何發布一個自定義Node.js模塊到NPM" 5.git pull --rebase origin master 6.git push -u origin master

以上步驟的作用(這里的截圖僅做輔助理解,截圖內容並不完善,具體執行步驟需參考第4步):

git init (初始化本地git庫)

git add (暫存文件)

git remote add origin git@github.com:XXXX/XXXX.git (使本地與遠程庫進行連接)

git commit -m "XXXX" (提交暫存到本地庫,-m 為你的提交信息,這個是必填的!你需要告訴git你為什么要進行本次提交。)

git pull --rebase origin master (拉取遠程庫中的內容)

git push -u origin master (將本地項目推送到遠程庫)

 

5.修改package.json文件,填入你的項目在git公共存儲庫中的信息及你希望npm進行搜索時的關鍵字

{  
    "name": "npmdesc",
    "version": "0.0.1",
    "main": "npmdesc.js",
    "repository": {
        "type": "git",
        "url": "https://github.com/BGOnline-CN/npmdesc"
    },
    "keywords": [
        "npmdesc"
    ]
}

 

 

 

三、生成模塊

1.在你的項目根目錄打開控制台窗口鍵入命令

npm pack

此時npm會將你的項目打包為一個后綴名為.tgz的壓縮包,這就是你的Node.js模塊

 

2.別忘了將修改后的package.json及剛剛打包好的.tgz推送到git哦~這里我就不介紹了。

可能在進行git操作時或多或少的會出現一些你暫時無法理解的問題。如果剛好這時你遇到了,請不要害怕,細致的摸索及強大的搜索引擎可以幫助你!任何人都是這樣摸爬滾打過來的。

當然不排除我的文章有疏漏 - -

 

 

四、發布到npm

1.在https://npmjs.org網站中建立賬戶(這里不做介紹)

 

2.在命令行中使用以下命令把創建的賬戶添加到環境中:

npm adduser

回車之后將會提示你輸入用戶名和密碼以及郵箱,這里密碼將不會明文顯示。

出現下圖說明命令執行成功!

 

3.發布模塊到npm

在項目根目錄執行以下命令:

npm publish

如果出現以上錯誤,使用如下命令即可解決

npm config set registry http://registry.npmjs.org 

執行該命令后需要重新進行登錄,使用第2步中的命令即可

 

 

五、發布成功

如果一切正常,將會出現下圖:

到這里你的 Node.js模塊就已經發布成功了,你可以試試在npm官網中搜索它,並在項目中使用它了

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM