chore: add suggestion property to relevant rules

jest-community · Jun 20, 2020 · f67f56f · f67f56f
1 parent 4973139
commit f67f56f
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,13 @@ import { join, parse } from 'path';
 import globals from './globals.json';
 import * as snapshotProcessor from './processors/snapshot-processor';
 
+// can be removed once we've on v3: https://github.com/typescript-eslint/typescript-eslint/issues/2060
+declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
+  export interface RuleMetaDataDocs {
+    suggestion?: boolean;
+  }
+}
+
 // copied from https://github.com/babel/babel/blob/d8da63c929f2d28c401571e2a43166678c555bc4/packages/babel-helpers/src/helpers.js#L602-L606
 /* istanbul ignore next */
 const interopRequireDefault = (obj: any): { default: any } =>

diff --git a/src/rules/no-test-callback.ts b/src/rules/no-test-callback.ts
@@ -8,14 +8,14 @@ export default createRule({
       category: 'Best Practices',
       description: 'Avoid using a callback in asynchronous tests',
       recommended: false,
+      suggestion: true,
     },
     messages: {
       illegalTestCallback: 'Illegal usage of test callback',
       suggestWrappingInPromise: 'Wrap in `new Promise({{ callback }} => ...`',
       useAwaitInsteadOfCallback:
         'Use await instead of callback in async functions',
     },
-    fixable: 'code',
     schema: [],
     type: 'suggestion',
   },

diff --git a/src/rules/prefer-expect-assertions.ts b/src/rules/prefer-expect-assertions.ts
@@ -69,6 +69,7 @@ export default createRule<[], MessageIds>({
       description:
         'Suggest using `expect.assertions()` OR `expect.hasAssertions()`',
       recommended: false,
+      suggestion: true,
     },
     messages: {
       hasAssertionsTakesNoArguments:

diff --git a/src/rules/prefer-strict-equal.ts b/src/rules/prefer-strict-equal.ts
@@ -13,12 +13,12 @@ export default createRule({
       category: 'Best Practices',
       description: 'Suggest using toStrictEqual()',
       recommended: false,
+      suggestion: true,
     },
     messages: {
       useToStrictEqual: 'Use `toStrictEqual()` instead',
       suggestReplaceWithStrictEqual: 'Replace with `toStrictEqual()`',
     },
-    fixable: 'code',
     type: 'suggestion',
     schema: [],
   },