解决 lint-staged 在 Monorepo 中使用路径映射时的模块解析问题

在 monorepo 架构中使用 lint-staged 时，开发者经常会遇到一个典型问题：当项目配置了 TypeScript 的路径映射（如 "@/*": ["./src/*"]）时，lint-staged 会报错"Unable to resolve path to module '@/*'"。

问题根源分析

这个问题的本质在于工作目录（cwd）的解析机制。当使用共享的 ESLint 配置时，工具通常会基于 process.cwd() 来解析 tsconfig 文件。在 monorepo 结构中，如果 lint-staged 从根目录运行，process.cwd() 会返回根目录路径，而不是各个子包的路径，导致路径映射解析失败。

解决方案

1. 使用 --cwd 参数

最直接的解决方案是在运行 lint-staged 时显式指定工作目录：

npx lint-staged --cwd packages/frontend
npx lint-staged --cwd packages/backend

这种方式特别适合与 Husky 配合使用时，可以在 pre-commit 钩子中为每个子包单独运行 lint-staged。

2. 正确的 monorepo 配置方式

更优雅的解决方案是遵循 lint-staged 的 monorepo 支持规范：

1. 在 monorepo 根目录创建配置文件（不能为空）：

// lint-staged.config.cjs
module.exports = {
  '*': 'true' // 必须至少包含一个规则
}

2. 在每个子包中创建各自的配置文件：

// packages/frontend/lint-staged.config.cjs
module.exports = {
  '*.{js,ts,jsx,tsx}': ['eslint --fix', 'prettier --write']
}

3. 配置背后的原理

lint-staged 的 monorepo 支持需要至少两个有效配置文件存在。这是为了保持向后兼容性，因为早期版本就支持在 git 仓库子目录中放置单个配置文件。根目录的配置文件即使不需要实际规则，也必须包含至少一个规则（如使用 true 命令作为占位符），否则工具会以错误代码 1 静默退出。

最佳实践建议

1. 统一配置管理：考虑使用共享的 lint-staged 配置来保持各子包规则的一致性
2. 明确工作目录：对于复杂的 monorepo 结构，建议始终明确指定工作目录
3. 错误排查：如果遇到路径解析问题，首先检查 process.cwd() 的返回值是否符合预期
4. 文档参考：虽然本文不包含链接，但建议开发者详细阅读 lint-staged 的 monorepo 支持文档

通过正确配置，lint-staged 可以完美支持 monorepo 结构下的路径映射，为大型项目的前端代码质量保障提供可靠支持。