npm 常用命令詳解

npm是什么

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

npm install 安裝模塊

基礎(chǔ)語法

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]

安裝包，默認(rèn)會(huì)安裝最新的版本

npm install gulp

安裝指定版本

npm install gulp@3.9.1

安裝包并將信息保持到項(xiàng)目的package.json文件中

項(xiàng)目對(duì)模塊的依賴可以使用下面的 3 種方法來表示（假設(shè)當(dāng)前版本號(hào)是 1.1.0 ）：

• 兼容模塊新發(fā)布的補(bǔ)丁版本：~1.1.0、1.1.x、1.1

• 兼容模塊新發(fā)布的小版本、補(bǔ)丁版本：^1.1.0、1.x、1

• 兼容模塊新發(fā)布的大版本、小版本、補(bǔ)丁版本：*、x

-S, --save 安裝包信息將加入到dependencies（生產(chǎn)階段的依賴）

npm install gulp --save 或 npm install gulp -S

package.json 文件的 dependencies 字段：

"dependencies": {
    "gulp": "^3.9.1"}

-D, --save-dev 安裝包信息將加入到devDependencies（開發(fā)階段的依賴），所以開發(fā)階段一般使用它

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 字段，以看出版本號(hào)中的^消失了

"dependencies": {
    "gulp": "3.9.1"}

模塊的依賴都被寫入了package.json文件后，他人打開項(xiàng)目的根目錄（項(xiàng)目開源、內(nèi)部團(tuán)隊(duì)合作），使用npm install命令可以根據(jù)dependencies配置安裝所有的依賴包

npm install

本地安裝（local）

npm install gulp

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

npm install gulp -g

npm uninstall 卸載模塊 

基礎(chǔ)語法

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

aliases: remove, rm, r, un, unlink

如卸載開發(fā)版本的模塊

npm uninstall gulp --save-dev

npm update 更新模塊

基礎(chǔ)語法

npm update [-g] [<pkg>...]

npm outdated 檢查模塊是否已經(jīng)過時(shí)

基礎(chǔ)語法

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

此命令會(huì)列出所有已經(jīng)過時(shí)的包，可以及時(shí)進(jìn)行包的更新

npm ls 查看安裝的模塊

基礎(chǔ)語法

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

aliases: list, la, ll

查看全局安裝的模塊及依賴 

npm ls -g

npm init 在項(xiàng)目中引導(dǎo)創(chuàng)建一個(gè)package.json文件

安裝包的信息可保持到項(xiàng)目的package.json文件中，以便后續(xù)的其它的項(xiàng)目開發(fā)或者他人合作使用，也說package.json在項(xiàng)目中是必不可少的。

npm init [-f|--force|-y|--yes]

npm help 查看某條命令的詳細(xì)幫助 

基礎(chǔ)語法

npm help <term> [<terms..>]

例如輸入npm help install，系統(tǒng)在默認(rèn)的瀏覽器或者默認(rèn)的編輯器中打開本地nodejs安裝包的文件/nodejs/node_modules/npm/html/doc/cli/npm-install.html

npm help install

npm root 查看包的安裝路徑

輸出 node_modules的路徑

npm root [-g]

npm config 管理npm的配置路徑

基礎(chǔ)語法

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]

對(duì)于config這塊用得最多應(yīng)該是設(shè)置代理，解決npm安裝一些模塊失敗的問題

例如我在公司內(nèi)網(wǎng)，因?yàn)楣镜姆阑饓υ颍瑹o法完成任何模塊的安裝，這個(gè)時(shí)候設(shè)置代理可以解決

npm config set proxy=http://dev-proxy.oa.com:8080

又如國內(nèi)的網(wǎng)絡(luò)環(huán)境問題，某官方的IP可能被和諧了，幸好國內(nèi)有好心人，搭建了鏡像，此時(shí)我們簡單設(shè)置鏡像

npm config set registry="http://r.cnpmjs.org"

也可以臨時(shí)配置，如安裝淘寶鏡像

npm install -g cnpm --registry=https://registry.npm.taobao.org

npm cache 管理模塊的緩存

基礎(chǔ)語法

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 啟動(dòng)模塊

基礎(chǔ)語法

npm start [-- <args>]

該命令寫在package.json文件scripts的start字段中，可以自定義命令來配置一個(gè)服務(wù)器環(huán)境和安裝一系列的必要程序，如

"scripts": {    "start": "gulp -ws"}

此時(shí)在cmd中輸入npm start命令相當(dāng)于執(zhí)行g(shù)ulpfile.js文件自定義的watch和server命令。

如果package.json文件沒有設(shè)置start，則將直接啟動(dòng)node server.js

npm stop 停止模塊

基礎(chǔ)語法

npm stop [-- <args>]

npm restart 重新啟動(dòng)模塊

基礎(chǔ)語法

npm restart [-- <args>]

npm test 測(cè)試模塊

基礎(chǔ)語法

npm test [-- <args>]
npm tst [-- <args>]

該命令寫在package.json文件scripts的test字段中，可以自定義該命令來執(zhí)行一些操作，如

"scripts": {    "test": "gulp release"},

此時(shí)在cmd中輸入npm test命令相當(dāng)于執(zhí)行g(shù)ulpfile.js文件自定義的release命令。

npm version 查看模塊版本

