首頁 >web前端 >js教程 >如何將套件發佈到 npm:逐步指南

如何將套件發佈到 npm:逐步指南

Linda Hamilton
Linda Hamilton原創
2024-11-19 15:55:03290瀏覽

在 NPM(Node 套件管理器)上發布套件不僅是與其他開發人員分享您的工作的一種方式,也是在開發社群中脫穎而出的一種方式。想像一下,創建一個可重複使用的解決方案,可以整合到世界各地的各種專案中,從而節省其他程式設計師的時間和精力。

在本文中,您將逐步學習如何在 NPM 上配置、發布和維護自己的包,使您的貢獻易於訪問並提高您作為開發人員的知名度。

先決條件

開始之前,請確保您擁有:

  • 已安裝 NPM。您可以從nodejs.org下載它或使用NVM(Node版本管理器)。
  • 在 npmjs.com 上建立的帳戶

在終端機中執行以下命令,以驗證 Node.js 和 NPM 是否安裝成功。

如果安裝正確,終端機會顯示各個版本。
結果將類似以下內容:

配置專案

首先使用您想要的套件名稱建立一個資料夾。就我而言,我選擇了「string-reverser-jm」。

初始化 NPM:

執行上述指令時,終端機會問你幾個問題來建立 package.json 檔案。
以下是我們需要填寫的每個項目的解釋。

  • 名稱:套件的唯一識別碼。
  • 版本:使用語意版本控制來指示變更。
  • 描述:對此套件功能的簡要說明。
  • main:入口點文件,例如index.js。
  • 關鍵字:用於分類的關鍵字,以便其他開發者更容易找到套件。
  • 作者:新增相關作者詳細資料。
  • 許可證:許可證定義了其他人如何使用、修改和分發程式碼。最常見的許可證是 MIT,它是寬鬆的,允許很大的使用自由,只要提供原始版權聲明即可。

如果您完成了問題並且 NPM 創建了沒有任何此資訊的文件,請在編輯器中打開創建的文件並添加缺少的內容。

範例:

編寫程式碼

在專案根目錄中建立index.js檔案。

測試包

為了在發布之前測試包,我們將使用 npm link 命令

在套件目錄下,執行指令:

在要測試套件的項目中,執行指令:

在測試專案中匯入並使用該套件以確保其正常運作:

要刪除已建立的鏈接,只需在測試專案目錄中執行命令 npm unlink string-reverser-jm ,然後在套件目錄中執行 npm unlink 即可。

準備發布包

首先,為套件建立一個 Git 儲存庫並將其連結到 NPM。這透過提供原始程式碼來提高透明度和信任,促進協作和社群貢獻,並透過 CI/CD 實現自動化,以實現更有效率的管理和維護。

要連結到 NPM,請複製儲存庫的 https 位址並將其新增至 package.json:

  • .gitignore:建立 .gitignore 檔案以從版本控制中排除資料夾和文件,例如 node_modules 和 .env。
  • .npmignore:建立 .npmignore 檔案以指定哪些檔案和資料夾不應包含在 NPM 套件中。
  • README.md:建立包含有關套件的資訊的檔案。

發布包

使用您的登入詳細資料登入 NPM:

執行以下命令來發布套件:

好的,該軟體包很快就會在 NPM 註冊表中可用!
https://www.npmjs.com/package/string-reverser-jm

更新套件

進行更新或錯誤修復時,請使用下列命令之一根據語意版本控制增加 package.json 中的版本號:

然後發布更新版本:

常見問題:

  • 套件名稱已被佔用:如果由於已存在同名套件而導致發布失敗,請選擇另一個尚未被佔用的名稱。
  • 驗證錯誤:確保您已登入並擁有發布所需的所有權限。
  • 版本衝突:如果您嘗試在不更新版本號的情況下發布,NPM 將拒絕您的貼文。使用npm version來增加版本。

Como publicar um pacote no npm: um guia passo a passo

Como publicar um pacote no npm: um guia passo a passo

以上是如何將套件發佈到 npm:逐步指南的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn