npm——Peer dependencies

Peer dependencies 是 npm 包管理中的一个概念，用于指定当前包依赖的其他包，但这些依赖包并不是直接安装在当前项目的 node_modules 目录下，而是期望它们已经存在于父模块或更高层级的 node_modules 目录中。

主要用途

• 插件系统：例如，React 插件可能需要 React 作为 peer dependency，以确保插件使用的 React 版本与项目中已有的 React 版本一致。
• 避免版本冲突：通过 peer dependencies，可以避免多个包安装不同版本的同一依赖，从而减少潜在的兼容性问题。

定义方式

在 package.json 文件中，可以通过 peerDependencies 字段来定义：

{
  "name": "my-plugin",
  "version": "1.0.0",
  "peerDependencies": {
    "react": "^16.8.0"
  }
}

安装行为

• 当用户安装一个带有 peer dependencies 的包时，npm 会检查当前项目中是否已经安装了这些 peer dependencies。
• 如果没有安装，npm 会提示用户手动安装这些依赖。
• 如果已经安装了，但版本不匹配，npm 也会发出警告。

示例

假设有一个 React 插件 react-my-plugin，它需要 React 16.8.0 或更高版本作为 peer dependency：

{
  "name": "react-my-plugin",
  "version": "1.0.0",
  "peerDependencies": {
    "react": "^16.8.0"
  }
}

当用户在项目中安装 react-my-plugin 时，npm 会检查项目中是否已经安装了符合要求的 React 版本。如果没有安装，npm 会提示用户安装；如果版本不匹配，npm 会发出警告。

总结

Peer dependencies 是一种机制，用于确保包的依赖项在项目中已经存在，并且版本符合要求，从而避免版本冲突和兼容性问题。