fix: use correct property hasSuggestions rather than hasSuggestion (

#899)
jest-community · Sep 17, 2021 · dfd2368 · dfd2368
1 parent 46ac6fc
commit dfd2368
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 11 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -8,15 +8,11 @@ type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
   meta: Required<Pick<TSESLint.RuleMetaData<string>, 'docs'>>;
 };
 
-// can be removed once we've on v3: https://github.com/typescript-eslint/typescript-eslint/issues/2060
+// can be removed once we've on v5 of `@typescript-eslint/experimental-utils`
 declare module '@typescript-eslint/experimental-utils/dist/ts-eslint/Rule' {
-  export interface RuleMetaDataDocs {
-    suggestion?: boolean;
-  }
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   export interface RuleMetaData<TMessageIds extends string> {
-    hasSuggestion?: boolean;
+    hasSuggestions?: boolean;
   }
 }
 

diff --git a/src/rules/no-done-callback.ts b/src/rules/no-done-callback.ts
@@ -47,7 +47,7 @@ export default createRule({
     },
     schema: [],
     type: 'suggestion',
-    hasSuggestion: true,
+    hasSuggestions: true,
   },
   defaultOptions: [],
   create(context) {

diff --git a/src/rules/no-focused-tests.ts b/src/rules/no-focused-tests.ts
@@ -49,7 +49,7 @@ export default createRule({
     },
     schema: [],
     type: 'suggestion',
-    hasSuggestion: true,
+    hasSuggestions: true,
   },
   defaultOptions: [],
   create: context => ({

diff --git a/src/rules/prefer-expect-assertions.ts b/src/rules/prefer-expect-assertions.ts
@@ -84,7 +84,7 @@ export default createRule<[RuleOptions], MessageIds>({
       suggestRemovingExtraArguments: 'Remove extra arguments',
     },
     type: 'suggestion',
-    hasSuggestion: true,
+    hasSuggestions: true,
     schema: [
       {
         type: 'object',

diff --git a/src/rules/prefer-strict-equal.ts b/src/rules/prefer-strict-equal.ts
@@ -21,7 +21,7 @@ export default createRule({
     },
     type: 'suggestion',
     schema: [],
-    hasSuggestion: true,
+    hasSuggestions: true,
   },
   defaultOptions: [],
   create(context) {

diff --git a/tools/regenerate-docs.ts b/tools/regenerate-docs.ts
@@ -114,7 +114,7 @@ const details: RuleDetails[] = Object.keys(config.configs.all.rules)
       description: rule.meta.docs.description,
       fixable: rule.meta.fixable
         ? 'fixable'
-        : rule.meta.hasSuggestion
+        : rule.meta.hasSuggestions
         ? 'suggest'
         : false,
       requiresTypeChecking: rule.meta.docs.requiresTypeChecking ?? false,