NPM Package.json 字段列表及示例

NPM Package.json 文件是 Node.js 包的文件，它包含了有关包的信息，例如包的名称、版本、依赖项、脚本等。Package.json 文件是 NPM 包的必备文件，它用于管理和安装 Node.js 包。

Package.json 文件包含的字段有很多，其中一些字段是必填的，而另一些字段是可选的。必填字段包括：

• name ：包的名称。
• version ：包的版本。
• main ：包的主入口文件。

可选字段包括：

• description ：包的。
• keywords ：包的关键词。
• author ：包的作者。
• license ：包的许可证。
• dependencies ：包的依赖项。
• devDependencies ：包的开发依赖项。
• scripts ：包的脚本。

下面列出了一些非官方字段，这些字段不属于 NPM 官方文档，但它们在某些情况下非常有用：

• private ：如果设置为 true，则此包将不会发布到 NPM 注册表。
• homepage ：包的主页 URL。
• bugs ：包的 Bug 跟踪 URL。
• repository ：包的代码仓库 URL。

NPM Package.json 字段列表

字段	类型	必填	描述
name	字符串	是	包的名称
version	字符串	是	包的版本
main	字符串	是	包的主入口文件
description	字符串	否	包的描述
keywords	字符串数组	否	包的关键词
author	字符串或对象	否	包的作者
license	字符串	否	包的许可证
dependencies	对象	否	包的依赖项
devDependencies	对象	否	包的开发依赖项
scripts	对象	否	包的脚本
private	布尔值	否	如果设置为 true，则此包将不会发布到 NPM 注册表
homepage	字符串	否	包的主页 URL
bugs	字符串	否	包的 Bug 跟踪 URL
repository	字符串	否	包的代码仓库 URL

示例

{
  "name": "my-package",
  "version": "1.0.0",
  "main": "index.js",
  "description": "This is my package.",
  "keywords": ["package", "node", "javascript"],
  "author": "John Doe",
  "license": "MIT",
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "mocha": "^9.2.2"
  },
  "scripts": {
    "start": "node index.js",
    "test": "mocha"
  },
  "private": false,
  "homepage": "https://example.com/my-package",
  "bugs": "https://github.com/johndoe/my-package/issues",
  "repository": "https://github.com/johndoe/my-package"
}

如何使用 NPM Package.json 字段

要使用 NPM Package.json 字段，只需在 Package.json 文件中添加相应的字段即可。例如，要添加包的描述，可以将以下代码添加到 Package.json 文件中：

"description": "This is my package."

要添加包的关键词，可以将以下代码添加到 Package.json 文件中：

"keywords": ["package", "node", "javascript"]

要添加包的作者，可以将以下代码添加到 Package.json 文件中：

"author": "John Doe"

以此类推，您可以根据需要添加其他字段。

有关 NPM Package.json 文件的更多信息

有关 NPM Package.json 文件的更多信息，可以参考以下资源：

• NPM Package.json 文档
• 如何编写 NPM Package.json 文件
• NPM Package.json 字段列表