查看“Node.js：NPM”的源代码

[[category:Node.js教程]]

== 关于 ==
NPM 是随同 NodeJS 一起安装的'''包管理工具'''，能解决 NodeJS 代码部署上的很多问题，常见的使用场景有以下几种：
* 允许用户从 NPM 服务器下载别人编写的第三方包到本地使用。
* 允许用户从 NPM 服务器下载并安装别人编写的命令行程序到本地使用。
* 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

=== 安装 ===
由于新版的 nodejs 已经集成了 npm，所以安装 nodejs 时 npm 也一并安装好了。

可以通过输入 '''npm -v''' 来测试是否成功安装。命令如下，出现版本提示表示安装成功:
<syntaxhighlight lang="bash" highlight="">
$ npm -v
2.3.0
</syntaxhighlight>

=== 升级 ===
如果你安装的是旧版本的 npm，可以很容易得通过 npm 命令来升级，命令如下：
<syntaxhighlight lang="bash" highlight="">
$ sudo npm install npm -g
/usr/local/bin/npm -> /usr/local/lib/node_modules/npm/bin/npm-cli.js
npm@2.14.2 /usr/local/lib/node_modules/npm
</syntaxhighlight>

* 如果是 Window 系统使用以下命令即可：
*: <syntaxhighlight lang="bash" highlight="">
npm install npm -g
</syntaxhighlight>

* 使用淘宝镜像的命令：
*: <syntaxhighlight lang="bash" highlight="">
npm install -g cnpm --registry=https://registry.npm.taobao.org
</syntaxhighlight>

== 使用 npm ==

=== 安装模块 ===
npm 安装 Node.js 模块语法格式如下：
'''<syntaxhighlight lang="bash" highlight="">
$ npm install <Module Name>
</syntaxhighlight>'''


'''示例：'''
: 使用 npm 命令安装常用的 Node.js web框架模块 express：
: <syntaxhighlight lang="bash" highlight="">
$ npm install express
</syntaxhighlight>
: 安装好之后，express 包就放在了工程目录下的 '''node_modules''' 目录中，因此在代码中只需要通过 '''require('express')''' 的方式就好，无需指定第三方包路径：
: <syntaxhighlight lang="JavaScript" highlight="">
var express = require('express');
</syntaxhighlight>


npm 的包安装分为'''本地安装'''（local）、'''全局安装'''（global）两种，其命令行的差别只在于 '''-g''' 命令选项，比如：
<syntaxhighlight lang="bash" highlight="">
npm install express          # 本地安装
npm install express -g   # 全局安装
</syntaxhighlight>
* 如果出现以下错误：【？？？】
*: <syntaxhighlight lang="bash" highlight="">
npm err! Error: connect ECONNREFUSED 127.0.0.1:8087 
</syntaxhighlight>
*: 解决办法为：
*: <syntaxhighlight lang="bash" highlight="">
$ npm config set proxy null
</syntaxhighlight>

==== 本地安装 ====
# 将安装包放在 '''./node_modules''' 下（运行 npm 命令时所在的目录）；
#* 如果没有 node_modules 目录，会在当前执行 npm 命令的目录下生成 node_modules 目录。
# 可以通过 '''require()''' 来引入本地安装的包。

==== 全局安装 ====
# 将安装包放在 '''/usr/local''' 下或者你 '''node 的安装目录'''。
# 可以直接在'''命令行'''里使用。

==== 本地 & 全局安装 ====
如果你希望具备两者功能，则需要在两个地方安装它或使用 '''npm link'''。【？？？】


