npm 常用命令詳解

ben0發表於2018-02-07

NPM

本文以Windows平臺上做測試，以gulp為示例做教程，出自作者白樹，轉載請宣告！

npm是什麼
npm install 安裝模組
npm uninstall 解除安裝模組
npm update 更新模組
npm outdated 檢查模組是否已經過時
npm ls 檢視安裝的模組
npm init 在專案中引導建立一個package.json檔案
npm help 檢視某條命令的詳細幫助
npm root 檢視包的安裝路徑
npm config 管理npm的配置路徑
npm cache 管理模組的快取
npm start 啟動模組
npm stop 停止模組
npm restart 重新啟動模組
npm test 測試模組
npm version 檢視模組版本
npm view 檢視模組的註冊資訊
npm adduser 使用者登入
npm publish 釋出模組
npm access 在釋出的包上設定訪問級別
npm package.json的語法

npm是什麼

NPM的全稱是Node Package Manager，是隨同NodeJS一起安裝的包管理和分發工具，它很方便讓JavaScript開發者下載、安裝、上傳以及管理已經安裝的包。

npm install 安裝模組

基礎語法

npm install (with no args, in package dir)
npm install [<@scope>/]<name>
npm install [<@scope>/]<name>@<tag>
npm install [<@scope>/]<name>@<version>
npm install [<@scope>/]<name>@<version range>
npm install <tarball file>
npm install <tarball url>
npm install <folder>

alias: npm i
common options: [-S|--save|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [--dry-run]複製程式碼

安裝包，預設會安裝最新的版本

npm install gulp複製程式碼

安裝指定版本

npm install gulp@3.9.1複製程式碼

安裝包並將資訊保持到專案的package.json檔案中

專案對模組的依賴可以使用下面的 3 種方法來表示（假設當前版本號是 1.1.0 ）：

相容模組新發布的補丁版本：~1.1.0、1.1.x、1.1
相容模組新發布的小版本、補丁版本：^1.1.0、1.x、1
相容模組新發布的大版本、小版本、補丁版本：*、x

-S, --save 安裝包資訊將加入到dependencies（生產階段的依賴）

npm install gulp --save 或 npm install gulp -S複製程式碼

package.json 檔案的 dependencies 欄位：

"dependencies": {
    "gulp": "^3.9.1"
}複製程式碼

-D, --save-dev 安裝包資訊將加入到devDependencies（開發階段的依賴），所以開發階段一般使用它

npm install gulp --save-dev 或 npm install gulp -D複製程式碼

package.json 檔案的 devDependencies欄位：

"devDependencies": {
    "gulp": "^3.9.1"
}複製程式碼

-O, --save-optional 安裝包資訊將加入到optionalDependencies（可選階段的依賴）

npm install gulp --save-optional 或 npm install gulp -O複製程式碼

package.json 檔案的optionalDependencies欄位：

"optionalDependencies": {
    "gulp": "^3.9.1"
}複製程式碼

-E, --save-exact 精確安裝指定模組版本

npm install gulp --save-exact 或 npm install gulp -E複製程式碼

輸入命令npm install gulp -ES，留意package.json 檔案的 dependencies 欄位，以看出版本號中的^消失了

"dependencies": {
    "gulp": "3.9.1"
}複製程式碼

模組的依賴都被寫入了package.json檔案後，他人開啟專案的根目錄（專案開源、內部團隊合作），使用npm install命令可以根據dependencies配置安裝所有的依賴包

npm install複製程式碼

本地安裝（local）

npm install gulp複製程式碼

全域性安裝（global）,使用 -g 或 --global

npm install gulp -g複製程式碼

npm uninstall 解除安裝模組

基礎語法

npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional]

aliases: remove, rm, r, un, unlink複製程式碼

如解除安裝開發版本的模組

npm uninstall gulp --save-dev複製程式碼

npm update 更新模組

基礎語法

npm update [-g] [<pkg>...]複製程式碼

npm outdated 檢查模組是否已經過時

基礎語法

npm outdated [[<@scope>/]<pkg> ...]複製程式碼

此命令會列出所有已經過時的包，可以及時進行包的更新

npm ls 檢視安裝的模組

基礎語法

npm ls [[<@scope>/]<pkg> ...]

aliases: list, la, ll複製程式碼

檢視全域性安裝的模組及依賴

npm ls -g 複製程式碼

npm init 在專案中引導建立一個package.json檔案

安裝包的資訊可保持到專案的package.json檔案中，以便後續的其它的專案開發或者他人合作使用，也說package.json在專案中是必不可少的。

npm init [-f|--force|-y|--yes]複製程式碼

npm help 檢視某條命令的詳細幫助

基礎語法

npm help <term> [<terms..>]複製程式碼

