Node.js学习笔记（8、配置文件package.json）

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

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

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

从上面代码可以看到，package.json文件内部就是一个json对象，该对象的每一个成员就是当前项目的一项设置。比如上面代码的name就是项目名称，version是项目版本（遵守“主要版本.次要版本.补丁号”的格式）。

下面是一个更完成的package.json文件。

{
    "name": "...",
    "version": "0.0.0",
    "author": "...",
    "description": "...",
    "keywords":["...","..."],
    "repository": {
        "type": "git",
        "url": "https://..."
    },
    "license":"MIT",
    "engines": {"node": "0.10.x"},
    "bugs":{"url":"http://...","email":"..."},
    "contributors":[{"name":"...","email":"..."}],
}

上面代码各个成员的含义都很明显，比较需要注意的是engines这一项，它指明了node.js运行所需要的版本。

除了上面几项，还有两个package.json的成员需要单独讲解。

一个是dependencies属性，它指定项目运行所需要的模块。

"dependencies": {
    "express": "latest",
    "mongoose": "~3.8.3",
    "handlebars-runtime": "~1.0.12",
    "express3-handlebars": "~0.5.0",
    "MD5": "~1.2.0"
},

上面代码指定，项目运行需要的五个模块及其版本，其中express需要最新版。

另一个是devDependencies属性，它指定项目开发所需要的模块。

"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",
}

上面代码指定项目开发时需要用到的模块，大部分是grunt模块。

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

npm init

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

有了package.json文件，直接使用npm install命令，就会在当前目录中安装所需要的模块。

npm install

如果一个模块不在package.json文件之中，可以单独安装这个模块，并使用相应的参数，将其写入package.json文件之中。

npm install express --save
npm install express --save-dev

上面代码表示单独安装express模块，--save参数表示将该模块写入dependencies属性，--save-dev表示将该模块写入devDependencies属性。