走进node.js - package.json持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第2

持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第24天，点击查看活动详情

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

package.json 文件可以手工编写，也可以使用npm init命令自动生成。 npm init

这个命令采用互动方式，要求用户回答一些问题，然后在当前目录生成一个基本的 package.json 文件。所有问题之中，只有项目名称（name）和项目版本（version）是必填的，其他都是选填的。

这个文件可以通过 npm init 的方式来自动初始化出来。

下面是一个最简单的 package.json 文件，只定义两项元数据：项目名称和项目版本。

{
  "name": "xxx",
  "version": "0.0.0"
}

package.json文件就是一个 JSON 对象，该对象的每一个成员就是当前项目的一项设置。比如name就是项目名称，version是版本（遵守“大版本.次要版本.小版本”的格式）。

完整的 package.json 文件。

{
  "name": "Hello World",
  "version": "0.0.1",
  "author": "张三",
  "description": "第一个node.js程序",
  "keywords": ["node.js", "javascript"],
  "repository": {
    "type": "git",
    "url": "https://path/to/url"
  },
  "license": "MIT",
  "engines": { "node": "0.10.x" },
  "bugs": { "url": "http://path/to/bug", "email": "bug@example.com" },
  "contributors": [{ "name": "李四", "email": "lisi@example.com" }],
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "express": "latest",
    "mongoose": "~3.8.3",
    "handlebars-runtime": "~1.0.12",
    "express3-handlebars": "~0.5.0",
    "MD5": "~1.2.0"
  },
  "devDependencies": {
    "bower": "~1.2.8",
    "grunt": "~0.4.1",
    "grunt-contrib-concat": "~0.3.0",
    "grunt-contrib-jshint": "~0.7.2",
    "grunt-contrib-uglify": "~0.2.7",
    "grunt-contrib-clean": "~0.5.0",
    "browserify": "2.36.1",
    "grunt-browserify": "~1.3.0"
  }
}

dependencies

dependencies字段指定了项目运行所依赖的模块，devDependencies指定项目开发所需要的模块。

它们都指向一个对象。该对象的各个成员，分别由模块名和对应的版本要求组成，表示依赖的模块及其版本范围。

{
  "devDependencies": {
    "browserify": "~13.0.0",
    "karma-browserify": "~5.0.1"
  }
}

对应的版本可以加上各种限定，主要有以下几种：

指定版本：比如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：安装最新版本。

main

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

scripts

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

下面的设置指定了npm run preinstall、npm run postinstall、npm run start、npm run test时，所要执行的命令。

"scripts": {
    "preinstall": "echo here it comes!",
    "postinstall": "echo there it goes!",
    "start": "node index.js",
    "test": "tap test/*.js"
}

package-lock.json

npm 5 以前是不会有 package-lock.json 这个文件的。（被开发者诟病，吐槽的问题）。以前会自作多情的自动给你升级。npm 5 以后才加入了这个文件。当你安装包的时候，npm 都会生成或者更新 package-lock.json 这个文件。

npm 5 以后的版本安装包不需要加 --save 参数，它会自动保存依赖信息
当你安装包的时候，会自动创建或者是更新 package-lock.json 这个文件
package-lock.json 这个文件会保存 node_modules 中所有包的信息（版本、下载地址）
- 这样的话重新 npm install 的时候速度就可以提升
从文件来看，有一个 lock 称之为锁
- 这个 lock 是用来锁定版本的
- 如果项目依赖了 1.1.1 版本
- 如果你重新 isntall 其实会下载最新版本，而不是 1.1.1
- 我们的目的就是希望可以锁住 1.1.1 这个版本
- 所以这个 package-lock.json 这个文件的另一个作用就是锁定版本号，防止自动升级新版

走进node.js - package.json

往期推荐

dependencies

main

scripts

package-lock.json