“parserOptions.project” 已为 @typescript-eslint/parser 设置

Question

I created a new React Native project with --template typescript

I deleted the template directory which came as part of the boilerplate.

I then proceeded to add ESLint:

module.exports = {
  parser: "@typescript-eslint/parser",
  plugins: ["@typescript-eslint"],
  extends: ["airbnb-typescript-prettier"]
};

However, when I open babel.config.js , I get this error

Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.

The file does not match your project config: /Users/Dan/site/babel.config.js .

The file must be included in at least one of the projects provided.eslint

Answer 1

Different lint rules for JavaScript and TypeScript files

The problem happens for one of the reasons below:

1. You're using a rule which require type information and didn't specify a parserOptions.project ;
2. You specified parserOptions.project , didn't specify createDefaultProgram ( it will be removed in a future version ), and you're linting files not included in the project (eg babel.config.js , metro.config.js )

As from the TypeScript ESLint Parser docs :

parserOptions.project

This option allows you to provide a path to your project's tsconfig.json . This setting is required if you want to use rules which require type information.

(...)

Note that if this setting is specified and createDefaultProgram is not, you must only lint files that are included in the projects as defined by the provided tsconfig.json files. If your existing configuration does not include all of the files you would like to lint, you can create a separate tsconfig.eslint.json .

To solve it, update your ESLint config to use TypeScript rules only on TypeScript files:

{
  // ...
  parser: '@typescript-eslint/parser',
  plugins: ["@typescript-eslint"],
  overrides: [
    {
      files: ['*.ts', '*.tsx'], // Your TypeScript files extension

      // As mentioned in the comments, you should extend TypeScript plugins here,
      // instead of extending them outside the `overrides`.
      // If you don't want to extend any rules, you don't need an `extends` attribute.
      extends: [
        'plugin:@typescript-eslint/recommended',
        'plugin:@typescript-eslint/recommended-requiring-type-checking',
      ],

      parserOptions: {
        project: ['./tsconfig.json'], // Specify it only for TypeScript files
      },
    },
  ],
  // ...
}

You can read more about the overrides config on the official docs: How do overrides work?

---

Don't lint a specific file

If you don't want to lint the file that is mentioned in the error (eg babel.config.js ), you can ignore it adding its name to the .eslintignore file :

babel.config.js

Anyway, the step above (about overriding the config for TypeScript files) is important in case your project contains both JavaScript and TypeScript files that you want to lint.

You can also create other overrides for different situations, eg a different config for test files, since it can use developer dependencies and run on node environment , instead of browser .

Answer 2

You can create a separate TypeScript config file ( tsconfig.eslint.json ) intended for eslint configuration. That file extends tsconfig configuration and setups include key for files that have to be linted.

.eslint.js :

// ...
parserOptions: {
  // ...
  project: "./tsconfig.eslint.json",
  // ...
},
// ...

tsconfig.eslint.json :

{
  "extends": "./tsconfig.json",
  "include": [
    // ...
    "babel.config.js"
  ]
}

Or if you want to ignore it, you can put it into .eslintignore .

.eslintignore :

// ...
babel.config.js

Answer 3

Add one line in ".eslintignore":

.eslintrc.js

Answer 4

You need to add that file to your tsconfig include array. See typescript-eslint/typescript-eslint#967 for more details.

Answer 5

In my ESLint config I have the following configuration:

.eslintrc.js

module.exports = {
  root: true,
  env: {
    node: true,
  },
  globals: {
    Promise: "readonly"
  },
  parser: "@typescript-eslint/parser",
  parserOptions: {
    sourceType: "module",
    tsconfigRootDir: __dirname,
    project: ["./tsconfig.eslint.json"],
  },
  plugins: ["@typescript-eslint"],
  extends: [
    "eslint:recommended",
    "prettier/@typescript-eslint",
    "plugin:@typescript-eslint/recommended",
    "plugin:@typescript-eslint/recommended-requiring-type-checking",
  ],
}

Update The key part of the fix is this:

parser: "@typescript-eslint/parser"

and this:

