NPM依赖冲突时，为什么要选择--legacy-peer-deps，而不是--force？

NPM依赖冲突时，为什么要选择--legacy-peer-deps，而不是--force？

原文链接：https://dev.to/just_ritik/why-legacy-peer-deps-is-better-than-force-in-npm-p44
作者：Ritik Pal
译者：倔强青铜三

前言

大家好，我是倔强青铜三。是一名热情的软件工程师，我热衷于分享和传播IT技术，致力于通过我的知识和技能推动技术交流与创新，欢迎关注我，微信公众号：倔强青铜三。欢迎点赞、收藏、关注，一键三连！！！

在管理 Node.js 项目中的依赖时，有时会遇到安装包时出现冲突或警告，这通常是由对等依赖（peer dependencies）问题引起的。开发者通常会使用 --legacy-peer-deps 或 --force 选项来解决这些问题。虽然这两种方法都能暂时解决问题，但 --legacy-peer-deps 通常更安全、更可靠。让我们深入探讨这些选项、它们的使用场景以及为什么应该优先选择 --legacy-peer-deps。

什么是对等依赖？

在 npm 中，对等依赖是一种方式，用于指定一个包依赖于特定版本的另一个包。它不会自行安装依赖，而是确保使用它的项目已经安装了适当的版本。在 React 等生态系统中很常见，库通常依赖于特定版本的 React，以避免兼容性问题。

例如：

{
  "peerDependencies": {
    "react": "^17.0.0"
  }
}

当尝试安装具有冲突的对等依赖的包时，npm 可能会抛出错误或警告。

--legacy-peer-deps 标志

--legacy-peer-deps 标志告诉 npm 忽略对等依赖冲突，并以与较旧的 npm 版本（npm 7 之前）相同的方式安装依赖。这种方法不会严格强制对等依赖解析，这可以帮助避免安装失败，同时保留依赖树的整体完整性。

使用 --legacy-peer-deps 的好处

1. 兼容性：

   • 保留与较旧包版本的兼容性，这些包可能尚未更新其对等依赖要求以适应 npm 7+。

2. 受控的灵活性：

   • 虽然忽略对等依赖错误，但仍尊重依赖树的层次结构和结构。

3. 降低风险：

   • 通过不过度覆盖依赖，避免可能的破坏性更改或项目不稳定。

4. 更适合团队合作：

   • 为团队提供更可预测的环境，因为依赖解析更接近 npm 的原始行为。

--force 标志

--force 标志在 npm 中的作用就像它的名字一样：它强制 npm 安装包，覆盖任何冲突，包括对等依赖和版本不匹配。虽然这可能看起来是快速解决方法，但它伴随着重大风险。

使用 --force 的风险

1. 破坏性更改：

   • 强制覆盖依赖可能导致安装不兼容版本，导致运行时错误或意外行为。

2. 不可预测的行为：

   • 依赖于特定版本对等依赖的依赖项可能无法正常工作，导致应用程序不稳定。

3. 难以调试：

   • 强制安装的包可能导致难以追踪的微妙错误，因为依赖树可能不符合包的预期。

4. 团队合作中的潜在冲突：

   • 使用 --force 可能会使复制环境更加困难，尤其是在团队工作或部署到不同环境时。

5. 技术债务：

   • 忽略警告和冲突可能会在项目中引入长期技术债务，使未来的升级或维护更加困难。

何时使用每个标志

使用 --legacy-peer-deps 时：

• 您正在处理尚未更新其对等依赖要求的旧包。
• 您希望避免破坏性更改，同时保持一定程度的依赖完整性。
• 您正在安装特定的包，对等依赖警告阻止了安装。

避免使用 --force 除非：

• 您别无选择，并且了解风险。
• 您正在临时环境中工作，例如调试或测试。
• 您计划立即解决依赖冲突的根本原因。

示例：解决冲突

假设您正在尝试安装一个依赖于 React 17 的库，但您的项目使用 React 18。以下是这两个标志的行为：

使用 --legacy-peer-deps：

npm install some-library --legacy-peer-deps

• 安装库时忽略 React 版本不匹配。
• 保留现有的 React 18 版本，避免强制降级或升级依赖。

使用 --force：

npm install some-library --force

• 忽略所有依赖冲突并安装库，可能会覆盖 React 版本或破坏其他包。

为什么 --legacy-peer-deps 是更好的选择

• 更安全的解析：它避免了覆盖依赖的野蛮方法，最小化破坏应用程序的风险。
• 保持对等依赖逻辑：通过忽略冲突而不覆盖，它尊重对等依赖的意图。
• 团队友好：为协作和部署提供更可预测和稳定的环境。
• 前瞻性：减少引入技术债务的可能性，使维护和升级项目在未来更加容易。

最佳实践

1. 了解您的依赖：

   • 查看对等依赖要求，并尽可能手动解决冲突。

2. 定期升级包：

   • 保持依赖最新，以避免与较新的 npm 版本的兼容性问题。

3. 使用工具：

   • 使用 npm ls 等工具检查依赖树并识别潜在冲突。

4. 记录决策：

   • 如果您使用 --legacy-peer-deps 或 --force，在项目的 README 或相关文件中记录决策，以便将来参考。

结论

虽然 --legacy-peer-deps 和 --force 都可以帮助解决依赖冲突，但在大多数情况下，--legacy-peer-deps 是更好的选择。它在解决问题和维护依赖树的完整性之间取得了平衡，确保了开发的稳定性和可预测性。只有在没有其他解决方案的情况下才应保留 --force，并总是谨慎行事。通过理解和精心管理您的依赖，您可以避免冲突的陷阱，构建更可维护的项目。

最后感谢阅读！欢迎关注我，微信公众号：倔强青铜三。欢迎点赞、收藏、关注，一键三连！！！