eslint-plugin-tslint-comments

Archived because this rule is now part of @typescript-eslint/eslint-plugin

Use ban-tslint-comment instead

Useful when migrating from tslint to eslint. Once tslint has been removed, this rule helps locate tslint annotations (e.g. // tslint:disable).

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-tslint-comments:

$ npm install eslint-plugin-tslint-comments --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-tslint-comments globally.

Usage

Add tslint-comments to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["tslint-comments"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "tslint-comments/forbid-all": 2
  }
}

Supported Rules

• forbid-all: Identify tslint rule flags so that they can be removed