package.json

重要字段

nameversionpackage.json 文件里最重要的两个字段,没有它们你的包无法被安装。 nameversion 字段一起用来创建一个唯一 id。

name

{
  "name": "my-awesome-package"
}

这是你的包的名字。它在 URL 中、作为命令行参数、作为 node_modules 里的目录名使用。

yarn add [name]
node_modules/[name]


https://registry.npmjs.org/[name]/-/[name]-[version].tgz

规则

  • 必须少于或等于 214 个字符(对于限定域的包来说包括 @scope/)。
  • 不能以句点 (.) 或者下划线 (_) 开头。
  • 名字里不能有大写字母。
  • 必须只使用 URL 安全的字符。

Tips

  • 不要使用和 Node.js 核心模块相同的名字。
  • 不要在名字里包含 js 或者 node 单词。
  • 短小精悍,让人看到名字就大概了解包的功能,记住它也会被用在 require() 调用里。
  • 保证名字在 registry 里是唯一的。

version

{
  "version": "1.0.0"
}

包的当前版本号。

信息类字段

description

{
  "description": "我的包的简短描述"
}

Description 是帮助使用者了解包的功能的字符串,包管理器也会把这个字符串作为搜索关键词。

keywords

{
  "keywords": ["short", "relevant", "keywords", "for", "searching"]
}

关键字是一个字符串数组,当在包管理器里搜索包时很有用。

license

{
  "license": "MIT",
  "license": "(MIT or GPL-3.0)",
  "license": "SEE LICENSE IN LICENSE_FILENAME.txt",
  "license": "UNLICENSED"
}

所有包都应该指定许可证,以便让用户了解他们是在什么授权下使用此包,以及此包还有哪些附加限制。

鼓励使用开源 (OSI-approved) 许可证,除非你有特别的原因不用它。 如果你开发的包是你工作的一部分,最好和公司讨论后再做决定。

license字段必须是以下之一:

  • 如果你使用标准的许可证,需要一个有效地 SPDX 许可证标识
  • 如果你用多种标准许可证,需要有效的 SPDX 许可证表达式2.0语法表达式
  • 如果你使用非标准的许可证,一个 SEE LICENSE IN <文件名> 字符串指向你的包里顶级目录的一个 <文件名>
  • 如果你不想在任何条款下授权其他人使用你的私有或未公开的包,一个 UNLICENSED 字符串。

链接类字段

各种指向项目文档、issues 上报,以及代码托管网站的链接字段。

homepage

{
  "homepage": "https://your-package.org"
}

homepage 是包的项目主页或者文档首页。

bugs

{
  "bugs": "https://github.com/user/repo/issues"
}

问题反馈系统的 URL,或者是 email 地址之类的链接。用户通过该途径向你反馈问题。

repository

{
  "repository": { "type": "git", "url": "https://github.com/user/repo.git" },
  "repository": "github:user/repo",
  "repository": "gitlab:user/repo",
  "repository": "bitbucket:user/repo",
  "repository": "gist:a1b2c3d4e5f"
}

repository 是代码托管的位置。

项目维护类字段

项目的维护者。

author

{
  "author": {
    "name": "Your Name",
    "email": "you@example.com",
    "url": "http://your-website.com"
  },
  "author": "Your Name <you@example.com> (http://your-website.com)"
}

作者信息,一个人。

contributors

{
  "contributors": [
    { "name": "Your Friend", "email": "friend@example.com", "url": "http://friends-website.com" }
    { "name": "Other Friend", "email": "other@example.com", "url": "http://other-website.com" }
  ],
  "contributors": [
    "Your Friend <friend@example.com> (http://friends-website.com)",
    "Other Friend <other@example.com> (http://other-website.com)"
  ]
}

贡献者信息,可能很多人。

文件类信息

指定包含在项目中的文件,以及项目的入口文件。

files

{
  "files": ["filename.js", "directory/", "glob/*.{js,json}"]
}

项目包含的文件,可以是单独的文件、整个文件夹,或者通配符匹配到的文件。

main

{
  "main": "filename.js"
}

项目的入口文件。

bin

{
  "bin": "bin.js",
  "bin": {
    "command-name": "bin/command-name.js",
    "other-command": "bin/other-command"
  }
}

随着项目一起被安装的可执行文件。

man

{
  "man": "./man/doc.1",
  "man": ["./man/doc.1", "./man/doc.2"]
}

