如何使用npm管理NodeJS包
前一段時(shí)間,我們發(fā)布了一個(gè)使用 pip 管理 Python 包的指南。今天,我們將討論如何使用 npm 管理 NodeJS 包。npm 是最大的軟件注冊(cè)中心,包含 600,000 多個(gè)包。每天,世界各地的開(kāi)發(fā)人員通過(guò) npm 共享和下載軟件包。在本指南中,我將解釋使用 npm 基礎(chǔ)知識(shí),例如安裝包(本地和全局)、安裝特定版本的包、更新、刪除和管理 NodeJS 包等等。
安裝 npm
用于 npm 是用 NodeJS 編寫的,我們需要安裝 NodeJS 才能使用 npm。要在不同的 Linux 發(fā)行版上安裝 NodeJS,請(qǐng)參考下面的鏈接。
檢查 node 安裝的位置:
$ which node
/home/sk/.nvm/versions/node/v9.4.0/bin/node
檢查它的版本:
$ node -v
v9.4.0
進(jìn)入 Node 交互式解釋器:
$ node
> .help
.break Sometimes you get stuck, this gets you out
.clear Alias for .break
.editor Enter editor mode
.exit Exit the repl
.help Print this help message
.load Load JS from a file into the REPL session
.save Save all evaluated commands in this REPL session to a file
> .exit
檢查 npm 安裝的位置:
$ which npm
/home/sk/.nvm/versions/node/v9.4.0/bin/npm
還有版本:
$ npm -v
5.6.0
棒極了!Node 和 npm 已安裝好!正如你可能已經(jīng)注意到,我已經(jīng)在我的 $HOME
目錄中安裝了 NodeJS 和 NPM,這樣是為了避免在全局模塊時(shí)出現(xiàn)權(quán)限問(wèn)題。這是 NodeJS 團(tuán)隊(duì)推薦的方法。
那么,讓我們繼續(xù)看看如何使用 npm 管理 NodeJS 模塊(或包)。
安裝 NodeJS 模塊
NodeJS 模塊可以安裝在本地或全局(系統(tǒng)范圍)。現(xiàn)在我將演示如何在本地安裝包(LCTT 譯注:即將包安裝到一個(gè) NodeJS 項(xiàng)目當(dāng)中,所以下面會(huì)先創(chuàng)建一個(gè)空項(xiàng)目做演示)。
在本地安裝包
為了在本地管理包,我們通常使用 package.json
文件來(lái)管理。
首先,讓我們創(chuàng)建我們的項(xiàng)目目錄。
$ mkdir demo
$ cd demo
在項(xiàng)目目錄中創(chuàng)建一個(gè) package.json
文件。為此,運(yùn)行:
$ npm init
輸入你的包的詳細(xì)信息,例如名稱、版本、作者、GitHub 頁(yè)面等等,或者按下回車鍵接受默認(rèn)值并鍵入 yes
確認(rèn)。
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.
See `npm help json` for definitive documentation on these fields
and exactly what they do.
Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.
Press ^C at any time to quit.
package name: (demo)
version: (1.0.0)
description: demo nodejs app
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /home/sk/demo/package.json:
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Is this ok? (yes) yes
上面的命令初始化你的項(xiàng)目并創(chuàng)建了 package.json
文件。
你也可以使用命令以非交互式方式執(zhí)行此操作:
npm init --y
現(xiàn)在讓我們安裝名為 commander 的包。
$ npm install commander
示例輸出:
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN demo@1.0.0 No repository field.
+ commander@2.13.0
added 1 package in 2.519s
這將在項(xiàng)目的根目錄中創(chuàng)建一個(gè)名為 node_modules
的目錄(如果它不存在的話),并在其中下載包。
讓我們檢查 pachage.json
文件。
$ cat package.json
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"commander": "^2.13.0"
}
}
你會(huì)看到添加了依賴文件,版本號(hào)前面的插入符號(hào) ( ^
) 表示在安裝時(shí),npm 將取出它可以找到的最高版本的包。
$ ls node_modules/
commander
package.json
文件的優(yōu)點(diǎn)是,如果你的項(xiàng)目目錄中有 package.json
文件,只需鍵入 npm install
,那么 npm
將查看文件中列出的依賴關(guān)系并下載它們。你甚至可以與其他開(kāi)發(fā)人員共享它或?qū)⑵渫扑偷侥愕?GitHub 倉(cāng)庫(kù)。因此,當(dāng)他們鍵入 npm install
時(shí),他們將獲得你擁有的所有相同的包。
你也可能會(huì)注意到另一個(gè)名為 package-lock.json
的文件,該文件確保在項(xiàng)目安裝的所有系統(tǒng)上都保持相同的依賴關(guān)系。
要在你的程序中使用已安裝的包,使用實(shí)際代碼在項(xiàng)目目錄中創(chuàng)建一個(gè) index.js
(或者其他任何名稱)文件,然后使用以下命令運(yùn)行它:
$ node index.js
在全局安裝包
如果你想使用一個(gè)包作為命令行工具,那么最好在全局安裝它。這樣,無(wú)論你的當(dāng)前目錄是哪個(gè)目錄,它都能正常工作。
$ npm install async -g
+ async@2.6.0
added 2 packages in 4.695s
或者
$ npm install async --global
要安裝特定版本的包,我們可以:
$ npm install async@2.6.0 --global
更新 NodeJS 模塊
要更新本地包,轉(zhuǎn)到 package.json
所在的項(xiàng)目目錄并運(yùn)行:
$ npm update
然后,運(yùn)行以下命令確保所有包都更新了。
$ npm outdated
如果沒(méi)有需要更新的,那么它返回空。
要找出哪一個(gè)全局包需要更新,運(yùn)行:
$ npm outdated -g --depth=0
如果沒(méi)有輸出,意味著所有包都已更新。
更新單個(gè)全局包,運(yùn)行:
$ npm update -g <package-name>
更新所有的全局包,運(yùn)行:
$ npm update -g
列出 NodeJS 模塊
列出本地包,轉(zhuǎn)到項(xiàng)目目錄并運(yùn)行:
$ npm list
demo@1.0.0 /home/sk/demo
└── commander@2.13.0
如你所見(jiàn),我在本地安裝了 commander
這個(gè)包。
要列出全局包,從任何位置都可以運(yùn)行以下命令:
$ npm list -g
示例輸出:
/home/sk/.nvm/versions/node/v9.4.0/lib
├─┬ async@2.6.0
│ └── lodash@4.17.4
└─┬ npm@5.6.0
├── abbrev@1.1.1
├── ansi-regex@3.0.0
├── ansicolors@0.3.2
├── ansistyles@0.1.3
├── aproba@1.2.0
├── archy@1.0.0
[...]
該命令將列出所有模塊及其依賴關(guān)系。
要僅僅列出頂級(jí)模塊,使用 -depth=0
選項(xiàng):
$ npm list -g --depth=0
/home/sk/.nvm/versions/node/v9.4.0/lib
├── async@2.6.0
└── npm@5.6.0
尋找 NodeJS 模塊
要搜索一個(gè)模塊,使用 npm search
命令:
npm search <search-string>
例如:
$ npm search request
該命令將顯示包含搜索字符串 request
的所有模塊。
移除 NodeJS 模塊
要?jiǎng)h除本地包,轉(zhuǎn)到項(xiàng)目目錄并運(yùn)行以下命令,這會(huì)從 node_modules
目錄中刪除包:
$ npm uninstall <package-name>
要從 package.json
文件中的依賴關(guān)系中刪除它,使用如下所示的 save
選項(xiàng):
$ npm uninstall --save <package-name>
要?jiǎng)h除已安裝的全局包,運(yùn)行:
$ npm uninstall -g <package>
清除 npm 緩存
默認(rèn)情況下,npm 在安裝包時(shí),會(huì)將其副本保存在 $HOME
目錄中名為 .npm
的緩存文件夾中。所以,你可以在下次安裝時(shí)不必再次下載。
查看緩存模塊:
$ ls ~/.npm
隨著時(shí)間的推移,緩存文件夾會(huì)充斥著大量舊的包。所以不時(shí)清理緩存會(huì)好一些。
從 npm@5 開(kāi)始,npm 緩存可以從 corruption 問(wèn)題中自行修復(fù),并且保證從緩存中提取的數(shù)據(jù)有效。如果你想確保一切都一致,運(yùn)行:
$ npm cache verify
清除整個(gè)緩存,運(yùn)行:
$ npm cache clean --force
查看 npm 配置
要查看 npm 配置,鍵入:
$ npm config list
或者:
$ npm config ls
示例輸出:
; cli configs
metrics-registry = "https://registry.npmjs.org/"
scope = ""
user-agent = "npm/5.6.0 node/v9.4.0 linux x64"
; node bin location = /home/sk/.nvm/versions/node/v9.4.0/bin/node
; cwd = /home/sk
; HOME = /home/sk
; "npm config ls -l" to show all defaults.
要顯示當(dāng)前的全局位置:
$ npm config get prefix
/home/sk/.nvm/versions/node/v9.4.0
好吧,這就是全部了。我們剛才介紹的只是基礎(chǔ)知識(shí),npm 是一個(gè)廣泛話題。有關(guān)更多詳細(xì)信息,參閱 NPM Getting Started 指南。