基礎(chǔ)語法

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 查看模塊的注冊(cè)信息

基礎(chǔ)語法

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

aliases: info, show, v

查看模塊的依賴關(guān)系

npm view gulp dependencies

查看模塊的源文件地址

npm view gulp repository.url

查看模塊的貢獻(xiàn)者，包含郵箱地址

npm view npm contributors

npm adduser 用戶登錄

基礎(chǔ)語法

npm adduser [--registry=url] [--scope=@orgname] [--always-auth]

發(fā)布模板到npm社區(qū)前需要先登錄，然后再進(jìn)入發(fā)布的操作

npm publish 發(fā)布模塊

基礎(chǔ)語法

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

Publishes '.' if no argument supplied
Sets tag 'latest' if no --tag specified

npm access 在發(fā)布的包上設(shè)置訪問級(jí)別

基礎(chǔ)語法

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的語法

英文原版：https://docs.npmjs.com/files/package.json

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

默認(rèn)值

npm會(huì)根據(jù)包內(nèi)容設(shè)置一些默認(rèn)值。

• "scripts": {"start": "node server.js"}

  如果包的根目錄有server.js文件，npm會(huì)默認(rèn)將start命令設(shè)置為node server.js。

• "scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}

  如果包的根目錄有wscript文件，npm會(huì)默認(rèn)將preinstall命令用node-waf進(jìn)行編譯。

• "scripts":{"preinstall": "node-gyp rebuild"}

  如果包的根目錄有binding.gyp文件，npm會(huì)默認(rèn)將preinstall命令用node-gyp進(jìn)行編譯。

• "contributors": [...]

  如果包的根目錄有AUTHORS文件，npm會(huì)默認(rèn)逐行按Name <email> (url)格式處理，郵箱和url是可選的。#號(hào)和空格開頭的行會(huì)被忽略。

name

在package.json中最重要的就是name和version字段。他們都是必須的，如果沒有就無法install。name和version一起組成的標(biāo)識(shí)在假設(shè)中是唯一的。改變包應(yīng)該同時(shí)改變version。

name是這個(gè)東西的名字。注意：

• 不要把node或者js放在名字中。因?yàn)槟銓懥藀ackage.json它就被假定成為了js，不過你可以用"engine"字段指定一個(gè)引擎（見后文）。

• 這個(gè)名字會(huì)作為在URL的一部分、命令行的參數(shù)或者文件夾的名字。任何non-url-safe的字符都是不能用的。

• 這個(gè)名字可能會(huì)作為參數(shù)被傳入require()，所以它應(yīng)該比較短，但也要意義清晰。

• 在你愛上你的名字之前，你可能要去npm registry查看一下這個(gè)名字是否已經(jīng)被使用了。http://registry.npmjs.org/

version

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

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

description

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

keywords

關(guān)鍵字，數(shù)組、字符串，方便在npm search中搜索

bugs

你項(xiàng)目的提交問題的url和（或）郵件地址

{ "url" : "http://github.com/owner/project/issues", 
"email" : "project@hostname.com"}

license

你應(yīng)該要指定一個(gè)許可證，讓人知道使用的權(quán)利和限制的。

最簡單的方法是，假如你用一個(gè)像BSD或者M(jìn)IT這樣通用的許可證，就只需要指定一個(gè)許可證的名字，像這樣：

{ "license" : "BSD" }

如果你又更復(fù)雜的許可條件，或者想要提供給更多地細(xì)節(jié)，可以這樣:

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

repository

指定你的代碼存放的地方。這個(gè)對(duì)希望貢獻(xiàn)的人有幫助。如果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應(yīng)該是公開的（即便是只讀的）能直接被未經(jīng)過修改的版本控制程序處理的url。不應(yīng)該是一個(gè)html的項(xiàng)目頁面。因?yàn)樗墙o計(jì)算機(jī)看的。

scripts

“scripts”是一個(gè)由腳本命令組成的hash對(duì)象，他們?cè)诎煌纳芷谥斜粓?zhí)行。key是生命周期事件，value是要運(yùn)行的命令。

config

"config" hash可以用來配置用于包腳本中的跨版本參數(shù)。在實(shí)例中，如果一個(gè)包有下面的配置：

{ "name" : "foo", "config" : { "port" : "8080" } 
}

然后有一個(gè)“start”命令引用了npm_package_config_port環(huán)境變量，用戶可以通過npm config set foo:port 8001來重寫他。

dependencies

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

請(qǐng)不要將測(cè)試或過渡性的依賴放在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

如果有人要使用你的模塊，那么他們可能不需要你開發(fā)使用的外部測(cè)試或者文檔框架。

在這種情況下，最好將這些附屬的項(xiàng)目列在devDependencies中。

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

對(duì)于非特定平臺(tái)的構(gòu)建步驟，比如需要編譯CoffeeScript，可以用prepublish腳本去實(shí)現(xiàn)，并把它依賴的包放在devDependency中。（譯者注：prepublish定義了在執(zhí)行npm publish的時(shí)候先行執(zhí)行的腳本）

比如：

{ "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"}

prepublish腳本會(huì)在publishing前運(yùn)行，這樣用戶就不用自己去require來編譯就能使用。并且在開發(fā)模式中（比如本地運(yùn)行npm install）會(huì)運(yùn)行這個(gè)腳本以便更好地測(cè)試。