/eslint-plugin-ts

ESLint TypeScript plugin

Primary LanguageJavaScriptMIT LicenseMIT

ESLint-plugin-ts

TypeScript specific linting rules for ESLint

Installation

Install ESLint either locally or globally.

$ npm i eslint --save-dev

If you installed ESLint globally, you have to install the plugin globally too. Otherwise, install it locally.

$ npm i eslint-plugin-ts --save-dev

Install typescript-eslint-parser either locally or globally.

$ npm i typescript-eslint-parser --save-dev

Configuration

Use the recommended preset to get reasonable defaults:

  "extends": [
    "eslint:recommended",
    "plugin:ts/recommended"
  ]

If you do not use a preset you will need to specify individual rules and add extra configuration.

Add "ts" to the plugins section.

{
  "plugins": ["ts"]
}

You will need to configure the TypeScript parser.

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

Enable the rules that you would like to use.

  "rules": {
    "ts/no-any": "error"
  }

List of supported rules

  • ts/no-any: Forbid the usage of the "any" type annotation

License

ESLint-plugin-ts is licensed under the MIT License.