建立並發布未設定範圍的公開套件

作為 npm 使用者,你可以建立非範圍套件,在自己的專案中使用,並將它們發布到 npm 公開註冊中心,供其他人用於他們的專案。非範圍套件永遠都是公開的,而且僅透過套件名稱來參照

package-name

如需有關套件範圍、存取和可見性的更多資訊,請參閱「套件範圍、存取層級和可見性」。

注意:在您發布公開未設定範圍的 npm 套件前,您必須 註冊 一個 npm 使用者帳戶。

建立非範圍公開套件

  1. 在命令列中,為您的套件建立一個目錄

    mkdir my-test-package
  2. 導覽至您的套件的根目錄

    cd my-test-package
  3. 如果您使用 git 來管理您的套件程式碼,在套件根目錄中,執行以下指令,並將 git-remote-url 替換為您的套件的 git 遠端網址

    git init
    git remote add origin git://git-remote-url
  4. 在套件根目錄中,執行 npm init 指令。

  5. 回應提示以產生一個 package.json 檔案。有關如何為您的套件命名,請參閱「套件名稱指南」。

  6. 建立一個 README 檔案 來說明您的套件程式碼是什麼以及如何使用它。

  7. 在您偏好的文字編輯器中,撰寫您的套件程式碼。

檢閱套件內容是否有敏感或不必要的資訊

將敏感資訊發布到註冊表中可能會對您的使用者造成傷害、危害您的開發基礎架構、造成昂貴的修復成本,並讓您面臨法律行動的風險。我們強烈建議您在將您的套件發布到註冊表中之前,移除敏感資訊,例如私密金鑰、密碼、個人可識別資訊 (PII) 和信用卡資料。

對於較不敏感的資訊,例如測試資料,請使用 .npmignore.gitignore 檔案來防止發布到註冊表中。有關更多資訊,請參閱 這篇文章

測試你的套件

為了降低發布錯誤的機率,我們建議您在將您的套件發布到 npm 註冊表中之前先進行測試。要測試您的套件,請執行 npm install 並加上您的套件目錄的完整路徑

npm install path/to/my-package

發布非範圍公開套件

  1. 在命令列中,導覽至您的套件的根目錄。

    cd /path/to/package
  2. 要將您的公開套件發布到 npm 註冊表中,請執行

    npm 發布

    注意:如果您使用 GitHub Actions 來發布您的套件,您可以為您發布的每個套件產生來源資訊。有關更多資訊,請參閱「產生來源聲明」。

  3. 要查看您的公開套件頁面,請拜訪 https://npmjs.com/package/*package-name*,並將 *package-name* 替換為您的套件的名稱。公開套件會在 npm 網站上套件名稱下方顯示 public

有關 publish 指令的詳細資訊,請參閱 CLI 文件