
每个项目的根目录下面,一般都有一个package.json文件,定义了这个项目所需要的各种板块,以及项目的配置信息(比方名称、版本、许可证等元数据)。npm install命令根据这个配置文件,自动下载所需的板块,也就是配置项目所需的运行和开发环境。
下面是一个最简单的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", }}下面详细解释package.json文件的各个字段。
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指定项目开发所需要的板块。
它们都指向一个对象。该对象的各个成员,分别由板块名和对应的版本要求组成,表示依赖的板块及其版本范围。
{ "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:安装最新版本。
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属性。
有时,你的项目和所依赖的板块,都会同时依赖另一个板块,但是所依赖的版本不一样。比方,你的项目依赖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": {"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字段指定了加载的入口文件,require('moduleName')就会加载这个文件。这个字段的默认值是板块根目录下面的index.js。
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 80browser指定该模板供浏览器使用的版本。Browserify这样的浏览器打包工具,通过它就知道该打包那个文件。
"browser": {"tipso": "./node_modules/tipso/src/tipso.js"},engines指明了该项目所需要的node.js版本。
man用来指定当前板块的man文档的位置。
"man" :[ "./doc/calc.1" ]preferGlobal的值是布尔值,表示当客户不将该板块安装为全局板块时(即不用–global参数),要不要显示警告,表示该板块的本意就是安装为全局板块。
style指定供浏览器使用时,样式文件所在的位置。样式文件打包工具parcelify,通过它知道样式文件的打包位置。
"style": ["./node_modules/tipso/src/tipso.css"]