@typescript-eslint/parser1.9.0 • Public • Published
TypeScript ESLint Parser
An ESLint custom parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.
npm install @typescript-eslint/parser --save-dev
In your ESLint configuration file, set the
There is sometimes an incorrect assumption that the parser itself is what does everything necessary to facilitate the use of ESLint with TypeScript. In actuality, it is the combination of the parser and one or more plugins which allow you to maximize your usage of ESLint with TypeScript.
The core rules built into ESLint, such as
indent have no knowledge of such constructs, so it is impossible to expect them to work out of the box with them.
Instead, you also need to make use of one more plugins which will add or extend rules with TypeScript-specific features.
The following additional configuration options are available by specifying them in
parserOptions in your ESLint configuration file.
false. Enable parsing JSX when
true. More details can be found here.
*.tsfiles regardless of this option.
*.tsxfiles regardless of this option.
- Otherwise, it respects this option.
true. Please set
falseif you use this parser on ESLint v4. If this is
false, the parser creates the AST of JSX texts as the legacy style.
undefined. 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. You may want to use this setting in tandem with the
undefined. This option allows you to provide the root directory for relative tsconfig paths specified in the
undefined. This option allows you to provide one or more additional file extensions which should be considered in the TypeScript Program compilation. E.g. a
true. This option allows you to toggle the warning that the parser will give you if you use a version of TypeScript which is not explicitly supported
Supported TypeScript Version
Please see https://github.com/typescript-eslint/typescript-eslint for the supported TypeScript version.
Please ensure that you are using a supported version before submitting any issues/bug reports.
Please use the @typescript-eslint/parser issue template when creating your issue and fill out the information requested as best you can. This will really help us when looking into your issue.
TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.