例如輸入npm help install，系統在預設的瀏覽器或者預設的編輯器中開啟本地nodejs安裝包的檔案/nodejs/node_modules/npm/html/doc/cli/npm-install.html

npm help install複製程式碼

npm root 檢視包的安裝路徑

輸出 node_modules的路徑

npm root [-g]複製程式碼

npm config 管理npm的配置路徑

基礎語法

npm config set <key> <value> [-g|--global]
npm config get <key>
npm config delete <key>
npm config list
npm config edit
npm get <key>
npm set <key> <value> [-g|--global]複製程式碼

對於config這塊用得最多應該是設定代理，解決npm安裝一些模組失敗的問題

例如我在公司內網，因為公司的防火牆原因，無法完成任何模組的安裝，這個時候設定代理可以解決

npm config set proxy=http://dev-proxy.oa.com:8080複製程式碼

又如國內的網路環境問題，某官方的IP可能被和諧了，幸好國內有好心人，搭建了映象，此時我們簡單設定映象

npm config set registry="http://r.cnpmjs.org"複製程式碼

也可以臨時配置，如安裝淘寶映象

npm install -g cnpm --registry=https://registry.npm.taobao.org複製程式碼

npm cache 管理模組的快取

基礎語法

npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <name>@<version>

npm cache ls [<path>]

npm cache clean [<path>]複製程式碼

最常用命令無非清除npm本地快取

npm cache clean複製程式碼

npm start 啟動模組

基礎語法

npm start [-- <args>]複製程式碼

該命令寫在package.json檔案scripts的start欄位中，可以自定義命令來配置一個伺服器環境和安裝一系列的必要程式，如

"scripts": {
    "start": "gulp -ws"
}複製程式碼

此時在cmd中輸入npm start命令相當於執行gulpfile.js檔案自定義的watch和server命令。

如果package.json檔案沒有設定start，則將直接啟動node server.js

npm stop 停止模組

基礎語法

npm stop [-- <args>]複製程式碼

npm restart 重新啟動模組

基礎語法

npm restart [-- <args>]複製程式碼

npm test 測試模組

基礎語法

npm test [-- <args>]
npm tst [-- <args>]複製程式碼

該命令寫在package.json檔案scripts的test欄位中，可以自定義該命令來執行一些操作，如

"scripts": {
    "test": "gulp release"
},複製程式碼

此時在cmd中輸入npm test命令相當於執行gulpfile.js檔案自定義的release命令。

npm version 檢視模組版本

基礎語法

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]

'npm [-v | --version]' to print npm version
'npm view <pkg> version' to view a package's published version
'npm ls' to inspect current package/dependency versions複製程式碼

檢視模組的版本

npm version複製程式碼

npm view 檢視模組的註冊資訊

基礎語法

npm view [<@scope>/]<name>[@<version>] [<field>[.<subfield>]...]

aliases: info, show, v複製程式碼

檢視模組的依賴關係

npm view gulp dependencies複製程式碼

檢視模組的原始檔地址

npm view gulp repository.url複製程式碼

檢視模組的貢獻者，包含郵箱地址

npm view npm contributors複製程式碼

npm adduser 使用者登入

基礎語法

npm adduser [--registry=url] [--scope=@orgname] [--always-auth]複製程式碼

釋出模板到npm社群前需要先登入，然後再進入釋出的操作

npm publish 釋出模組

基礎語法

npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]

Publishes '.' if no argument supplied
Sets tag 'latest' if no --tag specified複製程式碼

npm access 在釋出的包上設定訪問級別

基礎語法

npm access public [<package>]
npm access restricted [<package>]

npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]

npm access ls-packages [<user>|<scope>|<scope:team>]
npm access ls-collaborators [<package> [<user>]]
npm access edit [<package>]複製程式碼

npm package.json的語法

英文原版：docs.npmjs.com/files/packa…

這塊內容好多，國內有好心人整理：《npm的package.json中文文件》，從這份文件拷貝出一些比較常見的，如下：

預設值

npm會根據包內容設定一些預設值。

"scripts": {"start": "node server.js"}
如果包的根目錄有server.js檔案，npm會預設將start命令設定為node server.js。
"scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}
如果包的根目錄有wscript檔案，npm會預設將preinstall命令用node-waf進行編譯。
"scripts":{"preinstall": "node-gyp rebuild"}
如果包的根目錄有binding.gyp檔案，npm會預設將preinstall命令用node-gyp進行編譯。
"contributors": [...]
如果包的根目錄有AUTHORS檔案，npm會預設逐行按Name <email> (url)格式處理，郵箱和url是可選的。#號和空格開頭的行會被忽略。

name

在package.json中最重要的就是name和version欄位。他們都是必須的，如果沒有就無法install。name和version一起組成的標識在假設中是唯一的。改變包應該同時改變version。

name是這個東西的名字。注意：

