package.json配置文件入门简介
用过npm的小伙伴都知道，我们可以通过npm init快速的创建一个package.json文件
image
如果没有特殊要求，一路回车下去就可以了。
最终会在当前的文件夹中看见package.json.
其中的内容如图一所示
接下来，我们先看一个常用的例子
{
"name": "demo",
"version": "1.0.0",
"description": "这里是介绍",
"main": "index.js",
"scripts": {
"build": "webpack --config webpack.config.js",
"sync": "gulp sync",
"syncbuild": "gulp sync && webpack --config webpack.config.js"
},
"author": "will",
"license": "ISC",
"dependencies": {
"react": "16.*"
},
"devDependencies": {
"babel": "^6.23.0",
"babel-core": "^6.26.0",
"babel-loader": "^7.1.2",
"babel-polyfill": "^6.26.0",
"babel-preset-es2015": "^6.24.1",
"babel-preset-es2015-loose": "^8.0.0",
"eslint": "^4.10.0",
"gulp": "^3.9.1",
"webpack": "^3.8.1"
}
}
我们来详细说明一下文件中各个字段的含义与用法
简单关键字说明
name, version, description, main, author, license通过字面意思即可理解，
需要说明的是，
-
version标注了当前项目的版本号，如果是私有项目，不发布到仓库（repository）,此项关键字可以不用变更；
-
main是我们模块或者是项目的入口文件，有且只有一个文件，文件的路径是相对项目的根目录；
-
license是标注我们项目的许可证权限，如果是开源项目，请参考阮一峰开源许可证教程。
如果不想开源，可以使用
{ "license": "UNLICENSED" }
或者
{ "private": true }
重点关键字说明
scripts，dependencies，devDependencies
首先我们来看看scripts
scripts是npm提供给我们运行shell命令的入口
{
"scripts": {
"build": "webpack --config webpack.config.js",
"sync": "gulp sync",
"syncbuild": "gulp sync && webpack --config webpack.config.js"
}
}
我们可以通过npm run build启动webpack --config webpack.config.js
这条命令等同于在命令行中输入webpack --config webpack.config.js
例子中syncbuild是前两步的合并，build为编译，sync为同步文件
这里的key为npm run时接受的参数，value代表着需要运行shell命令
dependencies与devDependencies看起来差不多，他们都是标注项目的依赖列表
不同的是，dependencies是项目运行时必要依赖，而devDependencies是项目开发时所需依赖
明确了以上的不同，就可以很清晰知道把项目依赖放在哪里了
平时使用的时候我们会通过
npm i --save react
安装依赖，此依赖会写入dependencies列表
如需将依赖写入devDependencies
npm i --save-dev react
这里还有一点需要注意，我们的项目在发布后，他人在使用时默认会将dependencies列表的依赖全部安装
npm i packagename
或者
npm i packagename --production
如果需要安装开发环境
npm i packagename --dev
这样会将项目的开发依赖包全部安装到本地
依赖列表中版本号说明
首先来看一下npm官方给出的例子
{
"dependencies": {
"foo": "1.0.0 - 2.9999.9999",
"bar": ">=1.0.2 <2.1.2",
"baz": ">1.0.2 <=2.3.4",
"boo": "2.0.1",
"qux": "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0",
"asd": "http://asdf.com/asdf.tar.gz",
"til": "~1.2",
"elf": "~1.2.3",
"two": "2.x",
"thr": "3.3.x",
"lat": "latest",
"dyl": "file:../dyl"
}
}
这里的版本号有多种形式
- 明确版本号，即 "2.0.1"
- 版本号区间，有多种写法，支持比较表达式以及或运算，即 "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0"
- 模糊匹配
- 2.x 会匹配所有2.0.0到3.0.0之间的版本，比如2.x会匹配2.0.0 和 2.3.5，但不包括3.0.0
- ~ 会匹配最近的小版本依赖包，比如~1.1.3会匹配所有1.1.x版本，但是不包括1.1.0
- ^ 会匹配最新的大版本依赖包，比如^2.2.2会匹配所有2.x.x的包，包括2.3.0，但是不包括3.0.0
- * 会匹配所有版本
- "" 会匹配所有版本
- latest 会匹配一个给定的特殊tag版本
- http 或者 git 路径 会匹配给定url地址
- 本地路径会匹配本地文件包，不过此路径使用需要先初始化本地依赖包
git路径的格式如下
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
<protocol>为枚举类型，git, git+ssh, git+http, git+https, git+file.
git+ssh://git@github.com:npm/npm.git#v1.0.27
git+ssh://git@github.com:npm/npm#semver:^5.0
git+https://isaacs@github.com/npm/npm.git
git://github.com/npm/npm.git#v1.0.27
本文整理了package.json常见的配置项，如有纰漏或错误，请予以指正。
参考文档 package.json官方文档
网友评论