網站導覽
目錄
建立和發布私人套件
目錄
若要與有限制的使用者或團隊分享您的程式碼,您可以將私人使用者範圍或組織範圍套件發佈到 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
發佈私人套件
預設情況下,範圍套件會以私人可見度發布。
-
在命令列中,導航到套件的根目錄。
cd /path/to/package
-
若要將您的私人套件發佈到 npm 註冊表,請執行
npm 發布
-
若要查看您的私人套件頁面,請瀏覽 https://npmjs.com/package/*package-name*,並將 *package-name* 替換為您的套件名稱。私人套件將在 npm 網站上套件名稱下方顯示
private
。
有關 publish
指令的更多資訊,請參閱 CLI 文件。