NPM 是 Node 的套件管理與分發工具,早已成為非官方發布 Node 模組的標準。有了它,你能快速找到、下載、安裝並管理所需的套件。以下整理學習過程中常用到的操作。
常用指令
(1)$ npm install moduleNames——安裝 Node 模組。若不確定模組名稱,可到 npmjs 網站搜尋,或用 $ npm search indexName 查詢。安裝後會產生 node_modules 目錄。Node 安裝分為全域與本地兩種模式:預設的本地模式會把包裝到與應用同級的 node_modules 下;全域模式則用 $ npm install -g moduleName,並可用 $npm set global=true 設定、$npm get global 查看當前模式。
(2)$ npm view moduleNames——查看模組的 package.json。若只想看某個欄位,可用 $ npm view moduleName labelName。
(3)$ npm list——查看當前目錄已安裝的套件。模組搜尋是從當前目錄開始,可用 $ npm list parseable=true 以樹狀呈現。
(4)$ npm help——查看說明。
(5)$ npm view moduleName dependencies——查看套件依賴關係。
(6)$ npm view moduleName repository.url——查看原始碼位址。
(7)$ npm view moduleName engines——查看套件所依賴的 Node 版本。
(8)$ npm help folders——查看 npm 使用的所有資料夾。
(9)$ npm rebuild moduleName——更改內容後重建。
(10)$ npm outdated——檢查過時的套件,方便及時更新。
(11)$ npm update moduleName——更新模組。
(12)$ npm uninstall moduleName——卸載模組。
(13)一個 npm 套件其實就是包含 package.json 的資料夾,可用 $ npm help json 查看其結構說明。
(14)發布套件前可用 $ npm search packageName 檢驗名稱是否已被占用。
配置 package.json
打包前要先設定好各項資訊,這些都由套件根目錄下的 package.json 指定。內容必須是嚴格的 JSON 格式:字串用雙引號、屬性名要加雙引號、最後一個屬性後不能多打逗號。常用欄位包括 name(套件名,不可重複)、version(版本號)、description(簡介)、author(作者資訊)、bin(可執行檔)、main(require 進入點)、dependencies(依賴套件)。設定好後可先用 npm install <本地路徑> 在本地打包測試。此外,若希望可執行程式在 Node 環境運行,請在入口檔最前面加上 #!/usr/bin/env node。
註冊 npm 帳號
要把套件發布到 npm,需先註冊帳號,透過指令 npm adduser,依提示輸入用戶名、Email 與密碼即可。
發布套件
準備就緒後,執行 npm publish <本地路徑> 即可發布。日後更新時,只要改一下 package.json 的版本號,再重新發布即可。