parserOptions: {
    sourceType: "module",
    tsconfigRootDir: __dirname,
    project: ["./tsconfig.eslint.json"], // could be tsconfig.json too
}

Don't forget to include that file or file's directory in the include array of tsconfig.json.

Answer 6

1. Run npm i -D @types/node

2. Include typescript support for *.config.js files:

tsconfig.json :

{
  "include": [
    "**/*.config.js" // for *.config.js files
  ]
}

And then reload your IDE!

Answer 7

Simply instruct eslint to ignore them by adding the ignorePatterns option to your .eslintrc.js :

module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: './tsconfig.json',
  },
  ignorePatterns: ["babel.config.js"],
  ...

As there is not much value in linting your project config files, you can safely ignore them.

Also, I would not make them part of your tsconfig.json or create a special tsconfig.eslint.json file, just for linting purpose.

Answer 8

The error means there is a file which can be compiled but doesnt belong to currently defined project structure. there are several solutions:

If you dont care if the file is compliled (ie. config files and such)

• add the filename to .eslintignore

or

• add the file or file pattern to .eslintrc.js file

ignorePatterns: ["babel.config.js"]
// or 
ignorePatterns: ["**/*.config.js"]

You want the file to compiled

add the file, folder or pattern to tsconfig.json file

include": [
    "src",
    "other_src",
]

NOTE some changes needs IDE restart to take effect

Answer 9

Simply add below code inside the.eslintrc.js file.

ignorePatterns: ['.eslintrc.js']

Answer 10

For me the problem originates in some files ignored in tsconfig using the exclude property, yet eslint does not ignore them.

Usually if one wants that TSC will ignore files, then the same will be applied to eslint. so just copy paste the value of exclude in .tsconfig configuration into the ignorePatterns property in .eslintrc configuration.

Answer 11

I use a symlink from my project folder point to my home folder:

/opt/project/workspace => ~/worspace

Opening the VSCode using the symlink path ~/workspace the error always persists.

Opening VSCode using the original path: /opt/project/workspace solves the problem.

This shouldn't be a problem, but for now it is.

Answer 12

I was having the same issue when adding '@typescript-eslint/prefer-nullish-coalescing': 'error' to .eslintrc.js .

After a lot of trial and error, I came up with this solution, which works well in my case:

module.exports = {
  ...
  overrides: [
    {
      files: ['*.ts', '*.tsx'],
      parserOptions: {
        // this setting is required to use rules that require type information
        project: './tsconfig.json',
      },
      rules: {
        '@typescript-eslint/prefer-nullish-coalescing': 'error',
      },
    },
  ],
}

Answer 13

Does this Error come from the VSCode Extension? Does the Error have a relative Path that goes to the top level even though its in the same folder (or subfolder) (as shown in the error message below)?

Parsing error: "parserOptions.project" has been set for @typescript-eslint/parser.
The file does not match your project config: ../../../../../home/<ommitted>/projects/floor-planner/app/src/App.vue.
The file must be included in at least one of the projects provided.

If so, check if it also persists when using the CLI.

From your project root you could run eslint. . If those errors are not found, you very likely have the project opened through a symlink .

As of Aug 2021, the Eslint Extension does not work with Symlinks.

From your project directory, run pwd -P to get the absolute Path.

In my instance this results in

~/projects/floor-planner/app: pwd -P
/media/projects/2021-Q3/floor-planner/app

Open the Project through this Path.

Eslint should no longer show the Error.

Answer 14

In our case we have multiple.eslintrc and multiple tsconfig.json in our directory tree. (One each for the server at . , and one each for the React client at ./client .)

This worked fine with the CLI but not with VS Code's plug-in.

The fix was to set the./client/.eslintrc project value to be relative to the root - not to the.eslintrc file. After changing it from "./tsconfig.json" to "./client/tsconfig.json" the IDE linting works as expected.

Answer 15

I had this issue in VsCode when I was opening my Project too high up in the Folder Structure. A weird solution but it worked.

In my example, Firestore functions project for express in.ts, I had to open it from the functions folder it created.

