ESLint 中 CLI 单规则检查 TypeScript 文件的解决方案

在大型代码库中逐步升级 ESLint 规则时，开发者常常需要针对单个规则进行检查和自动修复。本文深入分析了在 ESLint 9.18.0 版本中使用 CLI 命令检查 TypeScript 文件时遇到的问题及其解决方案。

问题背景

当开发者尝试通过 CLI 命令仅检查单个规则时，特别是针对 TypeScript 文件（.ts 扩展名），ESLint 会报告"所有匹配的文件都被忽略"的错误。这是因为：

1. 默认情况下，ESLint 仅配置了 .js、.cjs 和 .mjs 文件的检查
2. TypeScript 文件需要额外的解析器和插件配置
3. 在 flat config 模式下，文件匹配规则更加严格

技术分析

问题的核心在于 ESLint 的配置机制：

1. 文件匹配机制：ESLint 新配置系统基于文件模式匹配，没有为 TypeScript 文件设置默认模式
2. 配置继承：旧版配置系统会将所有规则应用于传入的文件，而新版则更精确地按文件模式应用
3. CLI 参数限制：通过 CLI 传递的规则和配置仅适用于默认支持的文件类型

解决方案

临时解决方案（推荐）

创建自定义配置文件，通过环境变量指定要检查的单个规则：

// eslint.one-rule.config.js
import eslint from "@eslint/js";
import tseslint from "typescript-eslint";

export default tseslint.config(
  eslint.configs.recommended,
  tseslint.configs.recommended,
  {
    languageOptions: {
      parserOptions: {
        project: "tsconfig.json",
      },
    },
    rules: {
      [process.env.ONE_RULE]: "error",
    },
  }
);

然后通过命令运行：

ONE_RULE="typescript-eslint/consistent-type-exports" eslint --config eslint.one-rule.config.js

未来解决方案

ESLint 团队已决定在未来的版本中重新引入 --ext CLI 选项，该选项将：

1. 允许开发者明确指定要检查的文件扩展名
2. 自动为指定扩展名添加文件匹配模式
3. 保持与旧版 ESLint 的兼容性

最佳实践建议

1. 对于复杂的检查需求，建议使用配置文件而非 CLI 参数
2. 在大型项目中，考虑建立规则升级的自动化流程
3. 逐步升级规则时，可以利用 ESLint 的 --fix 选项配合单个规则检查
4. 对于 TypeScript 项目，确保正确配置解析器和类型检查选项

通过理解 ESLint 的配置机制和采用适当的解决方案，开发者可以有效地在大型代码库中实施精细化的规则检查和升级策略。