package.json 详解

package.json

该文件定义了项目所需的各种模块，以及配置信息（名称，版本，许可证等元数据）

npm install 会根据这个配置文件自动下载所需要的模块

最简单的package.json

只包含：项目名称和项目版本

{
  "name" : "xxx",	# 项目名称
  "version" : "0.0.0",	# 项目版本：大版本.次要版本.小版本
}

package.json文件就是一个JSON对象，该对象的每一个成员就是当前项目的一项设置

常见的详细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": {
        # npm 命令行缩写，运行npm run start时，执行这个bash
		"start": "node index.js"
	},
	"dependencies": {	# 项目依赖，安装模块时如果输入--save就会存在这里
		"express": "latest",	# 安装最新版本
		"mongoose": "~3.8.3",	# 安装3.8.x的最新版本，不低于3.8.3(不改变大版本号和次要版本号)
       	 "mongoose": "^3.8.3",	# 安装3.x.x的最新版本，不低于3.8.3(不改变大版本号)
		"handlebars-runtime": "~1.0.12",
		"express3-handlebars": "~0.5.0",
		"MD5": "~1.2.0"
	},
	"devDependencies": {	# 开发依赖，安装模块时如果输入--save-dev就会存在这里
		"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",
	}
}

常用命令

# package.json文件可以手工编写，也可以使用npm init命令自动生成
# 经过互动方式输入项目名称和版本等资料，进行自动生成
npm init


# 有了package.json文件后直接使用npm install就会安装所需要的模块
npm install


# 如果模块不在package.json文件中，可以单独安装这个模块
npm install express --save	# 写入项目依赖dependencies
npm install express --save-dev	# 写入项目开发依赖devDependencies

peerDependencies

{
    #安装chai-as-promised模块时，主程序chai必须一起安装，而且chai的版本必须是1.x。如果你的项目指定的依赖是chai的2.0版本，就会报错
  "name": "chai-as-promised",
  "peerDependencies": { 
    "chai": "1.x"
  }
}

bin字段

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

# 指定，someTool 命令对应的可执行文件为 bin 子目录下的 someTool.js。Npm会寻找这个文件，在node_modules/.bin/目录下建立符号链接。

# 在上面的例子中，someTool.js会建立符号链接node_modules/.bin/someTool。
# 由于node_modules/.bin/目录会在运行时加入系统的PATH变量，因此在运行npm时，就可以不带路径，直接通过命令来调用这些脚本

因此，像下面这样的写法可以采用简写

"scripts": {  
  "start": './node_modules/bin/someTool.js build'
}

// 简写为

"scripts": {  
  "start": 'someTool build'
}

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

main字段

main字段指定了加载的入口文件，require('moduleName') 就会加载这个文件

这个字段的默认值是模块根目录下面的index.js

config字段

用于添加命令行的环境变量

# package.json

{
  "name" : "foo",
  "config" : { "port" : "8080" },	# 添加环境变量
  "scripts" : { "start" : "node server.js" }
}

# server.js
http
  .createServer(...)
  .listen(process.env.npm_package_config_port)	# 引用config的值

npm run start	# 这时可以得到设定的环境变量

npm config set foo:port 80	# 用户可以改变这个值

其他字段

# browser 指定该模板供浏览器使用的版本
# Browserify这样的浏览器打包工具，通过它就知道该打包那个文件（？）
"browser": {
  "tipso": "./node_modules/tipso/src/tipso.js"
},


# engines 指明该模块运行的平台，如Node版本或者浏览器
{ "engines" : { "node" : ">=0.10.3 <0.12" } }
{ "engines" : { "npm" : "~1.0.20" } }

# man 指定当前模块的man文档的位置
# （"man" 是英文单词manual的缩写，中文意为手册、帮助文档）
"man" :[ "./doc/calc.1" ]

# style 指定供浏览器使用时，样式文件所在位置
"style": [
  "./node_modules/tipso/src/tipso.css"
]