ban-tslint-comment

Disallow // tslint:<rule-flag> comments.

🔒

Extending "plugin:@typescript-eslint/strict" in an ESLint configuration enables this rule.

🔧

Some problems reported by this rule are automatically fixable by the --fix ESLint command line option.

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

See the TSLint rule flags docs for reference.

.eslintrc.cjs

module.exports = {
  "rules": {
    "@typescript-eslint/ban-tslint-comment": "error"
  }
};

Try this rule in the playground ↗

Examples

❌ Incorrect

/* tslint:disable */
/* tslint:enable */
/* tslint:disable:rule1 rule2 rule3... */
/* tslint:enable:rule1 rule2 rule3... */
// tslint:disable-next-line
someCode(); // tslint:disable-line
// tslint:disable-next-line:rule1 rule2 rule3...

✅ Correct

// This is a comment that just happens to mention tslint
/* This is a multiline comment that just happens to mention tslint */
someCode(); // This is a comment that just happens to mention tslint

Options

This rule is not configurable.

When Not To Use It

If you are still using TSLint.

Resources

• Rule source
• Test source