如何在 Npm 上發布一個包
Node 包管理器,俗稱 npm,是一個用于發布 NodeJS 包和庫的在線存儲庫。
它也是一個命令行工具,可讓您與已注冊的包進行交互。它可以幫助進行包安裝、版本管理和依賴管理。
開發人員每天都會在 npm 上發布他們的 JavaScript 庫。這個過程相當簡單,所以你也可以在 npm 上發布一個包。
第 1 步:安裝 NodeJS
要與 npm 交互,您必須在系統上全局安裝它。
首先在 Ubuntu 、Windows或按照NodeJS?網站上的說明安裝 NodeJS 和 npm 。
第 2 步:創建一個 npm 帳戶
要在 npm 上發布你的包,你必須在 npm 官方網站上創建一個 npm 帳戶。
按照以下步驟創建一個 npm 帳戶:
- 轉到npm 注冊頁面。
- 填寫您的詳細信息,同意許可和隱私政策,然后單擊“創建帳戶”。
- 使用您從郵箱中的 npm 收到的鏈接驗證您的電子郵件。
如果您不驗證您的電子郵件地址,npm 將在您嘗試發布包時拋出錯誤。
第 3 步:初始化 Git 存儲庫
接下來,您需要初始化一個 Git 存儲庫以跟蹤您將對項目所做的所有更改。
在您的終端上,導航到項目的根目錄并運行以下命令來初始化一個空的 Git 存儲庫。
git init
創建一個.gitignore文件并添加您不希望 Git 跟蹤的任何文件。然后運行以下命令來跟蹤剩余的文件:
git add -A
接下來,運行以下命令,通過將代碼提交到 Git 來獲取您的第一個快照。
git commit -m initial-commit
您可以選擇在 GitHub 或 GitLab 等類似服務上托管您的 Git 存儲庫,以實現無縫協作。
第 4 步:在您的項目中初始化 npm
接下來,在您的項目中初始化 npm 以將有關您的項目的詳細信息添加到 package.json 文件中。這些細節將在 npm 上公開。
在您的終端上,導航到項目的根目錄并運行以下命令來初始化項目中的 npm。
npm init
上面的命令將在您的命令行上觸發一組提示:
- 包名(package name):這是你的 npm 包的名稱;如果你想在 npm 上發布包,它必須是唯一的;否則,npm 會拋出錯誤。
- version:此屬性表示您的包的當前版本。每次更新包時都必須增加它,否則 npm 會拋出錯誤。默認值為 1.0.0。
- description:此屬性是您的包的描述。當你發布你的包時,它將是公開的。
- 入口點(entry point):此屬性表示代碼執行開始的文件名。
- test command :該屬性表示執行npm run test時將運行的命令。
- git repository:此屬性是遠程 Git 存儲庫的 URL。
- 關鍵字(keywords):此屬性表示與您的項目相關的關鍵字,這將有助于搜索引擎找到它。
- author: 這個屬性應該是你的名字或別名。
- license:這是您要發布包的許可證。默認許可證是 Internet Systems Consortium (ISC) 許可證。
設置好之后,你就可以創建你的包了。
第 5 步:測試你的包
完成創建包后,您應該在本地對其進行測試,以了解在 npm 上部署它后它的行為。
要在本地測試您的包,首先,在您的項目目錄中運行以下命令:
npm link
上面的命令允許您在本地引用您的包,就像使用 npm 托管的包一樣。
然后,在項目的根目錄中創建另一個文件夾并 cd 進入它。
mkdir test
cd test
在 test 文件夾中,運行以下命令將您的包鏈接到該文件夾:
npm link name-of-your-package
最后,創建一個虛擬文件來測試你的包的功能。
完成測試后,您可以安全地刪除測試文件夾。
第 6 步:在您的系統上登錄 npm
接下來,您必須在系統上登錄您的 npm 帳戶。
運行以下命令以登錄到您的 npm 帳戶:
npm login
這將提示您填寫您的用戶名、密碼和雙重身份驗證代碼(如果您在您的帳戶中啟用了它)。
第 7 步:發布您的包
完成上述所有步驟后,運行以下命令在 npm 上發布您的包。
npm publish
此命令需要一個一次性密碼,該密碼將用于您的電子郵件。然后,它將在 npm 上發布您的包。
你可以查看你在 npm 上發布的包。在npmjs.com上登錄您的 npm 帳戶并導航到您的個人資料儀表板上的包部分。
要安裝您的包并將其用作任何項目的依賴項,請運行:
npm install name-of-your-package
從 npm 中刪除你的包
您仍然可以完全控制 npm 上的包,這意味著您可以從 npm 修改甚至永久刪除您的包。您可以通過轉到包的設置部分并選擇刪除包選項來刪除包。