README.md

TypeScript ESLint

Monorepo for all the tooling which enables ESLint to support TypeScript

About

This repo contains several packages which allow ESLint users to lint their TypeScript code.

• typescript-estree - An entirely generic TypeScript parser which takes TypeScript source code and produces an ESTree-compatible AST

  • This package is also used to power the amazing opinionated code formatter Prettier's own TypeScript use-case.

• typescript-eslint-parser - An ESLint-specific parser which leverages typescript-estree and is designed to be used as a replacement for ESLint's default parser, espree.

• eslint-plugin-typescript - An ESLint-specific plugin which, when used in conjunction with typescript-eslint-parser, allows for TypeScript-specific linting rules to run.

• eslint-plugin-tslint - An ESLint-specific plugin which runs an instance of TSLint within your ESLint setup to allow for users to more easily migrate from TSLint to ESLint.

Supported TypeScript Version

We will always endeavor to support the latest stable version of TypeScript.

The version of TypeScript currently supported by this parser is ~3.2.1. This is reflected in the devDependency requirement within the package.json file, and it is what the tests will be run against. We have an open peerDependency requirement in order to allow for experimentation on newer/beta versions of TypeScript.

If you use a non-supported version of TypeScript, the parser will log a warning to the console.

Please ensure that you are using a supported version before submitting any issues/bug reports.

Contributing

COMING SOON!

License

TypeScript ESTree inherits from the the original TypeScript ESLint Parser license, as the majority of the work began there. It is licensed under a permissive BSD 2-clause license.