Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 1.15 KB

ban-tslint-comment.md

File metadata and controls

52 lines (38 loc) · 1.15 KB
Raw
description
Disallow `// tslint:<rule-flag>` comments.

🛑 This file is source code, not the primary documentation location! 🛑

See https://typescript-eslint.io/rules/ban-tslint-comment for documentation.

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

Rule Details

All TSLint rule flags

❌ 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

// .eslintrc.json
{
  "rules": {
    "@typescript-eslint/ban-tslint-comment": "warn"
  }
}

This rule is not configurable.

When Not To Use It

If you are still using TSLint.