为何ESLint未忽略指定目录？求解决方案

问题概述 #

在项目根目录运行ESLint时，.eslintignore中指定的目录未被正确忽略，导致工具扫描到无关文件并抛出大量错误。

相关配置文件 #

.eslintignore 内容 #

.git
.vscode
node_modules
dist
typedoc
__tests__/coverage

.eslintrc.cjs 内容 #

module.exports = {
  root: true,
  env: {
    node: true,
    es2020: true
  },
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended'
  ],
  parser: '@typescript-eslint/parser',
  rules: {
    '@typescript-eslint/no-var-requires': ["off"],
    "@typescript-eslint/no-explicit-any": ["off"],
    'array-bracket-spacing': ['error', 'never'],
    '@typescript-eslint/consistent-type-imports': ['error', {
      'prefer': 'type-imports'
    }]
    // new rules goes here
  }
}

执行的ESLint命令 #

eslint . -c .eslintrc.cjs --ext js,jsx,ts,tsx --max-warnings 0

错误输出示例 #

typedocs/assets/main.js:2:2271
  ✖  2:2271   Unexpected aliasing of this to local variable.  @typescript-eslint/no-this-alias
  ✖  2:2288   Unexpected aliasing of this to local variable.  @typescript-eslint/no-this-alias
  ✖  2:3495   Unnecessary escape character: \-.               no-useless-escape
  ✖  3:4165   E is already defined.                           no-redeclare
  ✖  3:4312   E is already defined.                           no-redeclare
  ✖  3:4361   E is already defined.                           no-redeclare
...
  ✖  5:2943   document is not defined.                        no-undef
  ✖  5:3096   document is not defined.                        no-undef
  ✖  5:3179   window is not defined.                          no-undef

typedocs/assets/navigation.js:1:1
  ✖  1:1      window is not defined.                          no-undef

typedocs/assets/search.js:1:1
  ✖  1:1      window is not defined.                          no-undef

102 errors

已尝试的操作 #

• 删除dist/和typedoc/目录后无检测错误
• 不存在.eslintcache缓存文件
• 使用typedoc/**这类glob模式配置仍无效
• 目标目录已添加至.gitignore

解决建议 #

1. 修正目录名称拼写：从错误输出可见，实际生成的目录是typedocs（末尾带s），但.eslintignore中配置的是typedoc（无s），这是导致忽略失效的核心原因。将.eslintignore中的typedoc改为typedocs即可解决。
2. 规范.eslintignore格式：确保文件内每一行无前置空格，目录名称单独占一行，避免因格式问题导致ESLint无法识别忽略规则。
3. 在ESLint配置中补充忽略规则：若.eslintignore仍不生效，可直接在.eslintrc.cjs中添加ignorePatterns字段，显式指定忽略目录：

module.exports = {
  root: true,
  ignorePatterns: ['.git/', '.vscode/', 'node_modules/', 'dist/', 'typedocs/', '__tests__/coverage/'],
  // ...其余原有配置
}

4. 验证忽略规则生效状态：执行eslint --print-config typedocs/assets/main.js命令，查看输出内容中是否包含ignorePatterns且包含typedocs，以此确认规则是否被正确加载。

内容的提问来源于stack exchange，提问作者Ivan Post