一、package.json是什么

每个项目的根目录下面，一般都有一个package.json文件，定义了这个项目所需要的各种模块，以及项目的配置信息（比如名称、版本、许可证等元数据）。npm install命令根据这个配置文件，自动下载所需的模块，也就是配置项目所需的运行和开发环境。

  1. {
  2.   "name" : "xxx",
  3.   "version" : "0.0.0",
  4.   "author": "作者",
  5.     "description": "描述",
  6.     "keywords":["node.js","javascript"], // 关键字
  7.   "config":{ "port" : "8080" }, // 字段用于添加命令行的环境变量。
  8.     "repository": { // 项目代码存放地方
  9.         "type": "git",
  10.         "url": "https://path/to/url"
  11.     },
  12.     "license":"MIT", //项目许可证，让使用者知道是如何被允许使用此项目。默认是”ISC”
  13.     "engines": {"node": "0.10.x"}, // 声明项目需要的node或npm版本范围
  14.   // 项目问题反馈的Url或email配置，
  15.     "bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
  16.     // 贡献者
  17.   "contributors":[{"name":"李四","email":"lisi@example.com"}],
  18.     // bin项用来指定各个内部命令对应的可执行文件的位置
  19.   "bin": {},
  20.   // 声明一系列npm脚本指令
  21.   "scripts": {},
  22.   "dependencies": {},
  23.   "devDependencies": {},
  24.   "peerDependencies": {},
  25. }

二、常用字段

1.scripts

scripts指定了运行脚本命令的npm命令行缩写，比如start指定了运行npm run start时，所要执行的命令。

  1. scripts": {
  2.     "start": "node server.js --open",
  3.     "build": "webpack --config webpack.config.prod.js",
  4.     "lint": "eslint --ext .tsx --ext .ts src",
  5.     "lint:fix": "eslint --ext .tsx --ext .ts src --fix"
  6. }

2.dependencies字段，devDependencies字段

  1. // 安装但不写入package.json；
  2. npm install xxx
  3. // 全局安装
  4. npm install xxx -g
  5. // 安装指定版本
  6. npm install xxx@1.2.0
dependencies devDependencies
目的 项目运行所依赖的模块 开发所需要的模块
版本控制
- 指定版本：比如1.2.2，遵循“大版本.次要版本.小版本”的格式规定，
- 波浪号（tilde）+指定版本：比如~1.2.2，表示安装1.2.x的最新版本（不低于1.2.2），但是不安装1.3.x，也就是说安装时不改变大版本号和次要版本号。
- 插入号（caret）+指定版本：比如ˆ1.2.2，表示安装1.x.x的最新版本（不低于1.2.2），但是不安装2.x.x，也就是说安装时不改变大版本号。需要注意的是，如果大版本号为0，则插入号的行为与波浪号相同，这是因为此时处于开发阶段，即使是次要版本号变动，也可能带来程序的不兼容。
- latest：安装最新版本。
npm安装 npm install xxx –S npm install xxx –D
yarn安装 ```

yarn add [package]

  1.  | `yarn add [package] --dev` |
  2. | 升级依赖 |

yarn upgrade [package] 

  1. ```
  2.  npm update xxx<br />

| | | 删除 | npm uninstall xxx npm uninstall -g xxx
yarn remove [package] | |

3.peerDependencies

项目和所依赖的模块，都会同时依赖另一个模块，但是所依赖的版本不一样。比如，你的项目依赖A模块和B模块的1.0版，而A模块本身又依赖B模块的2.0版。
比如A模块是B模块的插件。用户安装的B模块是1.0版本，但是A插件只能和2.0版本的B模块一起使用。这时，用户要是将1.0版本的B的实例传给A，就会出现问题。因此，需要一种机制，在模板安装的时候提醒用户，如果A和B一起安装，那么B必须是2.0模块。

npm 3.0版开始，peerDependencies不再会默认安装了

4.bin字段

bin项用来指定各个内部命令对应的可执行文件的位置

  1. "bin": {
  2.   "someTool": "./bin/someTool.js"
  3. }
  4. // 可以将
  5. scripts: {  
  6.   start: './node_modules/bin/someTool.js build'
  7. }
  8. // 简写为
  9. scripts: {  
  10.   start: 'someTool build'
  11. }

所有node_modules/.bin/目录下的命令，都可以用npm run [命令]的格式运行。在命令行下，键入npm run，然后按tab键，就会显示所有可以使用的命令。

5. main字段

main字段指定了加载的入口文件，require('moduleName')就会加载这个文件。这个字段的默认值是模块根目录下面的index.js。

6. config 字段

config字段用于添加命令行的环境变量。

  1. "config" : { "port" : "8080" },

在server.js脚本就可以引用config字段的值。

  1. http
  2.   .createServer(...)
  3.   .listen(process.env.npm_package_config_port)