Monorepo for all the tooling which enables ESLint to support TypeScript
Branch: master
Clone or download
Latest commit d362c4a Feb 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE chore: versions on issue templates Jan 20, 2019
.vscode feat(eslint-plugin): Migrate plugin to ts (#120) Feb 11, 2019
packages chore: publish v1.4.1 Feb 23, 2019
tests/integration chore(*): Enable comma-dangle (#271) Feb 19, 2019
tools docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019
.all-contributorsrc docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019
.codecov.yml chore: update .codecov.yml comment config (#84) Jan 20, 2019
.editorconfig chore: move config to top level where possible Jan 13, 2019
.eslintignore chore(*): Enable comma-dangle (#271) Feb 19, 2019
.eslintrc.json test(plugin-tslint): add missing test cases for plugin-tslint (#303) Feb 23, 2019
.gitattributes chore: move config to top level where possible Jan 13, 2019
.gitignore feat(eslint-plugin): Migrate plugin to ts (#120) Feb 11, 2019
.huskyrc chore: upgrade husky and lint-staged (#144) Jan 29, 2019
.lintstagedrc chore: upgrade husky and lint-staged (#144) Jan 29, 2019
.npmrc chore: move config to top level where possible Jan 13, 2019
.prettierignore chore(*): Enable comma-dangle (#271) Feb 19, 2019
.prettierrc chore(*): Enable comma-dangle (#271) Feb 19, 2019
CHANGELOG.md chore: publish v1.4.1 Feb 23, 2019
CONTRIBUTORS.md docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019
LICENSE chore: move config to top level where possible Jan 13, 2019
README.md docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019
azure-pipelines.yml feat(eslint-plugin): Migrate plugin to ts (#120) Feb 11, 2019
lerna.json chore: publish v1.4.1 Feb 23, 2019
package.json docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019
tsconfig.base.json feat(eslint-plugin): Migrate plugin to ts (#120) Feb 11, 2019
yarn.lock docs(*): switch from author file comments to all-contributors (#228) Feb 23, 2019

README.md

TypeScript ESLint

Monorepo for all the tooling which enables ESLint to support TypeScript

Azure Pipelines GitHub license NPM Downloads Codecov Commitizen friendly


About

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

  • @typescript-eslint/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.

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

  • @typescript-eslint/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.

Package Versions

All of the packages are published with the same version number to make it easier to coordinate both releases and installations.

Additionally, we also publish a canary release on every successful merge to master, so you never need to wait for a new stable version to make use of any updates.

The latest (stable) version is:

NPM Version

The canary (latest master) version is:

NPM Version

Supported TypeScript Version

We will always endeavor to support the latest stable version of TypeScript. Sometimes, but not always, changes in TypeScript will not require breaking changes in this project, and so we are able to support more than one version of TypeScript.

The version range of TypeScript currently supported by this parser is >=3.2.1 <3.4.0.

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. If you want to disable this warning, you can configure this in your parserOptions. See: @typescript-eslint/parser and @typescript-eslint/typescript-estree.

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

Contributing

COMING SOON!

License

TypeScript ESLint 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.

Contributors

Thanks goes to the wonderful people listed in CONTRIBUTORS.md.