项目package.json配置文件解读
2019-06-19 本文已影响0人
mcgee0731
项目Package.json配置文件
项目配置文件,定义了项目所需要的各种模块和项目的配置信息(名称,版本,许可证等)npm install
根据这个配置文件自动下载所需模块
scripts字段
scripts
指定了运行脚本命令的npm命令行缩写,比如start
指定了运行npm run start
时,所要执行的命令。
dependencies字段,devDependencies字段
dependencies
字段指定了项目运行所依赖的模块,devDependencies
指定项目开发所需要的模块。
它们都指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。
package.json
文件可以手工编写,也可以使用npm init
命令自动生成。
有了package.json
文件,直接使用npm install
命令,就会在当前目录中安装所需要的模块。
如果一个模块不在package.json
文件之中,可以单独安装这个模块,并使用相应的参数,将其写入package.json
文件之中。
npm install express --save
npm install express --save-dev
上面代码表示单独安装express
模块,--save
参数表示将该模块写入dependencies
属性,--save-dev
表示将该模块写入devDependencies
属性。
peerDependencies字段
peerDependencies
字段,就是用来供插件指定其所需要的主工具的版本。
{
"peerDependencies" :{
"chai":"1.x"
}
}
bin字段
bin
项用来指定各个内部命令对应的可执行文件的位置。
bin”:{
"someTool": "./bin/someTool.js"
}
执行的命令可以写成
script:{
start : “./node_modules/sometool/someTool.js build”
}
script:{
start : “someTool build”
}
main字段
main
字段指定了加载的入口文件,require('moduleName')
就会加载这个文件。这个字段的默认值是模块根目录下面的index.js
。