lint-staged 如何处理已删除文件的问题分析与解决方案

问题背景

在使用 lint-staged 进行 Git 预提交钩子管理时，开发者发现了一个关键问题：当提交中包含被删除的文件时，lint-staged 不会对这些文件执行配置的脚本。这在实际开发中可能导致构建结果不完整，特别是在需要根据源代码变更重新构建分发(dist)目录的情况下。

问题重现

在典型的开发场景中，开发者可能会：

1. 删除 src/ 目录下的某些文件
2. 期望 lint-staged 触发构建脚本重新生成 dist/ 目录
3. 但实际发现 lint-staged 跳过了这些被删除文件的处理

通过调试日志可以看到，lint-staged 明确显示跳过了对已删除文件的处理：

[STARTED] ./src/**/* — 0 files
[SKIPPED] ./src/**/* — no files

技术原因分析

lint-staged 默认使用 git diff 的 --diff-filter 参数来检测变更文件，其默认值为 ACMR，代表：

• A: 新增文件(Added)
• C: 复制文件(Copied)
• M: 修改文件(Modified)
• R: 重命名文件(Renamed)

默认配置中不包含 D(Deleted)，因此被删除的文件不会被 lint-staged 捕获和处理。这种设计是有意为之的，因为大多数代码检查工具(如 ESLint、Prettier)无法对不存在的文件执行操作。

解决方案

方案一：修改 diff-filter 参数

可以通过在运行 lint-staged 时添加 --diff-filter 参数来包含已删除文件：

npx lint-staged --diff-filter="ACMRD"

这将使 lint-staged 也处理被删除的文件(D)。可以根据实际需要组合不同的过滤器值。

方案二：配置文件调整

在项目的 package.json 或 lint-staged 配置文件中，可以指定 diffFilter 选项：

{
  "lint-staged": {
    "diffFilter": "ACMRD",
    "*.js": "eslint"
  }
}

方案三：确保总有非删除变更

如果构建脚本必须运行，可以确保每次提交至少包含一个非删除的变更。例如，可以：

1. 在删除文件的同时修改另一个文件
2. 添加一个空行到 README 等不影响功能的文件

最佳实践建议

1. 理解构建依赖：明确哪些操作依赖于文件删除事件，评估是否真的需要在预提交阶段处理

2. 分层处理：

   • 对代码风格检查保持默认的 ACMR 过滤
   • 对构建任务使用包含 D 的过滤器

3. 配置示例：

// .lintstagedrc.js
module.exports = {
  'src/**/*.{js,ts}': ['eslint --fix', 'prettier --write'],
  'src/**/*': {
    'diffFilter': 'ACMRD',
    'commands': () => ['npm run build']
  }
}

4. 测试验证：创建专门的测试用例验证删除文件时的构建行为

深入思考

这个问题反映了工具链设计中的一个常见权衡：默认安全性与功能完备性。lint-staged 选择了更安全的默认行为，避免在文件不存在时调用可能出错的分析工具。开发者需要根据实际场景调整这一行为。

对于复杂的构建系统，可能需要考虑：

1. 将构建步骤从预提交钩子移到 CI 流程中
2. 使用文件系统监听工具而非 Git 变更检测
3. 实现自定义的变更检测逻辑

理解这一机制有助于开发者更好地设计他们的提交前工作流，确保构建结果的准确性。