NodeJS小工具系列(1):建立和發佈Npm模塊

前言

NodeJS的同窗都知道,寫一個Npm模塊前,要建立一堆的基礎文件,如.gitignore😰、.npmignore😰、license😰、package.json😰、readme.md😰等文件。寫一兩個還好,手動建立後慢慢複製相關的信息到文件中去,可是有些同窗比較活躍,常常爲Npm社區作貢獻,此時此刻這些Npm模塊的基礎文件建立和書寫確實是挺佔時間的😂。既然這些文件的內容相對比較統一,那麼咱們能夠把它們作成模板,經過命令一鍵生成,那挺好的呀,哈哈😉。其實,咱們開發Npm模塊主要仍是集中在模塊功能邏輯代碼上,這些附加的文件確實有點使人討厭,可是不加又不行,對吧😬。因此,小編我就開發了個小工具pkg-master來解決上述問題,爲了方便發佈Npm模塊,還增長了一鍵發佈的功能,發佈前會自動檢測發佈模塊須要準備的工做,檢測完後沒問題就自動上傳到Npm中🙏。git

pkg-master

安裝

npm i -g pkg-master
複製代碼

使用

命令 簡寫 功能
pkg-master lang pkg-master l 切換語言
pkg-master new pkg-master n 建立模塊
pkg-master publish pkg-master p 發佈模塊
  • 建立你的模塊pkg-master n,提供一些問答讓你自定義模塊的一些基礎文件
  • 進入建立好的模塊cd yourModuleName,而後開發模塊的功能
  • 發佈開發好的模塊pkg-master p,若是執行步驟出錯,請根據提示修復再執行pkg-master p

語言

可以使用pkg-master l來切換國際語言,目前提供如下語言github

  • zh 中文
  • en 英文

細說

  • 在發佈過程當中,可能會提示請執行 npm config set registry https://registry.npmjs.org/ 切換回源鏡像。國內大部分的開發者會由於Npm源鏡像的資源下載過慢而把鏡像切換成淘寶鏡像🤒,而使用淘寶鏡像發佈Npm模塊是不會成功的,須要把鏡像設置回源鏡像才能正常發佈。
  • 在發佈過程當中,可能會提示請執行 npm login 登陸您的Npm帳號,無帳號請執行 npm adduser 建立您的Npm帳號。發佈Npm包是須要權限的😥,執行npm login登陸你的帳號便可,若是是第一次發佈,執行npm adduser建立帳戶,在登陸你的帳號便可。
  • 在發佈過程當中,可能會提示模塊已存在,請使用其餘名稱發佈模塊。由於Npm模塊是不容許重名的😣 ,把package.json的name屬性從新起一個名字就好。
  • 發佈時記得cd yourModuleName到根目錄喲,否則發錯了別怪我哈😛。執行npm unpublish yourModuleName@x.y.z便可撤回發佈出去的Npm包,詳情可自行百度。
  • 以上錯誤在修復後須要從新執行pkg-master p纔會發佈成功喲!

Publish

結語

感興趣的小夥伴能夠自行查看項目源碼(親,點擊這裏),喜歡的話給個Star咧😂。醞釀下準備寫NodeJS小工具系列的第二篇......😋npm

dog
相關文章
相關標籤/搜索