npm 是 Node.js 官方套件管理器,除了安裝/移除套件,也負責將自行開發的模組發布至公共或私有 registry。本文整理從 package.json 設定到發布的完整流程。
專案根目錄下的 package.json 必須符合嚴格 JSON 格式:雙引號包裹鍵值、屬性名加雙引號、最後一個屬性後不加逗號。常用欄位:
| 欄位 | 說明 |
|---|---|
name | 套件名稱(全域唯一,建議加前綴如 @scope/name) |
version | 語意化版本號(SemVer),如 1.0.0 |
description | 簡短描述,利於搜尋 |
author | 作者資訊(name, email, url) |
bin | 可執行檔對應表,供命令列呼叫 |
main | 模組進入點(require() 載入的檔案) |
dependencies | 運行時依賴套件及版本範圍 |
npm install <本地專案路徑>
確認安裝後可正常 require 且 CLI 指令運作無誤。
若 bin 指向的腳本需在 Node 環境執行,檔案首行務必加上:
#!/usr/bin/env node
否則系統會以預設關聯程式開啟而非 Node 執行。
npm adduser
依提示輸入使用者名稱、Email、密碼。完成後會在 ~/.npmrc 寫入認證 token。
npm publish <本地專案路徑>
若為 scoped 套件(名稱含 @scope/),需加參數:
npm publish --access public
修改 package.json 的 version 欄位,再重新執行 npm publish 即可。建議遵循 SemVer:修補用 patch、新功能用 minor、破壞性變更用 major。
npm login 重新認證。.npmignore 或 .gitignore 未正確排除測試/建構產物,導致套件體積過大。