如何编写含可选peerDependency且测试代码依赖它的Node.js包？

依赖关系说明 #

• 宿主应用（App）：将canvas作为可选依赖
• 我的插件包：将canvas作为可选peer依赖
• 我的插件包测试代码：直接依赖canvas

官方文档关于peerDependency的核心描述：

插件包旨在与另一个“宿主”包配合使用，尽管它并非总是直接使用宿主包。

当前package.json配置 #

{
  // ...
  "devDependencies": {
    "canvas": "^2.11.2"
  },
  "peerDependencies": {
    "canvas": "^2.11.2",
    "jsdom": "^24.0.0"
  },
  "peerDependenciesMeta": {
    "canvas": {
      "optional": true
    }
  }
}

配置正确性分析 #

该配置整体是正确的，具体分析如下：

1. 测试依赖处理合理：把canvas放在devDependencies下，既满足测试代码对canvas的直接依赖需求，又不会让该依赖被强制要求用户安装或打包到生产环境。
2. 可选peer依赖配置合规：
   • 在peerDependencies中声明canvas的版本范围，清晰告知用户插件包与canvas的兼容版本区间
   • 通过peerDependenciesMeta将canvas标记为optional: true，完美实现“可选peer依赖”的要求——宿主应用即使不安装canvas，也能正常使用你的插件包
3. 注意事项：当前配置里jsdom仅在peerDependencies中声明，未在peerDependenciesMeta标记为可选，这意味着宿主应用必须安装符合^24.0.0版本要求的jsdom才能使用你的插件包。如果jsdom同样是可选依赖，需要补充对应的配置：

   "peerDependenciesMeta": {
     "canvas": {
       "optional": true
     },
     "jsdom": {
       "optional": true
     }
   }
   

内容的提问来源于stack exchange，提问作者Daniel Kaplan