feat: @typescript-eslint/ban-ts-comment

BREAKING CHANGE: @typescript-eslint/ban-ts-comment Co-authored-by: Shahar Dawn Or <mightyiampresence@gmail.com>
mightyiam · Jan 17, 2023 · 13e53c0 · 13e53c0
1 parent 907dd6a
commit 13e53c0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/index.test.ts b/src/index.test.ts
@@ -84,6 +84,13 @@ test('export', (t): void => {
           '@typescript-eslint/adjacent-overload-signatures': 'error',
           '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
           '@typescript-eslint/await-thenable': 'error',
+          '@typescript-eslint/ban-ts-comment': ['error', {
+            'ts-expect-error': 'allow-with-description',
+            'ts-ignore': true,
+            'ts-nocheck': true,
+            'ts-check': false,
+            minimumDescriptionLength: 3
+          }],
           '@typescript-eslint/brace-style': ['error', '1tbs', { allowSingleLine: true }],
           '@typescript-eslint/comma-dangle': ['error', {
             arrays: 'never',
@@ -363,7 +370,6 @@ test('all plugin rules are considered', (t) => {
   // This serves as a todo list and should ideally eventually end up empty
   // and then fail upon plugin upgrades where new rules are released.
   const notYetConsideredRules: string[] = [
-    'ban-ts-comment',
     'ban-tslint-comment',
     'ban-types',
     'class-literal-property-style',

diff --git a/src/index.ts b/src/index.ts
@@ -73,6 +73,13 @@ const config: Linter.Config = {
         '@typescript-eslint/adjacent-overload-signatures': 'error',
         '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
         '@typescript-eslint/await-thenable': 'error',
+        '@typescript-eslint/ban-ts-comment': ['error', {
+          'ts-expect-error': 'allow-with-description',
+          'ts-ignore': true,
+          'ts-nocheck': true,
+          'ts-check': false,
+          minimumDescriptionLength: 3
+        }],
         '@typescript-eslint/comma-dangle': ['error', {
           arrays: 'never',
           objects: 'never',