'''示例：'''
: 使用全局方式安装 express：
: <syntaxhighlight lang="bash" highlight="">
$ npm install express -g
</syntaxhighlight>
:* '''安装过程输出如下内容，第一行输出了模块的版本号及安装位置'''：
: <syntaxhighlight lang="bash" highlight="">
express@4.13.3 node_modules/express
├── escape-html@1.0.2
├── range-parser@1.0.2
├── merge-descriptors@1.0.0
├── array-flatten@1.1.1
├── cookie@0.1.3
├── utils-merge@1.0.0
├── parseurl@1.3.0
├── cookie-signature@1.0.6
├── methods@1.1.1
├── fresh@0.3.0
├── vary@1.0.1
├── path-to-regexp@0.1.7
├── content-type@1.0.1
├── etag@1.7.0
├── serve-static@1.10.0
├── content-disposition@0.5.0
├── depd@1.0.1
├── qs@4.0.0
├── finalhandler@0.4.0 (unpipe@1.0.0)
├── on-finished@2.3.0 (ee-first@1.1.1)
├── proxy-addr@1.0.8 (forwarded@0.1.0, ipaddr.js@1.0.1)
├── debug@2.2.0 (ms@0.7.1)
├── type-is@1.6.8 (media-typer@0.3.0, mime-types@2.1.6)
├── accepts@1.2.12 (negotiator@0.5.3, mime-types@2.1.6)
└── send@0.13.0 (destroy@1.0.3, statuses@1.2.1, ms@0.7.1, mime@1.3.4, http-errors@1.3.1)
</syntaxhighlight>

=== 查看安装信息 ===
* 可以使用以下命令来查看所有全局安装的模块：
*: <syntaxhighlight lang="bash" highlight="">
$ npm list -g

├─┬ cnpm@4.3.2
│ ├── auto-correct@1.0.0
│ ├── bagpipe@0.3.5
│ ├── colors@1.1.2
│ ├─┬ commander@2.9.0
│ │ └── graceful-readlink@1.0.1
│ ├─┬ cross-spawn@0.2.9
│ │ └── lru-cache@2.7.3
……
</syntaxhighlight>

* 如果要查看某个模块的版本号，可以使用命令如下：
*: <syntaxhighlight lang="bash" highlight="">
$ npm list grunt

projectName@projectVersion /path/to/project/folder
└── grunt@0.4.1
</syntaxhighlight>

=== 卸载模块 ===
可以使用以下命令来卸载 Node.js 模块。
<syntaxhighlight lang="bash" highlight="">
$ npm uninstall express
</syntaxhighlight>

验证卸载，两种方式：
# 可以到 /node_modules/ 目录下查看包是否还存在
# 使用以下命令查看：
#: <syntaxhighlight lang="bash" highlight="">
$ npm ls
</syntaxhighlight>

=== 更新模块 ===
可以使用以下命令更新模块：
<syntaxhighlight lang="bash" highlight="">
$ npm update express
</syntaxhighlight>

=== 搜索模块 ===
使用以下来搜索模块：
<syntaxhighlight lang="bash" highlight="">
$ npm search express
</syntaxhighlight>

=== 创建模块 ===
创建模块，'''package.json''' 文件是必不可少的。


