ESLint 配置中如何正确处理 JavaScript 文件的默认检查行为

在 ESLint 的日常使用中，许多开发者会遇到一个看似奇怪的现象：明明在配置中只指定了对 TypeScript 文件（.ts 和 .tsx）的检查规则，但实际运行时 ESLint 仍然会对 JavaScript 文件（.js）进行检查。这种现象在从传统配置迁移到新的扁平化配置（Flat Config）后尤为常见。

问题现象

当开发者使用 ESLint 的扁平化配置时，可能会编写类似下面的配置：

export default [
  {
    files: ["**/*.ts", "**/*.tsx"],
    // 其他配置...
  }
]

按照直觉理解，这样的配置应该只会检查 TypeScript 文件。然而实际上，ESLint 仍然会检查项目中的 JavaScript 文件，这常常让开发者感到困惑。

根本原因

这种现象并非 ESLint 的 bug，而是其设计上的有意行为。ESLint 默认会对三种 JavaScript 文件格式进行检查：

1. .js 文件（标准 JavaScript 文件）
2. .mjs 文件（ES 模块 JavaScript 文件）
3. .cjs 文件（CommonJS 模块 JavaScript 文件）

这种默认行为是为了保持向后兼容性，确保传统项目在迁移到新配置时不会突然停止检查 JavaScript 文件。

解决方案

要真正排除对 JavaScript 文件的检查，需要在配置中添加全局忽略规则。正确的做法是：

export default [
  {
    files: ["**/*.ts", "**/*.tsx"],
    // TypeScript 相关配置...
  },
  {
    ignores: ["**/*.js"] // 全局忽略 JavaScript 文件
  }
]

这种配置方式明确告诉 ESLint：除了检查指定的 TypeScript 文件外，还要忽略所有 JavaScript 文件。

实际应用场景

这种配置方式在以下场景特别有用：

1. 纯 TypeScript 项目：当项目完全使用 TypeScript 编写时，通常不需要检查编译后的 JavaScript 文件。

2. 混合语言项目：当项目中同时包含需要检查和不需检查的 JavaScript 文件时，可以通过更精确的忽略模式来控制。

3. 构建产物处理：可以避免对构建工具生成的 JavaScript 文件进行不必要的检查。

配置建议

对于不同类型的项目，可以考虑以下配置策略：

1. 纯 TypeScript 项目：

   export default [
     {
       files: ["**/*.ts", "**/*.tsx"],
       // TypeScript 配置
     },
     {
       ignores: ["**/*.js", "**/*.mjs", "**/*.cjs"]
     }
   ]
   

2. 混合 JavaScript/TypeScript 项目：

   export default [
     {
       files: ["**/*.ts", "**/*.tsx"],
       // TypeScript 配置
     },
     {
       files: ["**/*.js"],
       // JavaScript 配置
     },
     {
       ignores: ["dist/**/*.js"] // 只忽略构建目录
     }
   ]
   

迁移注意事项

从传统配置迁移到扁平化配置时，需要注意：

1. 传统配置中的 --ext CLI 参数功能在扁平化配置中不再适用，必须通过配置文件实现类似效果。

2. 传统 .eslintignore 文件的功能现在应该通过配置中的 ignores 属性实现。

3. 检查范围的变化可能会影响持续集成流程，需要相应调整。

理解 ESLint 的这种默认行为，可以帮助开发者更精确地控制代码检查范围，避免不必要的检查或遗漏重要文件的检查。正确配置文件检查范围不仅能提高检查效率，还能确保代码质量控制的准确性。