@typescript-eslint/parser
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

@typescript-eslint/parser

An ESLint custom parser which leverages TypeScript ESTree

2.0.0  •  Updated 5 months ago  •  by typescript-eslint  •  BSD 2-Clause "Simplified" License

TypeScript ESLint Parser

An ESLint custom parser which leverages TypeScript ESTree to allow for ESLint to lint TypeScript source code.

Azure Pipelines GitHub license NPM Version NPM Downloads Commitizen friendly

Installation:

npm install @typescript-eslint/parser --save-dev

Usage

In your ESLint configuration file, set the parser property:

{
  "parser": "@typescript-eslint/parser"
}

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.

For example, once this parser successfully produces an AST for the TypeScript source code, it might well contain some information which simply does not exist in a standard JavaScript context, such as the data for a TypeScript-specific construct, like an interface.

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.

By far the most common case will be installing the @typescript-eslint/eslint-plugin plugin, but there are also other relevant options available such a @typescript-eslint/eslint-plugin-tslint.

Configuration

The following additional configuration options are available by specifying them in parserOptions in your ESLint configuration file.

  • ecmaFeatures.jsx - default false. Enable parsing JSX when true. More details can be found here.

    • It’s false on *.ts files regardless of this option.
    • It’s true on *.tsx files regardless of this option.
    • Otherwise, it respects this option.
  • useJSXTextNode - default true. Please set false if you use this parser on ESLint v4. If this is false, the parser creates the AST of JSX texts as the legacy style.

  • project - default 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 tsconfigRootDir option below.

    • Accepted values:

      // path
      project: './tsconfig.json';
      
      // glob pattern
      project: './packages/**/tsconfig.json';
      
      // array of paths and/or glob patterns
      project: [
        './packages/**/tsconfig.json',
        './separate-package/tsconfig.json',
      ];
      
    • Note that if you use project references, TypeScript will not automatically use project references to resolve files. This means that you will have to add each referenced tsconfig to the project field either separately, or via a glob.

    • 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 as follows:

      {
        // extend your base config so you don't have to redefine your compilerOptions
        "extends": "./tsconfig.json",
        "include": [
          "src/**/*.ts",
          "test/**/*.ts",
          "typings/**/*.ts",
          // etc
      
          // if you have a mixed JS/TS codebase, don't forget to include your JS files
          "src/**/*.js"
        ]
      }
      
  • tsconfigRootDir - default undefined. This option allows you to provide the root directory for relative tsconfig paths specified in the project option above.

  • extraFileExtensions - default 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 .vue file

  • warnOnUnsupportedTypeScriptVersion - default 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

  • createDefaultProgram - default false. This option allows you to request that when the project setting is specified, files will be allowed when not included in the projects defined by the provided tsconfig.json files. Using this option will incur significant performance costs. This option is primarily included for backwards-compatibility. See the project section above for more information.

.eslintrc.json

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true
    },
    "useJSXTextNode": true,
    "project": "./tsconfig.json",
    "tsconfigRootDir": "../../",
    "extraFileExtensions": [".vue"]
  }
}

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.

Reporting Issues

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.

License

TypeScript ESLint Parser is licensed under a permissive BSD 2-clause license.

How often do you use dark themes on other websites?

Popularity

Weekly Downloads
1.3M
Stars
5.6K

Maintenance

Development

Last ver 5 months ago
Created 1 year ago
Last commit 2 months ago
10 hours between commits

Technology

Node version: 10.16.2
83.5K unpacked

Compliance

BSD 2-Clause "Simplified" License
OSI Approved
0 vulnerabilities

Contributors

174 contributors
Brad Zacher
Maintainer, 140 commits, 248 merges, 100 PRs
Works at Software Engineer Facebook
James Henry
Maintainer, 200 commits, 164 merges, 43 PRs
Armano
Maintainer, 107 commits, 19 merges, 68 PRs
ESLint Jenkins
88 commits
Reyad Attiyat
44 commits
patricio trevino
36 commits

Tags

ast
ecmascript
javascript
typescript
parser
syntax
eslint
Ready for the next level?
Join Openbase's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
© 2020 Devstore, Inc.