在lint-staged中正确配置ESLint扁平配置文件格式

当开发者尝试在项目中结合使用lint-staged和ESLint的扁平配置文件格式(eslint.config.js)时，可能会遇到"未找到匹配模式的文件"的错误提示。这种情况通常发生在配置不当的情况下，导致lint-staged无法正确识别和处理暂存区的文件。

问题现象分析

开发者常见的错误配置方式是在.lintstagedrc中直接调用完整的ESLint命令，例如：

{
  "*.{js,json}": [
    "node --run lint:fix"
  ]
}

然后在package.json中定义：

"scripts": {
  "lint:fix": "npx eslint . \"**/*.{js,json}\" --fix"
}

这种配置会导致lint-staged将暂存文件列表作为额外参数传递给ESLint，而ESLint会将这些文件路径视为glob模式来匹配，最终导致找不到文件的错误。

正确配置方法

正确的做法是让lint-staged直接调用ESLint，并让它自动处理暂存文件。lint-staged的设计初衷就是只对暂存区的文件运行检查，而不是整个项目。

简化后的.lintstagedrc配置应为：

{
  "*.{js,json}": "eslint --fix"
}

这样配置后，当开发者暂存了file.js文件时，lint-staged实际执行的命令会是eslint --fix file.js，这正是我们期望的行为。

工作原理解析

1. lint-staged的自动文件传递：lint-staged会自动将匹配模式的文件列表附加到配置的命令后面，因此不需要在命令中指定文件匹配模式。

2. ESLint的扁平配置兼容性：无论是传统的.eslintrc.*配置还是新的eslint.config.js扁平配置，这种调用方式都能正常工作，因为ESLint会正确解析传入的文件路径。

3. 性能优化：只对暂存文件运行检查可以显著提高检查速度，特别是在大型项目中。

最佳实践建议

1. 避免在lint-staged配置中嵌套调用npm脚本，直接使用工具命令更可靠。

2. 对于简单项目，可以直接在package.json中配置lint-staged，无需单独的.lintstagedrc文件。

3. 如果需要对不同类型的文件运行不同的命令，可以扩展配置模式：

{
  "*.js": "eslint --fix",
  "*.json": "prettier --write"
}

通过理解lint-staged的工作原理和正确配置方式，开发者可以避免常见的配置陷阱，确保代码提交前的自动化检查流程顺畅运行。