如何解决npm install安装依赖时出现的peer依赖版本冲突报错

完整报错日志 #

npm ERR! While resolving: netflex@0.0.0
npm ERR! Found: react@16.14.0
npm ERR! node_modules/react
npm ERR!   react@"^16.13.1" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^17.0.1" from hst-react-components-lib@1.0.48
npm ERR! node_modules/***hst
npm ERR!   hst-react-components-lib@"^1.0.47" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.

报错含义 #

npm 7+ 版本默认开启了*对等依赖（peerDependencies）*版本强制校验，和npm 6版本自动忽略对等依赖不匹配的逻辑不同，当依赖之间的对等依赖要求出现版本冲突时会直接终止安装。
本次冲突的具体原因：

• 项目根目录明确依赖react@^16.13.1，当前已安装版本为react 16.14.0
• 项目依赖的hst-react-components-lib@1.0.48组件库，要求其对等依赖react版本必须为^17.0.1
  两个react版本要求不兼容，因此npm抛出报错阻止安装流程。

解决方法 #

可根据项目实际情况选择以下任意一种方案：

• 升级项目react版本（最推荐）
  将项目package.json中react、react-dom的版本号修改为^17.0.1，保存后重新执行npm install即可，从根源解决版本冲突，无潜在兼容风险。
• 跳过对等依赖校验（临时兼容）
  执行安装命令时添加--legacy-peer-deps参数，沿用npm 6的依赖安装逻辑，忽略本次对等依赖冲突：

  npm install --legacy-peer-deps
  

  只要确认该版本组件库在react 16环境下可正常运行，该方案风险极低。
• 锁定组件库旧版本
  如果你确认此前正常运行时使用的hst-react-components-lib版本支持react 16，可以将package.json中该依赖的版本号修改为固定的旧版本号，去掉版本号前的^前缀，避免自动升级到要求react 17的新版，保存后重新执行npm install即可。
• 强制安装（不推荐）
  执行npm install --force强制重写冲突的依赖项，该操作可能会引入不可预期的兼容问题，仅建议明确知道冲突影响时使用。

内容的提问来源于stack exchange，提问作者Rashmi UI