# npm

## 全局安装包
```bash
├── @vue/cli@3.0.5
├── @vue/eslint-config-airbnb@3.0.5
├── create-react-app@2.0.4
├── create-react-native-app@2.0.2
├── egg-init@1.15.0
├── eslint@5.8.0
├── express-generator@4.16.0
├── gatsby-cli@2.4.3
├── gitbook-cli@2.3.2
├── hexo-cli@1.1.0
├── http-server@0.11.1
├── less@3.8.1
├── n@2.1.12
├── nodemon@1.18.5
├── npm@6.4.1
├── typescript@3.1.3
└── vuepress@0.14.4
```
参考文章:<br/>
[https://wohugb.gitbooks.io/npm/content/index.html](https://wohugb.gitbooks.io/npm/content/index.html)
[https://blog.csdn.net/SayDream/article/details/52106936](https://blog.csdn.net/SayDream/article/details/52106936)

## npm是什么
NPM的全称是Node Package Manager，是随同NodeJS一起安装的包管理和分发工具，它很方便让JavaScript开发者下载、安装、上传以及管理已经安装的包。
## npm install 安装模块
基础语法
```bash
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]
```
安装包，默认会安装最新的版本
```bash
npm install gulp
```
安装指定版本
```bash
npm install gulp@3.9.1
```

## 安装包并将信息保持到项目的package.json文件中
项目对模块的依赖可以使用下面的 3 种方法来表示（假设当前版本号是 1.1.0 ）：<br/>
兼容模块新发布的补丁版本：~1.1.0、1.1.x、1.1兼容模块新发布的小版本、补丁版本：^1.1.0、1.x、1兼容模块新发布的大版本、小版本、补丁版本：* 、x

### -S, --save 安装包信息将加入到dependencies（生产阶段的依赖）
```bash
npm install gulp --save 或 npm install gulp -S
```
### package.json 文件的 dependencies 字段：
```bash
npm install gulp --save-dev 或 npm install gulp -D
```
### package.json 文件的 devDependencies字段：
```json
"devDependencies": { "gulp": "^3.9.1"}
```
### -O, --save-optional 安装包信息将加入到optionalDependencies（可选阶段的依赖）
```bash
npm install gulp --save-optional 或 npm install gulp -O
```
### package.json 文件的optionalDependencies字段：
```json
"optionalDependencies": { "gulp": "^3.9.1"},
```
### -E, --save-exact 精确安装指定模块版本
```bash
npm install gulp --save-exact 或 npm install gulp -E
```
### 输入命令npm install gulp -ES，留意package.json 文件的 dependencies 字段，以看出版本号中的^消失了
```json
"dependencies": { "gulp": "3.9.1"}
```
### 模块的依赖都被写入了package.json文件后，他人打开项目的根目录（项目开源、内部团队合作），使用npm install命令可以根据dependencies配置安装所有的依赖包
```bash
npm install
```

## 本地安装（local）
```bash
npm install gulp
```
## 全局安装（global）,使用-g 或 --global
```bash
npm install gulp -g
```
## npm ls查看安装的模块
基础语法
```bash
npm ls [[<@scope>/]<pkg> ...]aliases: list, la, ll
```
## 查看全局安装的模块及依赖
```bash
npm ls -g
```

## npm uninstall卸载模块
基础语法
```bash
npm uninstall\
 [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|\
 --save-optional]aliases: remove, rm, r, un, unlink
```
### 如卸载开发版本的模块
从 `node_modules` 目录删除包命令 `npm uninstall [<package>]`:
```bash
npm uninstall lodash
```
去除`package.json`依赖关系, 需要 `save`|`dev` 标签:
```bash
npm uninstall lodash --save-dev
```
卸载全局包命令 `npm uninstall -g [<package>]`:
```bash
npm uninstall -g jshint
```
## npm update更新模块
基础语法
```bash
npm update [-g] [<pkg>...]
```
实例:更新当前项目下所有的依赖包
```bash
# --dev 同时更新devDependencies内容
# --save 把更新情况保存到package.json
# -d 查看细节
npm  update --dev --save -d
```
### 更新全局包
更新全局包命令 `npm install -g [<package>]`:
```bash
npm install -g jshint
```
查找过期包
```bash
npm outdated -g --depth=0
```
更新所有全局包
```bash
npm update -g
```

## npm outdated检查模块是否已经过时
基础语法:此命令会列出所有已经过时的包，可以及时进行包的更新
```bash
npm outdated [[<@scope>/]<pkg> ...]
```

## npm init在项目中引导创建一个package.json文件
安装包的信息可保持到项目的package.json文件中，以便后续的其它的项目开发或者他人合作使用，也说package.json在项目中是必不可少的。
```bash
npm init [-f|--force|-y|--yes]
```

## npm help 查看某条命令的详细帮助
例如输入`npm help install`，系统在默认的浏览器或者默认的编辑器中打开本地`nodejs`安装包的文件`/nodejs/node_modules/npm/html/doc/cli/npm-install.html`
```bash
npm help <command>
```

## npmroot查看包的安装路径
输出node_modules的路径
```bash
npm root [-g]
```

## npm config管理npm的配置路径
基础语法
```bash
npm config set <key> <value> [-g|--global]\
npm config get <key>npm config delete <key>\
npm config listnpm config editnpm get <key>\
npm set <key> <value> [-g|--global]
```
对于config这块用得最多应该是设置代理，解决npm安装一些模块失败的问题

例如我在公司内网，因为公司的防火墙原因，无法完成任何模块的安装，这个时候设置代理可以解决
```bash
npm config set proxy=http://dev-proxy.oa.com:8080
```

又如国内的网络环境问题，某官方的IP可能被和谐了，幸好国内有好心人，搭建了镜像，此时我们简单设置镜像
```bash
npm config set registry="http://r.cnpmjs.org"
```

## npm cache 管理模块的缓存
基础语法
```bash
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本地缓存
```bash
npm cache clean
```

## npm start 启动模块
基础语法
```bash
npm start [-- <args>]
```
该命令写在package.json文件scripts的start字段中，可以自定义命令来配置一个服务器环境和安装一系列的必要程序，如
```json
"scripts": { "start": "gulp -all"}
```
如果package.json文件没有设置start，则将直接启动node server.js

npm stop 停止模块

基础语法
```bash
npm stop [-- <args>]
```

## npm restart 重新启动模块
基础语法
```bash
npm restart [-- <args>]
```