I should have noticed it was this sort of problem since 'npm run-script lint' never returned an error itself.

Answer 16

I needed just to add the path to the new tsconfig.json in the project array and eslint script and the issue went away.

tsconfig.json :

project: ["./newfolder/tsconfig.json"]

package.json :

"eslint": "eslint -c ./.eslintrc.js './newfolder/**/*.ts'"

Answer 17

if in tsconfig.json include could not find any ts, and only get js files, this will show up as well

Answer 18

I spent a lot of time on a problem like this one.

I had created a jest.config.ts instead of jest.config.js so it was throwing this exact eslint error

Answer 19

I ran into this issue today, and none of the above solutions helped. The issue I had was that I had two files in the same directory that shared the same file name (sans extension). Eg, src/foo.ts and src/Foo.tsx . Renaming one of the files fixed the linter error. See @typescript-eslint/parser#955 .

Answer 20

My issue was in PHPStorm is that I was having the working director set:

I cleared that and everything worked:\

Answer 21

for me, this issue happens when the project listed in parserOptions.project extends the base tsconfig.json which excludes this file.

removing extends: './tsconfig.json' from the project listed in parserOptions.project or removing exclude from the base config fixes it. but this workaround is not practical as we need to extend the base config.

overriding the property exclude will perfectly help.

tsconfig.spec.json

{
  "extends": "./tsconfig.json",
  "compilerOptions": {
    "outDir": "./dist",
    "types": ["jest"]
  },
  "include": ["**/*.spec.ts"],
  "exclude": [""]
}

Answer 22

After putting lots of efforts and trials in correcting this error.I got to know my issue is i saved the ignore file as eslintignore instead of.eslintignore.

So due to this it was not able to ignore the.js, .d.ts files as dist got ignored.

Answer 23

I happen to have the same problem for a while and then after adding .html to the include array of my tsconfig.json file, the problem has been fixed.

Since I am working on an Angular project, in the files array inside the overrides you may see my components extension which you may need to change as your project necessity.

in the eslintrc.json file you need to have the following configuration:

    "extends": [
        "plugin:@typescript-eslint/eslint-recommended",
        "plugin:@typescript-eslint/recommended",
        "plugin:@typescript-eslint/recommended-requiring-type-checking",
        "plugin:@angular-eslint/recommended"
    ],
    "overrides": [
        {
            "files": ["*.ts", "*.component.html", "*.component.ts"],
            "parserOptions": {
                "project": ["./tsconfig.json"],
                "extraFileExtensions": [".html"]
            },
            "rules": { "@typescript-eslint/prefer-nullish-coalescing": "error" }
        }
    ],
    "parser": "@typescript-eslint/parser",

make sure that you have the following line in your tsconfig.json file:

"include": ["**/*.d.ts", "**/*.ts", "**/*.html", "**/*.scss", "**/*.css"],

Answer 24

Linux - My projects directory /home/user/projects was a symlink to /usr/share/dev/projects. I removed the symlink and everything works now.

The error I was getting was telling me it couldn't find any.tsx file in "../../../../../{app name/path}"

I hope my hours of troubleshooting helps someone:)

Answer 25

Despite assurances that typescript definitely, absolutely, never caches anything, I suspected this was a caching issue after, when getting annoyed at incessant typescript errors while debugging and developing a feature, I modified my tsconfig.json to exclude my src directory temporarily. Upon reverting the change, and restarting my typescript server running through WebpackDevServer, I had this error, and got rid of it by doing yarn cache clean to clear my yarn cache, as well as rm -rf node_modules to delete my node modules folder. Then I re installed my packages with yarn and when I ran my devserver again, typescript/tslint no longer showed this error.

Answer 26

I have this proble，when I update ts version to the latest

Answer 27

I had this error thrown at me even with the project settings included. It was a vue sfc and the solution was a missing <script></script> template.

Answer 28

Set parserOptions in.eslintrc as below

"parserOptions": {
  "ecmaFeatures": {
    "jsx": true
  },
  "ecmaVersion": 2019,
  "sourceType": "module"        
},