feat: add suggestions for no-duplicate-fields, no-hashtag-description and selection-set-depth rules (#971)

dimaMachina · web-flow · commit 1f697f0f333d · 2022-02-19T02:15:42.000+01:00
* feat: add suggestions for `no-duplicate-fields`, `no-hashtag-description` and `selection-set-depth` rules

* update snapshots
diff --git a/.changeset/many-otters-scream.md b/.changeset/many-otters-scream.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feat: add suggestions for `no-duplicate-fields`, `no-hashtag-description` and `selection-set-depth` rules
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/rules/description-style.md b/docs/rules/description-style.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/description-style`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/input-name.md b/docs/rules/input-name.md
@@ -1,5 +1,7 @@
 # `input-name`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/input-name`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/naming-convention.md b/docs/rules/naming-convention.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema & Operations`
 - Rule name: `@graphql-eslint/naming-convention`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-anonymous-operations.md b/docs/rules/no-anonymous-operations.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Operations`
 - Rule name: `@graphql-eslint/no-anonymous-operations`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-case-insensitive-enum-values-duplicates.md b/docs/rules/no-case-insensitive-enum-values-duplicates.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-case-insensitive-enum-values-duplicates`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-deprecated.md b/docs/rules/no-deprecated.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Operations`
 - Rule name: `@graphql-eslint/no-deprecated`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-duplicate-fields.md b/docs/rules/no-duplicate-fields.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Operations`
 - Rule name: `@graphql-eslint/no-duplicate-fields`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-hashtag-description.md b/docs/rules/no-hashtag-description.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-hashtag-description`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-root-type.md b/docs/rules/no-root-type.md
@@ -1,5 +1,7 @@
 # `no-root-type`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-root-type`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-scalar-result-type-on-mutation.md b/docs/rules/no-scalar-result-type-on-mutation.md
@@ -1,5 +1,7 @@
 # `no-scalar-result-type-on-mutation`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-scalar-result-type-on-mutation`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-typename-prefix.md b/docs/rules/no-typename-prefix.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-typename-prefix`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-unreachable-types.md b/docs/rules/no-unreachable-types.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-unreachable-types`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/no-unused-fields.md b/docs/rules/no-unused-fields.md
@@ -1,5 +1,7 @@
 # `no-unused-fields`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-unused-fields`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/require-deprecation-date.md b/docs/rules/require-deprecation-date.md
@@ -1,5 +1,7 @@
 # `require-deprecation-date`
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/require-deprecation-date`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/require-id-when-available.md b/docs/rules/require-id-when-available.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Operations`
 - Rule name: `@graphql-eslint/require-id-when-available`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/docs/rules/selection-set-depth.md b/docs/rules/selection-set-depth.md
@@ -2,6 +2,8 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
 
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
 - Category: `Operations`
 - Rule name: `@graphql-eslint/selection-set-depth`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
diff --git a/packages/plugin/src/rules/naming-convention.ts b/packages/plugin/src/rules/naming-convention.ts
@@ -260,6 +260,19 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
       return typeof style === 'object' ? style : { style };
     }
 
