package.json

包的清单文件。它包含了包的所有元数据，包括依赖项、标题、作者等。这是所有主要 Node.js 包管理器（包括 pnpm）都遵循的标准。

除了传统的 package.json 格式外，pnpm 还支持 package.json5（通过 json5）和 package.yaml（通过 js-yaml）。

engines

你可以指定你的软件适用的 Node 和 pnpm 版本：

{
    "engines": {
        "node": ">=10",
        "pnpm": ">=3"
    }
}

在本地开发时，如果 pnpm 的版本与 engines 字段中指定的版本不匹配，pnpm 将始终以错误消息失败。

除非用户设置了 engineStrict 配置标志（参见 settings），否则当你的包作为依赖项安装时，此字段仅作为建议，只会产生警告。

dependenciesMeta

用于 dependencies、optionalDependencies 和 devDependencies 中声明的依赖项的其他元信息。

dependenciesMeta.*.injected

如果对于作为本地工作空间包的依赖项将此设置为 true，该包将通过在虚拟存储（node_modules/.pnpm）中创建硬链接副本的方式安装。

如果将其设置为 false 或未设置，则依赖项将通过创建指向工作空间中包的源目录的 node_modules 符号链接来安装。这是默认设置，因为它更快，并确保对依赖项的任何修改都会立即对其使用者可见。

例如，假设以下 package.json 是一个本地工作空间包：

{
  "name": "card",
  "dependencies": {
    "button": "workspace:1.0.0"
  }
}

button 依赖项通常会通过在 card 的 node_modules 目录中创建一个指向 button 开发目录的符号链接来安装。

但如果 button 在其 peerDependencies 中指定了 react 呢？如果 monorepo 中的所有项目都使用相同版本的 react，那么就没有问题。但是如果 button 被使用 react@16 的 card 和使用 react@17 的 form 所依赖会怎样？通常你必须选择一个单一版本的 react 并在 button 的 devDependencies 中指定它。符号链接无法让 react 对等依赖被不同的使用者（如 card 和 form）以不同的方式满足。

injected 字段通过在虚拟存储中安装 button 的硬链接副本来解决这个问题。为此，card 的 package.json 可以配置如下：

{
  "name": "card",
  "dependencies": {
    "button": "workspace:1.0.0",
    "react": "16"
  },
  "dependenciesMeta": {
    "button": {
      "injected": true
    }
  }
}

而 form 的 package.json 可以配置如下：

{
  "name": "form",
  "dependencies": {
    "button": "workspace:1.0.0",
    "react": "17"
  },
  "dependenciesMeta": {
    "button": {
      "injected": true
    }
  }
}

通过这些更改，我们说 button 是 card 和 form 的"注入依赖项"。当 button 导入 react 时，在 card 的上下文中它会解析为 react@16，但在 form 的上下文中会解析为 react@17。

由于注入的依赖项会产生其工作空间源目录的副本，每当代码被修改时，这些副本都必须更新；否则，新状态将不会反映给使用者。当使用 pnpm --recursive run build 等命令构建多个项目时，这个更新必须在每个注入的包重新构建之后但在其使用者重新构建之前进行。对于简单的用例，可以通过再次调用 pnpm install 来完成，可能使用 package.json 生命周期脚本（如 "prepare": "pnpm run build"）来重新构建那个项目。第三方工具如 pnpm-sync 和 pnpm-sync-dependencies-meta-injected 提供了更稳健和高效的解决方案来更新注入的依赖项，并支持监视模式。

peerDependenciesMeta

此字段列出了与 peerDependencies 字段中列出的依赖项相关的一些额外信息。

peerDependenciesMeta.*.optional

如果将此设置为 true，选定的对等依赖项将被包管理器标记为可选。因此，消费者省略它将不再被报告为错误。

例如：

{
    "peerDependencies": {
        "foo": "1"
    },
    "peerDependenciesMeta": {
        "foo": {
            "optional": true
        },
        "bar": {
            "optional": true
        }
    }
}

注意，即使 bar 未在 peerDependencies 中指定，它也被标记为可选。因此，pnpm 会认为 bar 的任何版本都可以。 然而，foo 是可选的，但仅限于所需的版本规范。

publishConfig

在打包之前可以覆盖清单中的某些字段。 以下字段可以被覆盖：

• bin
• main
• exports
• types 或 typings
• module
• browser
• esnext
• es2015
• unpkg
• umd:main
• typesVersions
• cpu
• os

要覆盖一个字段，请将该字段的发布版本添加到 publishConfig 中。

例如，以下 package.json：

{
    "name": "foo",
    "version": "1.0.0",
    "main": "src/index.ts",
    "publishConfig": {
        "main": "lib/index.js",
        "typings": "lib/index.d.ts"
    }
}

将被发布为：

{
    "name": "foo",
    "version": "1.0.0",
    "main": "lib/index.js",
    "typings": "lib/index.d.ts"
}

publishConfig.executableFiles

默认情况下，出于可移植性考虑，除了 bin 字段中列出的文件外，生成的包存档中的文件都不会被标记为可执行文件。executableFiles 字段允许你声明必须设置可执行标志（+x）的其他文件，即使它们不能直接通过 bin 字段访问。

{
  "publishConfig": {
    "executableFiles": [
      "./dist/shim.js"
    ]
  }
}

publishConfig.directory

你也可以使用 publishConfig.directory 字段来自定义相对于当前 package.json 的发布子目录。

在指定的目录中应该有当前包的修改版本（通常使用第三方构建工具）。

在这个例子中，"dist" 文件夹必须包含一个 package.json

{
  "name": "foo",
  "version": "1.0.0",
  "publishConfig": {
    "directory": "dist"
  }
}

publishConfig.linkDirectory

• 默认值：true
• 类型：Boolean

当设置为 true 时，项目将在本地开发期间从 publishConfig.directory 位置进行符号链接。

例如：

{
  "name": "foo",
  "version": "1.0.0",
  "publishConfig": {
    "directory": "dist",
    "linkDirectory": true
  }
}