An ESLint plugin which provides lint rules for TypeScript codebases.
These docs walk you through setting up ESLint, this plugin, and our parser. If you know what you're doing and just want to quick start, read on...
Make sure you have TypeScript and @typescript-eslint/parser installed:
$ yarn add -D typescript @typescript-eslint/parser
$ npm i --save-dev typescript @typescript-eslint/parserThen install the plugin:
$ yarn add -D @typescript-eslint/eslint-plugin
$ npm i --save-dev @typescript-eslint/eslint-pluginIt is important that you use the same version number for @typescript-eslint/parser and @typescript-eslint/eslint-plugin.
Note: If you installed ESLint globally (using the -g flag) then you must also install @typescript-eslint/eslint-plugin globally.
Add @typescript-eslint/parser to the parser field and @typescript-eslint to the plugins section of your .eslintrc configuration file, then configure the rules you want to use under the rules section.
{
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"rules": {
"@typescript-eslint/rule-name": "error"
}
}You can also enable all the recommended rules for our plugin. Add plugin:@typescript-eslint/recommended in extends:
{
"extends": ["plugin:@typescript-eslint/recommended"]
}You can also use eslint:recommended (the set of rules which are recommended for all projects by the ESLint Team) with this plugin:
{
"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"]
}As of version 2 of this plugin, by design, none of the rules in the main recommended config require type-checking in order to run. This means that they are more lightweight and faster to run.
Some highly valuable rules require type-checking in order to be implemented correctly, however, so we provide an additional config you can extend from called recommended-requiring-type-checking. You would apply this in addition to the recommended configs previously mentioned, e.g.:
{
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking"
]
}Pro Tip: For larger codebases you may want to consider splitting our linting into two separate stages: 1. fast feedback rules which operate purely based on syntax (no type-checking), 2. rules which are based on semantics (type-checking).
You can read more about linting with type information here
For the exhaustive list of supported rules, please see our website.