+    function report(node: GraphQLESTreeNode<NameNode>, message: string, suggestedName: string): void {
+      context.report({
+        node,
+        message,
+        suggest: [
+          {
+            desc: `Rename to \`${suggestedName}\``,
+            fix: fixer => fixer.replaceText(node as any, suggestedName),
+          },
+        ],
+      });
+    }
+
     const checkNode = (selector: string) => (n: GraphQLESTreeNode<ValueOf<AllowedKindToNode>>) => {
       const { name: node } = n.kind === Kind.VARIABLE_DEFINITION ? n.variable : n;
       if (!node) {
@@ -275,16 +288,7 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
         const [leadingUnderscores] = nodeName.match(/^_*/);
         const [trailingUnderscores] = nodeName.match(/_*$/);
         const suggestedName = leadingUnderscores + renameToName + trailingUnderscores;
-        context.report({
-          node,
-          message: `${nodeType} "${nodeName}" should ${errorMessage}`,
-          suggest: [
-            {
-              desc: `Rename to "${suggestedName}"`,
-              fix: fixer => fixer.replaceText(node as any, suggestedName),
-            },
-          ],
-        });
+        report(node, `${nodeType} "${nodeName}" should ${errorMessage}`, suggestedName);
       }
 
       function getError(): {
@@ -336,18 +340,8 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
     };
 
     const checkUnderscore = (isLeading: boolean) => (node: GraphQLESTreeNode<NameNode>) => {
-      const name = node.value;
-      const renameToName = name.replace(new RegExp(isLeading ? '^_+' : '_+$'), '');
-      context.report({
-        node,
-        message: `${isLeading ? 'Leading' : 'Trailing'} underscores are not allowed`,
-        suggest: [
-          {
-            desc: `Rename to "${renameToName}"`,
-            fix: fixer => fixer.replaceText(node as any, renameToName),
-          },
-        ],
-      });
+      const suggestedName = node.value.replace(isLeading ? /^_+/ : /_+$/, '');
+      report(node, `${isLeading ? 'Leading' : 'Trailing'} underscores are not allowed`, suggestedName);
     };
 
     const listeners: GraphQLESLintRuleListener = {};
diff --git a/packages/plugin/src/rules/no-duplicate-fields.ts b/packages/plugin/src/rules/no-duplicate-fields.ts
@@ -2,15 +2,16 @@ import { Kind, NameNode } from 'graphql';
 import { GraphQLESLintRule } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser';
 
-const NO_DUPLICATE_FIELDS = 'NO_DUPLICATE_FIELDS';
+const RULE_ID = 'no-duplicate-fields';
 
 const rule: GraphQLESLintRule = {
   meta: {
     type: 'suggestion',
+    hasSuggestions: true,
     docs: {
       description: `Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.`,
       category: 'Operations',
-      url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/no-duplicate-fields.md',
+      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
       recommended: true,
       examples: [
         {
@@ -56,21 +57,30 @@ const rule: GraphQLESLintRule = {
       ],
     },
     messages: {
-      [NO_DUPLICATE_FIELDS]: `{{ type }} "{{ fieldName }}" defined multiple times`,
+      [RULE_ID]: '{{ type }} `{{ fieldName }}` defined multiple times.',
     },
     schema: [],
   },
   create(context) {
-    function checkNode(usedFields: Set<string>, type: string, node: GraphQLESTreeNode<NameNode>): void {
+    function checkNode(usedFields: Set<string>, node: GraphQLESTreeNode<NameNode>): void {
       const fieldName = node.value;
       if (usedFields.has(fieldName)) {
+        const { parent } = node as any;
         context.report({
           node,
-          messageId: NO_DUPLICATE_FIELDS,
+          messageId: RULE_ID,
           data: {
-            type,
+            type: parent.type,
             fieldName,
           },
+          suggest: [
+            {
+              desc: `Remove \`${fieldName}\` ${parent.type.toLowerCase()}`,
+              fix(fixer) {
+                return fixer.remove(parent.type === Kind.VARIABLE ? parent.parent : parent);
+              },
+            },
+          ],
         });
       } else {
         usedFields.add(fieldName);
@@ -81,20 +91,20 @@ const rule: GraphQLESLintRule = {
       OperationDefinition(node) {
         const set = new Set<string>();
         for (const varDef of node.variableDefinitions) {
-          checkNode(set, 'Operation variable', varDef.variable.name);
+          checkNode(set, varDef.variable.name);
         }
       },
       Field(node) {
         const set = new Set<string>();
         for (const arg of node.arguments) {
-          checkNode(set, 'Field argument', arg.name);
+          checkNode(set, arg.name);
         }
       },
       SelectionSet(node) {
         const set = new Set<string>();
         for (const selection of node.selections) {
           if (selection.kind === Kind.FIELD) {
-            checkNode(set, 'Field', selection.alias || selection.name);
+            checkNode(set, selection.alias || selection.name);
           }
         }
       },
diff --git a/packages/plugin/src/rules/no-hashtag-description.ts b/packages/plugin/src/rules/no-hashtag-description.ts
@@ -6,8 +6,12 @@ const HASHTAG_COMMENT = 'HASHTAG_COMMENT';
 
 const rule: GraphQLESLintRule = {
   meta: {
+    type: 'suggestion',
+    hasSuggestions: true,
+    schema: [],
     messages: {
-      [HASHTAG_COMMENT]: `Using hashtag (#) for adding GraphQL descriptions is not allowed. Prefer using """ for multiline, or " for a single line description.`,
+      [HASHTAG_COMMENT]:
+        'Using hashtag `#` for adding GraphQL descriptions is not allowed. Prefer using `"""` for multiline, or `"` for a single line description.',
     },
     docs: {
       description:
@@ -51,8 +55,6 @@ const rule: GraphQLESLintRule = {
       ],
       recommended: true,
     },
-    type: 'suggestion',
-    schema: [],
   },
   create(context) {
     const selector = 'Document[definitions.0.kind!=/^(OperationDefinition|FragmentDefinition)$/]';
@@ -61,9 +63,8 @@ const rule: GraphQLESLintRule = {
         const rawNode = node.rawNode();
         let token = rawNode.loc.startToken;
 
-        while (token !== null) {
+        while (token) {
           const { kind, prev, next, value, line, column } = token;
-
           if (kind === TokenKind.COMMENT && prev && next) {
             const isEslintComment = value.trimStart().startsWith('eslint');
             const linesAfter = next.line - line;
@@ -75,6 +76,14 @@ const rule: GraphQLESLintRule = {
                   line,
                   column: column - 1,
                 },
+                suggest: ['"""', '"'].map(descriptionSyntax => ({
+                  desc: `Replace with \`${descriptionSyntax}\` description syntax`,
+                  fix: fixer =>
+                    fixer.replaceTextRange(
+                      [token.start, token.end] as [number, number],
+                      [descriptionSyntax, value.trim(), descriptionSyntax].join('')
+                    ),
+                })),
               });
             }
           }
diff --git a/packages/plugin/src/rules/selection-set-depth.ts b/packages/plugin/src/rules/selection-set-depth.ts
@@ -1,16 +1,19 @@
+import type { AST } from 'eslint';
 import { GraphQLESLintRule } from '../types';
 import depthLimit from 'graphql-depth-limit';
 import { DocumentNode, FragmentDefinitionNode, GraphQLError, Kind, OperationDefinitionNode } from 'graphql';
 import { GraphQLESTreeNode } from '../estree-parser';
 import { logger, requireSiblingsOperations } from '../utils';
 import { SiblingOperations } from '../sibling-operations';
 
-type SelectionSetDepthRuleConfig = { maxDepth: number; ignore?: string[] };
+export type SelectionSetDepthRuleConfig = { maxDepth: number; ignore?: string[] };
 
 const RULE_ID = 'selection-set-depth';
 
 const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
   meta: {
+    type: 'suggestion',
+    hasSuggestions: true,
     docs: {
       category: 'Operations',
       description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
@@ -60,7 +63,6 @@ const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
       recommended: true,
       configOptions: [{ maxDepth: 7 }],
     },
-    type: 'suggestion',
     schema: {
       type: 'array',
       minItems: 1,
@@ -122,6 +124,22 @@ const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
                   column: column - 1,
                 },
                 message: error.message,
+                suggest: [
+                  {
+                    desc: 'Remove selections',
+                    fix(fixer) {
+                      const { line, column } = error.locations[0];
+                      const ancestors = context.getAncestors();
+                      const token = (ancestors[0] as AST.Program).tokens.find(
+                        token => token.loc.start.line === line && token.loc.start.column === column - 1
+                      );
+                      const sourceCode = context.getSourceCode();
+                      const foundNode = sourceCode.getNodeByRangeIndex(token.range[0]) as any;
+                      const parentNode = foundNode.parent.parent;
+                      return fixer.remove(foundNode.kind === 'Name' ? parentNode.parent : parentNode);
+                    },
+                  },
+                ],
               });
             },
           });
diff --git a/packages/plugin/tests/__snapshots__/examples.spec.md b/packages/plugin/tests/__snapshots__/examples.spec.md
@@ -191,7 +191,7 @@ Array [
     filePath: examples/graphql-config/operations/user.fragment.graphql,
     messages: Array [
       Object {
-        message: Field "name" defined multiple times,
+        message: Field \`name\` defined multiple times.,
         ruleId: @graphql-eslint/no-duplicate-fields,
       },
     ],
diff --git a/packages/plugin/tests/__snapshots__/naming-convention.spec.md b/packages/plugin/tests/__snapshots__/naming-convention.spec.md
diff --git a/packages/plugin/tests/__snapshots__/no-duplicate-fields.spec.md b/packages/plugin/tests/__snapshots__/no-duplicate-fields.spec.md
diff --git a/packages/plugin/tests/__snapshots__/no-hashtag-description.spec.md b/packages/plugin/tests/__snapshots__/no-hashtag-description.spec.md
diff --git a/packages/plugin/tests/__snapshots__/selection-set-depth.spec.md b/packages/plugin/tests/__snapshots__/selection-set-depth.spec.md
diff --git a/packages/plugin/tests/no-duplicate-fields.spec.ts b/packages/plugin/tests/no-duplicate-fields.spec.ts
diff --git a/packages/plugin/tests/selection-set-depth.spec.ts b/packages/plugin/tests/selection-set-depth.spec.ts
diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': minor
 +---
++
 +feat: add suggestions for `no-duplicate-fields`, `no-hashtag-description` and `selection-set-depth` rules