如何修复 eslintrc 文件与您的项目配置不匹配？

Question

在我的打字稿项目中，我使用的是 eslint。下面的文件在根目录下，我还有子文件夹/dist 和/src。

eslintrc.js

module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  parserOptions: {
    tsconfigRootDir: __dirname,
    project: ['./tsconfig.json'],
  },
  rules: {
    strict: 'error',
    semi: ['error', 'always'],
    'no-cond-assign': ['error', 'always'],
  },
  plugins: ['@typescript-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:@typescript-eslint/recommended-requiring-type-checking',
  ],
}

tsconfig.json

{
  "compilerOptions": {
    "outDir": "dist",
    "noImplicitAny": true,
    "moduleResolution": "Node",
    "resolveJsonModule": true,
    "module": "ES2020",
    "target": "ES2020",
    "lib": ["ES2020"],
    "allowJs": false,
    "alwaysStrict": true
  },
  "include": ["src"]
}

上面的module这个词有一条红线表示这个错误

Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: .eslintrc.js.
The file must be included in at least one of the projects provided. eslint

我该如何解决这个问题？

Answer 1

更新您的 eslintrc.js 以包括：

ignorePatterns: ['.eslintrc.js']

Answer 2

这个错误是关于什么的？

烦人的错误基本上是说文件eslintrc.js 本身是两者：

1. 由 ESLint 发现，但是
2. 与应该 lint 的文件列表不匹配

所以，ESLint 不知道该怎么做，吓坏了！

请注意，虽然此文件不包含您的代码，但您应该决定是否要对该文件进行 linted（例如，制表符与空格，或双引号与单引号）。

---

应该怎么做？

您可以从上面的冲突情况中省略 (1) 或 (2)。

解决方案 1：告诉 ESLint 忽略文件

这更容易。只需将文件名（例如.eslintrc.js）添加到.eslintignore。

您还可以查看case 1.3 of my answer, here 了解不同的操作方式。

• 优点：快速。简单。无痛。
• 缺点：此文件的格式可能在制表符/空格或引号样式方面与其他文件不一致。

解决方案 2：告诉 ESLint 对这个文件进行 lint（首选）

Typescript-ESLint 通过parserOptions > project 从tsconfig.json 获取要包含的文件列表。

因此，您可以将文件添加到现有 tsconfig.json（解决方案 2.1）或创建辅助 tsconfig.eslint.json 以包含此类文件，您希望由 typescript-eslint 进行 linted，但不一定由Typescript 编译器。

• 优点：该文件和其他类似的 .js 配置也将包含在内，以保持一切一致。
• 缺点：您可能不希望这些配置文件被 linted。此外，无论如何，这需要一些额外的工作。

解决方案 2.1：将其添加到现有的 tsconfig.json

// in tsconfig.json ...

    "include": [
        ".eslintrc.js",
        // ...
    ]

解决方案 2.2：将其添加到单独的 tsconfig.eslint.json 文件中 使用此内容创建文件名tsconfig.eslint.json：

// new file: tsconfig.eslint.json

{
    "include": [
        ".eslintrc.js"
    ]
}

然后将其注入eslintrc.js 的parserOptions > project（是的，project 接受字符串和字符串数组）：

// in eslintrc.js ...

  parserOptions: {
    project: [
        resolve(__dirname, './tsconfig.json'),
        resolve(__dirname, './tsconfig.eslint.json'),
    ],
  }

附言。 This answer 非常相似，我将对此表示赞赏。

Answer 3

同样的错误，这对我有用： https://github.com/nestjs/nest/issues/4900#issuecomment-669743374 https://github.com/nestjs/nest/issues/4900#issuecomment-707330674

看起来配置文件必须命名为 .eslintrc 并使用 json 格式而不是 .eslintrc.js 并且 parserOptions.createDefaultProgram 必须设置为 true