NPM 使用介绍

NPM 使用介绍

---

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

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

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

$ npm -v
6.14.5

使用 npm 命令安装模块

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

$ npm install <Module Name>
// 更新 npm
$ npm install npm -g
// 使用 npm 命令安装常用的 Node.js web框架模块 express
$ npm install express
// 安装好之后，express 包就放在了工程目录下的 node_modules 目录中，因此在代码中只需要通过 require('express') 的方式就好
var express = require('express');

全局安装与本地安装

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

npm install express          // 本地安装
npm install express -g   // 全局安装

如果出现以下错误：

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087

解决办法为：

$ npm config set proxy null

本地安装

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

全局安装

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

查看安装信息

可以使用以下命令来查看所有全局安装的模块：

$ 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
……

如果要查看某个模块的版本号，可以使用命令如下：

$ npm list grunt
projectName@projectVersion /path/to/project/folder
└── grunt@0.4.1

使用 package.json

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

{
  "name": "Nodejs",
  "version": "1.0.0",
  "description": "",
  "main": "server.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "node server.js"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "style-css": "^1.0.2"
  }
}

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

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

$ npm ls

更新模块

可以使用以下命令更新模块。

$ npm update express

搜索模块

使用以下来搜索模块。

$ npm search express

创建模块

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

$ npm init  // 初始化
{
  "name": "test",            // 包名
  "version": "1.0.0",        // 版本号
  "description": "test",    // 描述
  "main": "index.js",        // 入口文件
  "scripts": {                  // 定义命令, npm run test
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [             // 关键字
    "test"
  ],
  "author": "test",          // 作者
  "license": "ISC"           // 开源协议
}
或者输入：npm init -y
这样在init的时候省去了敲回车的步骤，生成的默认的package.json

我们可以使用以下命令在 npm 资源库中注册用户（使用邮箱注册）：

$ npm adduser
Username: Melikui
Password:Email: (this IS public) melikui@qq.com

接下来我们就用以下命令来发布模块

$ npm publish

NPM 常用命令

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

// 将某个包升级到最新版
npm install vue-loader@latest --save-dev-g

// 全局安装/卸载
npm install -g
npm uninstall -g

// 生产环境安装/卸载
npm install module_name -S
npm install module_name --save 写入dependencies
npm uninstall module_name -S
npm uninstall module_name --save 写入dependencies

// 开发环境安装/卸载
npm install module_name -D
npm install module_name --save-dev 写入devDependencies
npm uninstall module_name -D
npm uninstall module_name --save-dev 写入devDependencies

// 查看模块
// 查看所有全局安装的模块
npm ls -g
// 查看npm默认设置（部分）
npm config ls
// 查看npm默认设置（全部）
npm config ls -l

// 修改默认安装目录
npm config set prefix “D:\ProgramFiles\npm_global_modules\node_modules”

npm remove <name>  // 移除
npm update <name>  // 更新
npm ls  // 列出当前安装的了所有包
npm root  // 查看当前包的安装路径
npm root -g  // 查看全局的包的安装路径
npm help  //帮助，如果要单独查看install命令的帮助，可以使用的npm help install

使用淘宝 NPM 镜像

大家都知道国内直接使用 npm 的官方镜像是非常慢的，这里推荐使用淘宝 NPM 镜像。
淘宝 NPM 镜像是一个完整 npmjs.org 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟 一次以保证尽量与官方服务同步。

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

安装后就可以使用 cnpm 命令来安装模块了

$ cnpm install [name]

在使用node的时候，用npm安装了很多软件，过一段时间没有使用就会忘记，怎么查看自己全局安装过的包，用命令

npm list -g --depth 0