package.json
文件是项目的清单。 它可以做很多完全互不相关的事情。 例如,它是用于工具的配置中心。 它也是 npm
和 yarn
存储所有已安装软件包的名称和版本的地方。
一、文件结构
{}
它是空的! 对于应用程序,package.json
文件中的内容没有固定的要求。 唯一的要求是必须遵守 JSON 格式,否则,尝试以编程的方式访问其属性的程序则无法读取它。
如果要构建要在 npm
上分发的 Node.js 软件包,则必须具有一组可帮助其他人使用它的属性。 稍后会详细介绍。
这是另一个 package.json:
{
"name": "nodejs_cn"
}
它定义了 name
属性,用于告知应用程序或软件包的名称。
二、属性分类
name
设置软件包的名称。
示例:
"name": "nodejs_cn"
名称必须少于 214 个字符,且不能包含空格,只能包含小写字母、连字符(-
)或下划线(_
)。
这是因为当软件包在 npm
上发布时,它会基于此属性获得自己的 URL。
如果在 GitHub 上公开地发布此软件包,则 GitHub 仓库的名称是作为此属性的不错选择。
author
列出软件包的作者名称。
示例:
{
"author": "NodeJS中文网 <mail@nodejs.cn> (http://nodejs.cn)"
}
也可以使用以下格式:
{
"author": {
"name": "NodeJS中文网",
"email": "mail@nodejs.cn",
"url": "http://nodejs.cn"
}
}
contributors
除作者外,该项目可以有一个或多个贡献者。 此属性是列出他们的数组。
示例:
{
"contributors": ["NodeJS中文网 <mail@nodejs.cn> (http://nodejs.cn))"]
}
也可以使用以下格式:
{
"contributors": [
{
"name": "NodeJS中文网",
"email": "mail@nodejs.cn",
"url": "http://nodejs.cn"
}
]
}
bugs
链接到软件包的问题跟踪器,最常用的是 GitHub 的 issues 页面。
示例:
{
"bugs": "https://github.com/nodejscn/node-api-cn/issues"
}
homepage
设置软件包的主页。
示例:
{
"homepage": "http://nodejs.cn"
}
version
指定软件包的当前版本。
示例:
"version": "1.0.0"
此属性遵循版本的语义版本控制记法,这意味着版本始终以 3 个数字表示:x.x.x
。
第一个数字是主版本号,第二个数字是次版本号,第三个数字是补丁版本号。
这些数字中的含义是:仅修复缺陷的版本是补丁版本,引入向后兼容的更改的版本是次版本,具有重大更改的是主版本。
license
指定软件包的许可证。
示例:
"license": "MIT"
keywords
此属性包含与软件包功能相关的关键字数组。
示例:
"keywords": [
"email",
"machine learning",
"ai"
]
这有助于人们在浏览相似的软件包或浏览 npm 网站时找到你的软件包。
description
此属性包含了对软件包的简短描述。
示例:
"description": "NodeJS中文网入门教程"
如果要将软件包发布到 npm
,则这个属性特别有用,人们可以知道该软件包是干啥用的。
repository
此属性指定了此程序包仓库所在的位置。
示例:
"repository": "github:nodejscn/node-api-cn",
注意 github
前缀。 其他流行的服务商还包括:
"repository": "gitlab:nodejscn/node-api-cn",
"repository": "bitbucket:nodejscn/node-api-cn",
可以显式地设置版本控制系统:
"repository": {
"type": "git",
"url": "https://github.com/nodejscn/node-api-cn.git"
}
也可以使用其他的版本控制系统:
"repository": {
"type": "svn",
"url": "..."
}
main
设置软件包的入口点。
当在应用程序中导入此软件包时,应用程序会在该位置搜索模块的导出。
示例:
"main": "src/main.js"
private
如果设置为 true
,则可以防止应用程序/软件包被意外发布到 npm
上。
示例:
"private": true
scripts
可以定义一组可以运行的 node 脚本。
示例:
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "npm run dev",
"unit": "jest --config test/unit/jest.conf.js --coverage",
"test": "npm run unit",
"lint": "eslint --ext .js,.vue src test/unit",
"build": "node build/build.js"
}
这些脚本是命令行应用程序。 可以通过调用 npm run XXXX
或 yarn XXXX
来运行它们,其中 XXXX
是命令的名称。 例如:npm run dev
。
可以为命令使用任何的名称,脚本也可以是任何操作。
dependencies
设置作为依赖安装的 npm
软件包的列表。
当使用 npm 或 yarn 安装软件包时:
npm install <PACKAGENAME>
yarn add <PACKAGENAME>
该软件包会被自动地插入此列表中。
示例:
"dependencies": {
"vue": "^2.5.2"
}
devDependencies
设置作为开发依赖安装的 npm
软件包的列表。
它们不同于 dependencies
,因为它们只需安装在开发机器上,而无需在生产环境中运行代码。
当使用 npm 或 yarn 安装软件包时:
npm install --save-dev <PACKAGENAME>
yarn add --dev <PACKAGENAME>
该软件包会被自动地插入此列表中。
示例:
"devDependencies": {
"autoprefixer": "^7.1.2",
"babel-core": "^6.22.1"
}
engines
设置此软件包/应用程序要运行的 Node.js 或其他命令的版本。
示例:
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0",
"yarn": "^0.13.0"
}
browserslist
用于告知要支持哪些浏览器(及其版本)。 Babel、Autoprefixer 和其他工具会用到它,以将所需的 polyfill 和 fallback 添加到目标浏览器。
示例:
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]
命令特有的属性
package.json
文件还可以承载命令特有的配置,例如 Babel、ESLint 等。
每个都有特有的属性,例如 eslintConfig
、babel
等。 它们是命令特有的,可以在相应的命令/项目文档中找到如何使用它们。