和项目相关的文档页面(man page)。

directories

{
  "directories": {
    "lib": "path/to/lib/",
    "bin": "path/to/bin/",
    "man": "path/to/man/",
    "doc": "path/to/doc/",
    "example": "path/to/example/"
  }
}

当你的包安装时,你可以指定确切的位置来放二进制文件、man pages、文档、例子等。

任务类字段

包里还可以包含一些可执行脚本或者其他配置信息。

scripts

{
  "scripts": {
    "build-project": "node build-project.js"
  }
}

脚本是定义自动化开发相关任务的好方法,比如使用一些简单的构建过程或开发工具。 在 "scripts" 字段里定义的脚本,可以通过 yarn run <script> 命令来执行。 例如,上述 build-project 脚本可以通过 yarn run build-project 调用,并执行 node build-project.js

有一些特殊的脚本名称。 如果定义了 preinstall 脚本,它会在包安装前被调用。 出于兼容性考虑,installpostinstallprepublish 脚本会在包完成安装后被调用。

start 脚本的默认值为 node server.js

config

{
  "config": {
    "port": "8080"
  }
}

配置你的脚本的选项或参数。

依赖描述类字段

你的包很可能依赖其他包。你可以在你的 package.json 文件里指定那些依赖。

dependencies

{
  "dependencies": {
    "package-1": "^3.1.4"
  }
}

这些是你的包的开发版和发布版都需要的依赖。

你可以指定一个确切的版本、一个最小的版本 (比如 >=) 或者一个版本范围 (比如 >= ... <)。

devDependencies

{
  "devDependencies": {
    "package-2": "^0.4.2"
  }
}

这些是只在你的包开发期间需要,但是生产环境不会被安装的包。

peerDependencies

{
  "peerDependencies": {
    "package-3": "^2.7.18"
  }
}

平行依赖允许你说明你的包和其他包版本的兼容性。

optionalDependencies

{
  "optionalDependencies": {
    "package-5": "^1.6.1"
  }
}

可选依赖可以用于你的包,但不是必需的。如果可选包没有找到,安装还可以继续。

bundledDependencies

{
  "bundledDependencies": ["package-4"]
}

打包依赖是发布你的包时将会一起打包的一个包名数组。

flat

{
  "flat": true
}

如果你的包只允许给定依赖的一个版本,你想强制和命令行上 yarn install --flat 相同的行为,把这个值设为 true

请注意,如果你的 package.json 包含 "flat": true 并且其它包依赖你的包 (比如你在构建一个库,而不是应用), 其它那些包也需要在它们的 package.json 加上 "flat": true,或者在命令行上用 yarn install --flat 安装。

resolutions

{
  "resolutions": {
    "transitive-package-1": "0.0.29",
    "transitive-package-2": "file:./local-forks/transitive-package-2",
    "dependencies-package-1/transitive-package-3": "^2.1.1"
  }
}

允许您覆盖特定嵌套依赖项的版本。 有关完整规范,请参见选择性版本解析 RFC

注意,yarn install --flat 命令将会自动在 package.json 文件里加入 resolutions 字段。

系统

你可以提供和你的包关联的系统级的信息,比如操作系统兼容性之类。

engines

{
  "engines": {
    "node": ">=4.4.7 <7.0.0",
    "zlib": "^1.2.8",
    "yarn": "^0.14.0"
  }
}

engines 指定使用你的包客户必须使用的版本,这将检查 process.versions 以及当前 yarn 版本。

此检查遵守正常的 semver 规则,但有一个例外。 It allows prerelease versions to match semvers that do not explicitly specify a prerelease. For example, 1.4.0-rc.0 matches >=1.3.0, while it would not match a typical semver check.

os

{
  "os": ["darwin", "linux"],
  "os": ["!win32"]
}

此选项指定你的包的操作系统兼容性,它会检查 process.platform

cpu

{
  "cpu": ["x64", "ia32"],
  "cpu": ["!arm", "!mips"]
}

使用这个选项指定你的包将只能在某些 CPU 体系架构上运行,这会检查 process.arch

发布

private

{
  "private": true
}

如果你不想你的包发布到包管理器,设置为 true

publishConfig

{
  "publishConfig": {
    ...
  }
}

这些配置值将在你的包发布时使用。比如,你可以给包打标签。