幽灵依赖与常见依赖管理
文章目录
- 前言
- 1. 演示：检测和修复幽灵依赖
- 步骤1：安装 depcheck
- 步骤2：在项目根目录运行 depcheck
- 可能的输出
- 步骤3：修复幽灵依赖
- 2. 依赖管理的好习惯
- 1. 场景设定
- 现在有如下依赖需求：
- 2. 依赖冲突的表现
- 3. 解决依赖冲突的方法
- 方法一：统一依赖版本
- 方法二：强制安装多版本（不推荐，除非特殊需求）
- 4. 实际操作演示
- 统一依赖版本
- 5. 检查依赖冲突
- 总结
前言
实际项目中发现和修复幽灵依赖问题，并给出常见依赖管理的好习惯。
1. 演示：检测和修复幽灵依赖
假设你的 package.json 如下（只声明了 lodash）：
{"name": "root","private": true,"workspaces": ["packages/*"],"devDependencies": {"lerna": "^7.1.5"},"volta": {"node": "18.17.1"}
}
假设你在某个包的代码里写了如下内容：
const _ = require('lodash');
const moment = require('moment'); // 实际未声明依赖
步骤1：安装 depcheck
npm install -g depcheck
步骤2：在项目根目录运行 depcheck
depcheck
可能的输出
Missing dependencies
* moment
这说明你的代码用到了 moment，但 package.json 没有声明。
步骤3：修复幽灵依赖
执行：
npm install moment --save
这样 moment 就会被正确声明到 dependencies 里，幽灵依赖问题解决。
2. 依赖管理的好习惯
- 用到什么依赖就声明什么依赖，不要依赖于“间接依赖”。
- 定期用
depcheck或类似工具检查项目依赖的准确性。 - 删除未使用的依赖，保持
package.json干净。 - 对于 Monorepo 项目，每个包都要单独管理自己的依赖。
下面通过一个实际例子，演示在 Monorepo（如你当前的 Lerna + Yarn/NPM Workspaces 项目）下，子包的依赖管理和依赖冲突的解决方法。
1. 场景设定
假设你的 Monorepo 结构如下：
packages/header/package.jsonfooter/package.jsonremixapp/package.json
现在有如下依赖需求：
header依赖react@17.0.2footer依赖react@18.1.0remixapp依赖react@18.1.0
2. 依赖冲突的表现
如果你分别在 header 和 footer 的 package.json 里声明不同版本的 react，再在根目录执行 yarn install 或 npm install，包管理器会尝试“扁平化”依赖，但如果版本冲突无法合并，会出现如下情况：
node_modules/react只会有一个版本（比如 18.1.0），header代码如果用到了 17.x 的特性，可能会报错或行为异常。
3. 解决依赖冲突的方法
方法一：统一依赖版本
最佳实践是在 Monorepo 根目录的 package.json 里统一声明所有子包的公共依赖（如 react），并保证版本一致：
{// ... 其他配置 ..."devDependencies": {"lerna": "^7.1.5","react": "18.1.0","react-dom": "18.1.0"}
}
然后在各子包的 package.json 里去掉对 react 的声明，或者用 peerDependencies 指定兼容范围：
{// ... 其他配置 ..."peerDependencies": {"react": ">=18.0.0","react-dom": ">=18.0.0"}
}
这样，所有包都用同一份 react，避免冲突。
方法二：强制安装多版本（不推荐，除非特殊需求）
如果确实有包必须依赖不同版本，可以在子包的 node_modules 里安装特定版本（但会导致包体积变大，依赖树复杂，维护困难）。
4. 实际操作演示
统一依赖版本
- 在根目录添加依赖：
npm install react@18.1.0 react-dom@18.1.0 --save-dev
- 在子包
footer/package.json里改为 peerDependencies：
// ... 省略 ..."peerDependencies": {"react": ">=18.0.0","react-dom": ">=18.0.0"},
// ... 省略 ...
- 删除子包 dependencies 里的 react/ react-dom，保存后重新安装依赖：
npm install
5. 检查依赖冲突
可以用如下命令检查依赖树：
npm ls react
如果所有包都指向同一个版本，说明依赖冲突已解决。
总结
- Monorepo 下建议在根目录统一管理公共依赖，子包用 peerDependencies 声明兼容范围。
- 避免各子包声明不同版本的同一依赖，否则会出现冲突和幽灵依赖等问题。
- 定期用
npm ls或yarn why检查依赖树，确保依赖一致性。