一、概述
每个项目的根目录下面,一般都有一个package.json文件,定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install命令根据这个配置文件,自动下载所需的模块,也就是配置项目所需的运行和开发环境。
package.json文件就是一个JSON对象,该对象的每一个成员就是当前项目的一项设置。比如name就是项目名称;version是版本(遵守“大版本.次要版本.小版本”的格式);description是npm包的描述,它可以帮助人们在使用npm search时找到这个包;author是一个人,contributors是一些人的数组;private为是否发布,若private为true,npm会拒绝发布,这可以防止私有repositories不小心被发布出去。
name和version是必须的字段,如果你的npm包没有指定这两个字段,将无法被安装。
二、scripts字段
scripts指定了运行脚本命令的npm命令行缩写,比如start指定了运行npm run start时,所要执行的命令。
下面的设置指定了npm run start、npm run build、npm run test时,所要执行的命令,以第一个项目为例。
"scripts": {
"start":"node build/dev-server.js",
"build":"node build/build.js",
"test":"node build/test.js"
}
三、dependencies字段,devDependencies字段
dependencies字段指定了项目运行所依赖的模块,它指定了依赖的包名和其版本范围的映射,版本范围是个有一个或多个空白分隔描述符的字符串,dependencies字段还可以用tarball或者git URL,请不要将测试或过渡性的依赖放到dependencies中。
devDependencies指定项目开发所需要的模块。如果有人计划在他们的项目中下载和使用你的模块,但他们可能并不想或并不需要你开发所使用的外部测试和文档框架。在这种情况下,最好将这些附加的项放在devDependencies中。
dependencies和devDependencies都指向一个对象,该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。以第一个项目为例
"dependencies": {
"axios":"^0.16.2",
"mint-ui":"^2.2.7",
"vue":"^2.3.3",
"vue-router":"^2.3.1",
"vuex":"^2.3.1"
}
"devDependencies": {
"autoprefixer":"^6.7.2",
"babel-core":"^6.22.1",
......
}
四、engines字段
engines字段指明了该模块运行的平台,比如 Node 的某个版本或者浏览器。
"engines": {
"node":">= 4.0.0",
"npm":">= 3.0.0"
}
五、browserslist字段
browserslist指定该模板供浏览器使用的版本。
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]