ESLint Plugin TypeScript

Installation

Make sure you have TypeScript and @typescript-eslint/parser installed, then install the plugin:

npm i @typescript-eslint/eslint-plugin --save-dev

It 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.

Usage

Add @typescript-eslint/parser to the parser field and @typescript-eslint to the plugins section of your .eslintrc configuration file:

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["@typescript-eslint"]
}

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 at once. Add plugin:@typescript-eslint/recommended in extends:

{
  "extends": ["plugin:@typescript-eslint/recommended"]
}

If you want to use rules which require type information, you will need to specify a path to your tsconfig.json file in the "project" property of "parserOptions".

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "plugins": ["@typescript-eslint"],
  "rules": {
    "@typescript-eslint/restrict-plus-operands": "error"
  }
}

See @typescript-eslint/parser's README.md for more information on the available "parserOptions".

Usage with Prettier

Install eslint-config-prettier to disable our code formatting related rules:

{
  "extends": [
    "plugin:@typescript-eslint/recommended",
    "prettier",
    "prettier/@typescript-eslint"
  ]
}

Note: Make sure you have eslint-config-prettier@4.0.0 or newer.

Supported Rules

Key: :heavy_check_mark: = recommended, :wrench: = fixable

Name	Description	:heavy_check_mark:	:wrench:
`@typescript-eslint/adjacent-overload-signatures`	Require that member overloads be consecutive (`adjacent-overload-signatures` from TSLint)	:heavy_check_mark:
`@typescript-eslint/array-type`	Requires using either `T[]` or `Array<T>` for arrays (`array-type` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/ban-types`	Enforces that types will not to be used (`ban-types` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/camelcase`	Enforce camelCase naming convention	:heavy_check_mark:
`@typescript-eslint/class-name-casing`	Require PascalCased class and interface names (`class-name` from TSLint)	:heavy_check_mark:
`@typescript-eslint/explicit-function-return-type`	Require explicit return types on functions and class methods	:heavy_check_mark:
`@typescript-eslint/explicit-member-accessibility`	Require explicit accessibility modifiers on class properties and methods (`member-access` from TSLint)	:heavy_check_mark:
`@typescript-eslint/generic-type-naming`	Enforces naming of generic type variables
`@typescript-eslint/indent`	Enforce consistent indentation (`indent` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/interface-name-prefix`	Require that interface names be prefixed with `I` (`interface-name` from TSLint)	:heavy_check_mark:
`@typescript-eslint/member-delimiter-style`	Require a specific member delimiter style for interfaces and type literals	:heavy_check_mark:	:wrench:
`@typescript-eslint/member-naming`	Enforces naming conventions for class members by visibility.
`@typescript-eslint/member-ordering`	Require a consistent member declaration order (`member-ordering` from TSLint)
`@typescript-eslint/no-angle-bracket-type-assertion`	Enforces the use of `as Type` assertions instead of `<Type>` assertions (`no-angle-bracket-type-assertion` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-array-constructor`	Disallow generic `Array` constructors	:heavy_check_mark:	:wrench:
`@typescript-eslint/no-empty-interface`	Disallow the declaration of empty interfaces (`no-empty-interface` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-explicit-any`	Disallow usage of the `any` type (`no-any` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-extraneous-class`	Forbids the use of classes as namespaces (`no-unnecessary-class` from TSLint)
`@typescript-eslint/no-inferrable-types`	Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean. (`no-inferrable-types` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/no-misused-new`	Enforce valid definition of `new` and `constructor`. (`no-misused-new` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-namespace`	Disallow the use of custom TypeScript modules and namespaces (`no-namespace` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-non-null-assertion`	Disallows non-null assertions using the `!` postfix operator (`no-non-null-assertion` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-object-literal-type-assertion`	Forbids an object literal to appear in a type assertion expression (`no-object-literal-type-assertion` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-parameter-properties`	Disallow the use of parameter properties in class constructors. (`no-parameter-properties` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-this-alias`	Disallow aliasing `this` (`no-this-assignment` from TSLint)
`@typescript-eslint/no-triple-slash-reference`	Disallow `/// <reference path="" />` comments (`no-reference` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-type-alias`	Disallow the use of type aliases (`interface-over-type-literal` from TSLint)
`@typescript-eslint/no-unnecessary-type-assertion`	Warns if a type assertion does not change the type of an expression (`no-unnecessary-type-assertion` from TSLint)		:wrench:
`@typescript-eslint/no-unused-vars`	Disallow unused variables (`no-unused-variable` from TSLint)	:heavy_check_mark:
`@typescript-eslint/no-use-before-define`	Disallow the use of variables before they are defined	:heavy_check_mark:
`@typescript-eslint/no-var-requires`	Disallows the use of require statements except in import statements (`no-var-requires` from TSLint)	:heavy_check_mark:
`@typescript-eslint/prefer-interface`	Prefer an interface declaration over a type literal (type T = { ... }) (`interface-over-type-literal` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/prefer-namespace-keyword`	Require the use of the `namespace` keyword instead of the `module` keyword to declare custom TypeScript modules. (`no-internal-module` from TSLint)	:heavy_check_mark:	:wrench:
`@typescript-eslint/restrict-plus-operands`	When adding two variables, operands must both be of type number or of type string. (`restrict-plus-operands` from TSLint)
`@typescript-eslint/type-annotation-spacing`	Require consistent spacing around type annotations (`typedef-whitespace` from TSLint)	:heavy_check_mark:	:wrench:

3760 Versions