網站導覽
目錄
建立並發布作用域公開套件
目錄
若要公開分享程式碼在使用者或組織命名空間中,您可以將公開使用者範圍或組織範圍的套件發布到 npm 註冊中心。
如需範圍的更多資訊,請參閱「關於範圍」。
注意:在您可以發布使用者範圍的 npm 套件之前,您必須註冊一個 npm 使用者帳戶。
此外,若要發布組織範圍的套件,您必須建立一個 npm 使用者帳戶,然後建立一個 npm 組織。
建立範圍公開套件
-
如果您使用 npmrc 來管理多個註冊中心的帳戶,請在命令列中切換到適當的設定檔
npmrc <設定檔名稱>
-
在命令列中,為您的套件建立一個目錄
mkdir my-test-package
-
導覽至套件的根目錄
cd my-test-package
-
如果你使用 git 來管理你的套件程式碼,在套件根目錄中,執行下列指令,並將
git-remote-url
替換為你的套件的 git 遠端 URLgit initgit remote add origin git://git-remote-url -
在套件根目錄中,執行
npm init
指令,並將範圍傳遞給scope
旗標-
對於組織範圍的套件,將
my-org
替換為你的組織名稱npm init --scope=@my-org
-
對於使用者範圍的套件,將
my-username
替換為你的使用者名稱npm init --scope=@my-username
-
-
回應提示以產生
package.json
檔案。有關命名你的套件的說明,請參閱「套件名稱指南」。 -
建立一個 README 檔案,說明你的套件程式碼是什麼以及如何使用它。
-
在你偏好的文字編輯器中,撰寫你的套件程式碼。
查看套件內容是否有敏感或不必要的資訊
將敏感資訊發布到登錄可能會對你的使用者造成傷害、危害你的開發基礎架構、修復起來很昂貴,並使你面臨法律行動的風險。我們強烈建議在將你的套件發布到登錄之前,移除敏感資訊,例如私鑰、密碼、個人可識別資訊 (PII) 和信用卡資料。
對於較不敏感的資訊,例如測試資料,請使用 .npmignore
或 .gitignore
檔案來防止發布到登錄。有關更多資訊,請參閱 這篇文章。
測試套件
為了降低發布錯誤的機率,我們建議在將你的套件發布到 npm 登錄之前先測試它。若要測試你的套件,請執行 npm install
並加上你的套件目錄的完整路徑
npm install my-package
發布範圍公開套件
預設情況下,範圍套件會以私人可見度發布。若要以公開可見度發布範圍套件,請使用 npm publish --access public
。
-
在命令列中,導覽至你的套件的根目錄。
cd /path/to/package
-
若要將你的範圍公開套件發布到 npm 登錄,請執行
npm publish --access public
注意:如果你使用 GitHub Actions 來發布你的套件,你可以為你發布的每個套件產生來源資訊。有關更多資訊,請參閱「產生來源聲明」。
-
若要查看你的公開套件頁面,請拜訪 https://npmjs.com/package/\*package-name\,並將 *package-name* 替換為你的套件的名稱。在 npm 網站上,公開套件會在套件名稱下方顯示
public
。
有關 publish
指令的更多資訊,請參閱 CLI 文件。