不要把node或者js放在名字中。因為你寫了package.json它就被假定成為了js，不過你可以用"engine"欄位指定一個引擎（見後文）。
這個名字會作為在URL的一部分、命令列的引數或者資料夾的名字。任何non-url-safe的字元都是不能用的。
這個名字可能會作為引數被傳入require()，所以它應該比較短，但也要意義清晰。
在你愛上你的名字之前，你可能要去npm registry檢視一下這個名字是否已經被使用了。registry.npmjs.org/

version

version必須能被node-semver解析，它被包在npm的依賴中。（要自己用可以執行npm install semver）

可用的“數字”或者“範圍”見semver(7).

description

放簡介，字串，方便在npm search中搜尋

keywords

關鍵字，陣列、字串，方便在npm search中搜尋

bugs

你專案的提交問題的url和（或）郵件地址

{
 "url" : "http://github.com/owner/project/issues", 
"email" : "project@hostname.com"
}複製程式碼

license

你應該要指定一個許可證，讓人知道使用的權利和限制的。

最簡單的方法是，假如你用一個像BSD或者MIT這樣通用的許可證，就只需要指定一個許可證的名字，像這樣：

{ "license" : "BSD" }複製程式碼

如果你又更復雜的許可條件，或者想要提供給更多地細節，可以這樣:

"licenses" : [
  { "type" : "MyLicense"
  , "url" : "http://github.com/owner/project/path/to/license"
  }
]複製程式碼

repository

指定你的程式碼存放的地方。這個對希望貢獻的人有幫助。如果git倉庫在github上，那麼npm docs命令能找到你。

這樣做：

"repository" :
  { "type" : "git"
  , "url" : "http://github.com/isaacs/npm.git"
  }

"repository" :
  { "type" : "svn"
  , "url" : "http://v8.googlecode.com/svn/trunk/"
  }複製程式碼

URL應該是公開的（即便是隻讀的）能直接被未經過修改的版本控制程式處理的url。不應該是一個html的專案頁面。因為它是給計算機看的。

scripts

“scripts”是一個由指令碼命令組成的hash物件，他們在包不同的生命週期中被執行。key是生命週期事件，value是要執行的命令。

參考上面的npm start、npm test命令

更多詳細請看 npm-scripts(7)

config

"config" hash可以用來配置用於包指令碼中的跨版本引數。在例項中，如果一個包有下面的配置：

{
 "name" : "foo",
 "config" : { "port" : "8080" } 
}複製程式碼

然後有一個“start”命令引用了npm_package_config_port環境變數，使用者可以通過npm config set foo:port 8001來重寫他。

參見 npm-config(7) 和 npm-scripts(7)。

dependencies

依賴是給一組包名指定版本範圍的一個hash。這個版本範圍是一個由一個或多個空格分隔的字串。依賴還可以用tarball或者git URL。

請不要將測試或過渡性的依賴放在dependencieshash中。見下文的devDependencies

詳見semver(7).

version 必須完全和version一致
>version 必須比version大
>=version 同上
<version 同上
<=version 同上
~version 大約一樣，見semver(7)
1.2.x 1.2.0, 1.2.1, 等，但不包括1.3.0
http://... 見下文'依賴URL'
* 所有
"" 空，同*
version1 - version2 同 >=version1 <=version2.
range1 || range2 二選一。
git... 見下文'依賴Git URL'
user/repo 見下文'GitHub URLs'

比如下面都是合法的：

{ "dependencies" :
  { "foo" : "1.0.0 - 2.9999.9999"
  , "bar" : ">=1.0.2 <2.1.2"
  , "baz" : ">1.0.2 <=2.3.4"
  , "boo" : "2.0.1"
  , "qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0"
  , "asd" : "http://asdf.com/asdf.tar.gz"
  , "til" : "~1.2"
  , "elf" : "~1.2.3"
  , "two" : "2.x"
  , "thr" : "3.3.x"
  }
}複製程式碼

devDependencies

如果有人要使用你的模組，那麼他們可能不需要你開發使用的外部測試或者文件框架。

在這種情況下，最好將這些附屬的專案列在devDependencies中。

這些東西會在執行npm link或者npm install的時候初始化，並可以像其他npm配置引數一樣管理。詳見npm-config(7)。

對於非特定平臺的構建步驟，比如需要編譯CoffeeScript，可以用prepublish指令碼去實現，並把它依賴的包放在devDependency中。（譯者注：prepublish定義了在執行npm publish的時候先行執行的指令碼）

比如：

{ "name": "ethopia-waza",
  "description": "a delightfully fruity coffee varietal",
  "version": "1.2.3",
  "devDependencies": {
    "coffee-script": "~1.6.3"
  },
  "scripts": {
    "prepublish": "coffee -o lib/ -c src/waza.coffee"
  },
  "main": "lib/waza.js"
}複製程式碼