步骤：
# 使用 '''npm init''' 命令来生成 package.json 文件（生成的文件包含了基本的结果）：
#: <syntaxhighlight lang="bash" highlight="">
$ npm init
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> --save` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
name: (node_modules) runoob                   # 模块名
version: (1.0.0) 
description: Node.js 测试模块(www.runoob.com)  # 描述
entry point: (index.js) 
test command: make test
git repository: https://github.com/runoob/runoob.git  # Github 地址
keywords: 
author: 
license: (ISC) 
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "runoob",
  "version": "1.0.0",
  "description": "Node.js 测试模块(www.runoob.com)",
  ……
}


Is this ok? (yes) yes
</syntaxhighlight>
#* 以上的信息，你需要根据你自己的情况输入。在最后输入 "yes" 后会生成 package.json 文件。
# 使用 '''npm adduser''' 命令在 npm 资源库中注册用户（使用邮箱注册）：
#: <syntaxhighlight lang="bash" highlight="">
$ npm adduser
Username: mcmohd
Password:
Email: (this IS public) mcmohd@gmail.com
</syntaxhighlight>
# 使用 '''npm publish''' 命令发布模块：
#: <syntaxhighlight lang="bash" highlight="">
$ npm publish
</syntaxhighlight>


步骤都操作完成，就可以跟其他模块一样使用 npm 来安装该模块。

== package.json ==
package.json 位于模块的目录下，用于'''定义包的属性'''。


'''示例：'''
: 查看下 express 包的 package.json 文件，位于 node_modules/express/package.json 内容：
: <syntaxhighlight lang="bash" highlight="">
{
  "name": "express",
  "description": "Fast, unopinionated, minimalist web framework",
  "version": "4.13.3",
  "author": {
    "name": "TJ Holowaychuk",
    "email": "tj@vision-media.ca"
  },
  "contributors": [
    {
      "name": "Aaron Heckmann",
      "email": "aaron.heckmann+github@gmail.com"
    },
    {
      "name": "Ciaran Jessup",
      "email": "ciaranj@gmail.com"
    },
    {
      "name": "Douglas Christopher Wilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "Guillermo Rauch",
      "email": "rauchg@gmail.com"
    },
    {
      "name": "Jonathan Ong",
      "email": "me@jongleberry.com"
    },
    {
      "name": "Roman Shtylman",
      "email": "shtylman+expressjs@gmail.com"
    },
    {
      "name": "Young Jae Sim",
      "email": "hanul@hanul.me"
    }
  ],
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/strongloop/express.git"
  },
  "homepage": "http://expressjs.com/",
  "keywords": [
    "express",
    "framework",
    "sinatra",
    "web",
    "rest",
    "restful",
    "router",
    "app",
    "api"
  ],
  "dependencies": {
    "accepts": "~1.2.12",
    "array-flatten": "1.1.1",
    "content-disposition": "0.5.0",
    "content-type": "~1.0.1",
    "cookie": "0.1.3",
    "cookie-signature": "1.0.6",
    "debug": "~2.2.0",
    "depd": "~1.0.1",
    "escape-html": "1.0.2",
    "etag": "~1.7.0",
    "finalhandler": "0.4.0",
    "fresh": "0.3.0",
    "merge-descriptors": "1.0.0",
    "methods": "~1.1.1",
    "on-finished": "~2.3.0",
    "parseurl": "~1.3.0",
    "path-to-regexp": "0.1.7",
    "proxy-addr": "~1.0.8",
    "qs": "4.0.0",
    "range-parser": "~1.0.2",
    "send": "0.13.0",
    "serve-static": "~1.10.0",
    "type-is": "~1.6.6",
    "utils-merge": "1.0.0",
    "vary": "~1.0.1"
  },
  "devDependencies": {
    "after": "0.8.1",
    "ejs": "2.3.3",
    "istanbul": "0.3.17",
    "marked": "0.3.5",
    "mocha": "2.2.5",
    "should": "7.0.2",
    "supertest": "1.0.1",
    "body-parser": "~1.13.3",
    "connect-redis": "~2.4.1",
    "cookie-parser": "~1.3.5",
    "cookie-session": "~1.2.0",
    "express-session": "~1.11.3",
    "jade": "~1.11.0",
    "method-override": "~2.3.5",
    "morgan": "~1.6.1",
    "multiparty": "~4.1.2",
    "vhost": "~3.0.1"
  },
  "engines": {
    "node": ">= 0.10.0"
  },
  "files": [
    "LICENSE",
    "History.md",
    "Readme.md",
    "index.js",
    "lib/"
  ],
  "scripts": {
    "test": "mocha --require test/support/env --reporter spec --bail --check-leaks test/ test/acceptance/",
    "test-ci": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --require test/support/env --reporter spec --check-leaks test/ test/acceptance/",
    "test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --require test/support/env --reporter dot --check-leaks test/ test/acceptance/",
    "test-tap": "mocha --require test/support/env --reporter tap --check-leaks test/ test/acceptance/"
  },
  "gitHead": "ef7ad681b245fba023843ce94f6bcb8e275bbb8e",
  "bugs": {
    "url": "https://github.com/strongloop/express/issues"
  },
  "_id": "express@4.13.3",
  "_shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
  "_from": "express@*",
  "_npmVersion": "1.4.28",
  "_npmUser": {
    "name": "dougwilson",
    "email": "doug@somethingdoug.com"
  },
  "maintainers": [
    {
      "name": "tjholowaychuk",
      "email": "tj@vision-media.ca"
    },
    {
      "name": "jongleberry",
      "email": "jonathanrichardong@gmail.com"
    },
    {
      "name": "dougwilson",
      "email": "doug@somethingdoug.com"
    },
    {
      "name": "rfeng",
      "email": "enjoyjava@gmail.com"
    },
    {
      "name": "aredridel",
      "email": "aredridel@dinhe.net"
    },
    {
      "name": "strongloop",
      "email": "callback@strongloop.com"
    },
    {
      "name": "defunctzombie",
      "email": "shtylman@gmail.com"
    }
  ],
  "dist": {
    "shasum": "ddb2f1fb4502bf33598d2b032b037960ca6c80a3",
    "tarball": "http://registry.npmjs.org/express/-/express-4.13.3.tgz"
  },
  "directories": {},
  "_resolved": "https://registry.npmjs.org/express/-/express-4.13.3.tgz",
  "readme": "ERROR: No README data found!"
}
</syntaxhighlight>
说明：
* '''name'''：包名。
* '''version'''：包的版本号。
* '''description'''：包的描述。
* '''homepage'''：包的官网 url 。
* '''author'''：包的作者姓名。
* '''contributors'''：包的其他贡献者姓名。
* '''dependencies'''：依赖包列表。如果依赖包没有安装，npm 会自动将依赖包安装在 node_module 目录下。
* '''repository'''：包代码存放的地方的类型，可以是 git 或 svn，git 可在 Github 上。
* '''main'''：main 字段指定了程序的主入口文件，require('moduleName') 就会加载这个文件。这个字段的默认值是模块根目录下面的 index.js。
* '''keywords'''：关键字。

== 版本号 ==
使用 NPM 下载和发布代码时都会接触到版本号。


NPM 使用语义版本号来管理代码，语义版本号格式为“'''X.Y.Z'''”（主版本号.次版本号.补丁版本号）。

当代码变更时，版本号按以下原则更新：
* 如果只是修复bug，需要更新 Z 位。
* 如果是新增了功能，但是向下兼容，需要更新 Y 位。
* 如果有大变动，向下不兼容，需要更新 X 位。

版本号有了这个保证后，在申明第三方包依赖时，除了可依赖于一个固定版本号外，还可依赖于某个范围的版本号。例如 "argv": "0.0.x" 表示依赖于 0.0.x 系列的最新版 argv。


NPM 支持的所有版本号范围指定方式可以查看[https://npmjs.org/doc/files/package.json.html#dependencies 官方文档]。

== NPM 常用命令 ==
常用命令如下：
# 使用“'''npm help <command>'''”可查看某条命令的详细帮助，例如“npm help install”。
#* 使用 '''npm help''' 可查看所有命令；
# 在 package.json 所在目录下使用“'''npm install . -g'''”可先在本地安装当前命令行程序，可用于发布前的本地测试。
# 使用“'''npm update <package>'''”可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。
# 使用“'''npm update <package> -g'''”可以把全局安装的对应命令行程序更新至最新版。
# 使用“'''npm cache clear'''”可以清空NPM本地缓存，用于对付使用相同版本号发布新版本代码的人。
# 使用“'''npm unpublish <package>@<version>'''”可以撤销发布自己发布过的某个版本代码。


* 可以在 ''' https://npmjs.org/doc/ ''' 查看官方文档，获取更多命令说明；

== 使用淘宝 NPM 镜像 ==
淘宝 NPM 镜像是一个完整 npmjs.org 镜像，你可以用此代替官方版本（只读），同步频率目前为 10 分钟一次以保证尽量与官方服务同步。


# 使用淘宝定制的 '''cnpm''' (gzip 压缩支持) 命令行工具代替默认的 '''npm'''：【！！！】
#: <syntaxhighlight lang="bash" highlight="">
$ npm install -g cnpm --registry=https://registry.npm.taobao.org
</syntaxhighlight>
# 这样就可以使用 cnpm 命令来安装模块了：
#: <syntaxhighlight lang="bash" highlight="">
$ cnpm install [name]
</syntaxhighlight>