package.json 笔记

package.json

一、概述：

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

package.json :>>>内部是json对象

{
  "name" : "xxx",//name就是项目名称 "version" : "0.0.0",//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", } }

二、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" }

三、dependencies字段，devDependencies字段

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

[ps:]package.json文件能够手工编写，也可使用npm init命令自动生成。或$ npm init

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

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

四、peerDependencies

有时，你的项目和所依赖的模块，都会同时依赖另外一个模块，可是所依赖的版本不同。好比，你的项目依赖A模块和B模块的1.0版，而A模块自己又依赖B模块的2.0版。

大多数状况下，这不构成问题，B模块的两个版本能够并存，同时运行。可是，有一种状况，会出现问题，就是这种依赖关系将暴露给用户。

最典型的场景就是插件，好比A模块是B模块的插件。用户安装的B模块是1.0版本，可是A插件只能和2.0版本的B模块一块儿使用。这时，用户要是将1.0版本的B的实例传给A，就会出现问题。所以，须要一种机制，在模板安装的时候提醒用户，若是A和B一块儿安装，那么B必须是2.0模块。

peerDependencies字段，就是用来供插件指定其所须要的主工具的版本。

{
  "name": "chai-as-promised", "peerDependencies": { "chai": "1.x" } }

上面代码指定，安装chai-as-promised模块时，主程序chai必须一块儿安装，并且chai的版本必须是1.x。若是你的项目指定的依赖是chai的2.0版本，就会报错。

注意，从npm 3.0版开始，peerDependencies再也不会默认安装了。

五、bin字段

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

"bin": { "someTool": "./bin/someTool.js" }

上面代码指定，someTool 命令对应的可执行文件为 bin 子目录下的 someTool.js。Npm会寻找这个文件，在node_modules/.bin/目录下创建符号连接。在上面的例子中，someTool.js会创建符号连接npm_modules/.bin/someTool。因为node_modules/.bin/目录会在运行时加入系统的PATH变量，所以在运行npm时，就能够不带路径，直接经过命令来调用这些脚本。

所以，像下面这样的写法能够采用简写。

scripts: {  
  start: './node_modules/someTool/someTool.js build' } // 简写为 scripts: { start: 'someTool build' }

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

六、main字段

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

七、config字段

config字段用于向环境变量输出值。

下面是一个package.json文件。

{
  "name" : "foo", "config" : { "port" : "8080" }, "scripts" : { "start" : "node server.js" } }

而后，在server.js脚本就能够引用config字段的值。

http.createServer(...).listen(process.env.npm_package_config_port)

用户能够改变这个值。

$ npm config set foo:port 80

八、其余

8.1 browser字段 browser指定该模板供浏览器使用的版本。Browserify这样的浏览器打包工具，经过它就知道该打包那个文件。

"browser": { "tipso": "./node_modules/tipso/src/tipso.js" },

8.2 engines字段 engines指明了该项目所须要的node.js版本。

8.3 man字段 man用来指定当前模块的man文档的位置。

"man" :[ "./doc/calc.1" ]

8.4 preferGlobal字段 preferGlobal的值是布尔值，表示当用户不将该模块安装为全局模块时（即不用–global参数），要不要显示警告，表示该模块的本意就是安装为全局模块。

8.5 style字段 style指定供浏览器使用时，样式文件所在的位置。样式文件打包工具parcelify，经过它知道样式文件的打包位置。

"style": [ "./node_modules/tipso/src/tipso.css" ]