五分鐘建立一個本身的NPM包

建立NPM包

  • 介紹

npm 能夠很是方便地發佈一個包,比 pip、gem、pear 要簡單得多。在發佈以前,首先 須要讓咱們的包符合npm的規範,npm有一套以CommonJS爲基礎包規範,但與CommonJS 並不徹底一致,其主要差異在於必填字段的不一樣。git

  • 步驟

建立一個npm目錄:web

mkdir npm && cd npm
複製代碼

在目錄中運行init:npm

npm init
複製代碼

獲取一個npm帳號:數組

npm adduser
複製代碼

檢驗帳號建立狀況:bash

npm whoami
複製代碼

發佈你的npm包:測試

npm publish
複製代碼

這是一個無心義的測試包,使用命令刪除:ui

npm unpublish
複製代碼

查看你的npm包:url

https://www.npmjs.com/package/xxx
複製代碼

建立時的參數

  • name:包的名稱,必須是惟一的,由小寫英文字母、數字和下劃線組成,不能包含 空格。
  • description:包的簡要說明。
  • version:符合語義化版本識別1規範的版本字符串。
  • keywords:關鍵字數組,一般用於搜索。
  • maintainers:維護者數組,每一個元素要包含 name、email (可選)、web (可選) 字段。
  • contributors:貢獻者數組,格式與maintainers相同。包的做者應該是貢獻者 數組的第一個元素。
  • bugs:提交bug的地址,能夠是網址或者電子郵件地址。
  • licenses:許可證數組,每一個元素要包含 type (許可證的名稱)和 url (連接到許可證文本的地址)字段。
  • repositories:倉庫託管地址數組,每一個元素要包含 type(倉庫的類型,如 git )、 9 url (倉庫的地址)和 path (相對於倉庫的路徑,可選)字段。
相關文章
相關標籤/搜索