@typescript-eslint/eslint-plugin
Version:
TypeScript plugin for ESLint
46 lines (33 loc) • 1.19 kB
text/mdx
---
description: 'Disallow `// tslint:<rule-flag>` comments.'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
> 🛑 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`).
> See the [TSLint rule flags docs](https://palantir.github.io/tslint/usage/rule-flags) for reference.
## Examples
<Tabs>
<TabItem value="❌ Incorrect">
```ts
/* 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...
```
</TabItem>
<TabItem value="✅ Correct">
```ts
// 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
```
</TabItem>
</Tabs>
If you are still using TSLint alongside ESLint.