npm 發(fā)布和更新包

2021-10-29 10:47 更新

你可以發(fā)布任何包含package.json文件的目錄。本章介紹了如何首次發(fā)布包,以及如何在以后更新包。

如何發(fā)布包

了解 npm 政策

在開始之前,最好查看 npm 的政策,以防你對站點(diǎn)禮儀、命名、許可或其他準(zhǔn)則有疑問。

創(chuàng)建用戶帳戶

想要發(fā)布包,你必須是 npm 注冊表的用戶。如果你不是用戶,請使用?npm adduser。?如果你在網(wǎng)站上創(chuàng)建了一個用戶帳戶,請使用npm login從你的終端訪問你的帳戶。

測試:

  1. 從終端輸入npm whoami,查看你是否已經(jīng)登錄(從技術(shù)上講,這也意味著你的證書已經(jīng)存儲在本地)。
  2. 檢查你的用戶名是否已添加到 https://npmjs.com/~username 的注冊表中.

例如 https://www.npmjs.com/~carolynawombat

查看包目錄

查看內(nèi)容

請注意,除非本地的.gitignore.npmignore文件忽略目錄中的所有內(nèi)容,否則將包含該目錄中的所有內(nèi)容。要了解如何使用這些命令,請參閱NPM 開發(fā)者指南。

查看 package.json 文件

閱讀NPM package.json 文件以確保你想要的詳細(xì)信息反映在你的包中。

選擇一個名字 為你的包選擇一個唯一的名稱,嘗試選擇一個具有描述性的名稱:

  • 尚未被他人使用
  • 拼寫不像另一個名字,除了拼寫錯誤
  • 不會混淆其他作者的身份
  • 符合 npm 政策指南。例如,不要將你的包命名為具有冒犯性的名稱,也不要使用其他人的商標(biāo)名稱。
  • 在 package.json 文件的相應(yīng)行中指定名稱。

注意:如果你使用scopes ,則前 3 個警告不適用。

包含文檔 (readme.md)

npm 建議你包含一個自述文件來記錄你的包。自述文件必須具有?readme.md文件。文件擴(kuò)展名.md表示該文件是一個Markdown文件。當(dāng)有人找到你的包時(shí),這個文件會出現(xiàn)在 npm 網(wǎng)站上。

在開始之前,請查看一些包頁面以獲取有關(guān)可以添加到自述文件中的信息的想法,并了解為什么這如此重要。

  1. 使用任何文本編輯器創(chuàng)建文件。
  2. 將其保存在項(xiàng)目目錄中,名稱為readme.md
  3. 當(dāng)發(fā)布時(shí),此文檔將顯示在人們下載你的軟件包的網(wǎng)頁上。

發(fā)布!

使用npm publish發(fā)布包。

測試

https://npmjs.com/package/<package>。你應(yīng)該會看到一個關(guān)于你的新包的頁面。它可能看起來有點(diǎn)像這樣:

更新包

如何更新版本號

當(dāng)你進(jìn)行更改時(shí),你可以使用更新包

npm version <update_type>

其中 <update_type> 是語義版本控制版本類型之一,補(bǔ)丁、次要或主要。

此命令將更改package.json.

注意: 如果你已將一個標(biāo)簽鏈接到你的 npm 帳戶,這還將在你的 git 存儲庫中添加一個帶有更新版本號的標(biāo)簽。

更新版本號后,npm publish再次運(yùn)行。

測試:去https://npmjs.com/package/<package>。應(yīng)該更新包的編號。

如何更新自述文件

除非發(fā)布包的新版本,否則站點(diǎn)上顯示的 README 不會更新,因此你需要運(yùn)行npm version patchnpm publish更新站點(diǎn)上顯示的文檔。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號