NPM 使用入门

NPM

NPM是随同 NodeJS 一起安装的包管理工具，能解决 NodeJS 代码部署上的很多问题，常见的使用场景有以下几种：

• 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
• 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
• 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

由于新版的nodejs已经集成了npm，所以之前npm也一并安装好了。同样可以通过输入 “npm -v” 来测试是否成功安装

使用NPM安装模块

npm 安装 Node.js 模块语法格式如下：

$ npm install <Module Name>
1

以下实例，我们使用 npm 命令安装常用的 Node.js web框架模块 express:

$ npm install express
1

安装好之后，express 包就放在了工程目录下的 node_modules 目录中，因此在代码中只需要通过 require(‘express’) 的方式就好，无需指定第三方包路径。

const express = require('express');
1

全局安装和本地安装

npm 的包安装分为本地安装（local）、全局安装（global）两种，从敲的命令行来看，差别只是有没有-g而已，比如

$ npm install express      # 本地安装
$ npm install express -g   # 全局安装
1
2

如果出现以下错误：

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087 
1

解决办法为：

$ npm config set proxy null
1

本地安装

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

全局安装

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

使用package.json

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

属性说明

• name - 包名。
• version - 包的版本号。
• description - 包的描述。
• homepage - 包的官网 url 。
• author - 包的作者姓名。
• contributors - 包的其他贡献者姓名。
• dependencies - 依赖包列表。如果依赖包没有安装，npm 会自动将依赖包安装在 node_module 目录下。
• repository - 包代码存放的地方的类型，可以是 git 或 svn，git 可在 Github 上。
• main - main 字段指定了程序的主入口文件，require(‘moduleName’) 就会加载这个文件。这个字段的默认值是模块根目录下面的 index.js。
• keywords - 关键字

卸载模块

我们可以使用以下命令来卸载 Node.js 模块。

$ npm uninstall express
1

卸载后，你可以到 /node_modules/ 目录下查看包是否还存在，或者使用以下命令查看：

$ npm ls
1

更新模块

我们可以使用以下命令更新模块：

$ npm update express
1

搜索模块

使用以下来搜索模块：

$ npm search express
1

创建模块

创建模块，package.json 文件是必不可少的。我们可以使用 NPM 生成 package.json 文件，生成的文件包含了基本的结果。

常用指令

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

使用中国镜像

你可以使用淘宝定制的 cnpm (gzip 压缩支持) 命令行工具代替默认的 npm:

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

这样就可以使用 cnpm 命令来安装模块了：

$ cnpm install [name]
1

更多信息可以查阅：http://npm.taobao.org/

使用双重验证

npm 推出了5.5.1版的双重身份验证（2FA），它可以防止他人未经授权访问您的帐户。

安装客户端

需要一个可以生成一次性验证码OTP的应用程序。在应用商店搜索 authy 进行安装。

账号设置

• 在 npm 官网登录账号：https://www.npmjs.com/
• 点击右上角头像 -> 点击「Account」-> 点击开启「Two Factor Authentication」-> 依次按照提示进行设置

发布包

没有npm账号的先在官网注册账号：https://www.npmjs.com/

控制台输入指令进行账号登陆：

$ npm login
1

控制台输出：

npm notice Log in on https://registry.npmjs.org/
Login at:
https://www.npmjs.com/login?next=/login/cli/8fc6a446-c678-4c57-bbbe-bd1811d3a05b
Press ENTER to open in the browser...

Logged in on https://registry.npmjs.org/.
1
2
3
4
5
6

点击链接跳转浏览器页面进行账号登陆

查看当前登陆账号信息：

$ npm whoami
1

发布：

$ npm publish --registry=https://registry.npmjs.org/
1