feat: convert fix to suggestions in no-unreachable-types and no-unused-fields rules (#827)

Author: dimaMachina

.changeset/odd-bikes-deny.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feat: convert fix to suggestions in `no-unreachable-types` and `no-unused-fields` rules

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-  "eslint.enable": true,  
+  "eslint.enable": true,
   "files.exclude": {
     "**/.git": true,
     "**/.DS_Store": true,
@@ -10,5 +10,12 @@
     "npm": true,
     "**/dist": true
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
-}
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "eslint.workingDirectories": [
+    {
+      "mode": "auto",
+      "changeProcessCWD": true
+    }
+  ],
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "graphql"]
+}

docs/README.md

@@ -2,8 +2,6 @@
 
 ✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
 
-🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#--fix) can automatically fix some of the problems reported by this rule.
-
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-unreachable-types`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

docs/rules/no-unreachable-types.md

@@ -1,7 +1,5 @@
 # `no-unused-fields`
 
-🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#--fix) can automatically fix some of the problems reported by this rule.
-
 - Category: `Schema`
 - Rule name: `@graphql-eslint/no-unused-fields`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

docs/rules/no-unused-fields.md

@@ -1,4 +1,4 @@
-const { pathsToModuleNameMapper } = require('ts-jest/utils');
+const { pathsToModuleNameMapper } = require('ts-jest');
 const { compilerOptions } = require('./tsconfig.json');
 
 module.exports = {

jest.config.js

@@ -1,9 +1,29 @@
-import { Kind } from 'graphql';
-import { GraphQLESLintRule } from '../types';
+import { ASTKindToNode, Kind } from 'graphql';
+import { GraphQLESLintRule, ValueOf } from '../types';
 import { getLocation, requireReachableTypesFromContext } from '../utils';
+import { GraphQLESTreeNode } from '../estree-parser';
 
 const UNREACHABLE_TYPE = 'UNREACHABLE_TYPE';
-const RULE_NAME = 'no-unreachable-types';
+const RULE_ID = 'no-unreachable-types';
+
+const KINDS = [
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.OBJECT_TYPE_DEFINITION,
+  Kind.OBJECT_TYPE_EXTENSION,
+  Kind.INTERFACE_TYPE_DEFINITION,
+  Kind.INTERFACE_TYPE_EXTENSION,
+  Kind.SCALAR_TYPE_DEFINITION,
+  Kind.SCALAR_TYPE_EXTENSION,
+  Kind.INPUT_OBJECT_TYPE_DEFINITION,
+  Kind.INPUT_OBJECT_TYPE_EXTENSION,
+  Kind.UNION_TYPE_DEFINITION,
+  Kind.UNION_TYPE_EXTENSION,
+  Kind.ENUM_TYPE_DEFINITION,
+  Kind.ENUM_TYPE_EXTENSION,
+] as const;
+
+type AllowedKind = typeof KINDS[number];
+type AllowedKindToNode = Pick<ASTKindToNode, AllowedKind>;
 
 const rule: GraphQLESLintRule = {
   meta: {
@@ -13,7 +33,7 @@ const rule: GraphQLESLintRule = {
     docs: {
       description: `Requires all types to be reachable at some level by root level fields.`,
       category: 'Schema',
-      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME}.md`,
+      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
       requiresSchema: true,
       examples: [
         {
@@ -45,40 +65,32 @@ const rule: GraphQLESLintRule = {
       ],
       recommended: true,
     },
-    fixable: 'code',
     type: 'suggestion',
     schema: [],
+    hasSuggestions: true,
   },
   create(context) {
-    const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
-
-    function ensureReachability(node): void {
-      const typeName = node.name.value;
-
-      if (!reachableTypes.has(typeName)) {
-        context.report({
-          loc: getLocation(node.name.loc, typeName, { offsetStart: node.kind === Kind.DIRECTIVE_DEFINITION ? 2 : 1 }),
-          messageId: UNREACHABLE_TYPE,
-          data: { typeName },
-          fix: fixer => fixer.remove(node),
-        });
-      }
-    }
+    const reachableTypes = requireReachableTypesFromContext(RULE_ID, context);
+    const selector = KINDS.join(',');
 
     return {
-      DirectiveDefinition: ensureReachability,
-      ObjectTypeDefinition: ensureReachability,
-      ObjectTypeExtension: ensureReachability,
-      InterfaceTypeDefinition: ensureReachability,
-      InterfaceTypeExtension: ensureReachability,
-      ScalarTypeDefinition: ensureReachability,
-      ScalarTypeExtension: ensureReachability,
-      InputObjectTypeDefinition: ensureReachability,
-      InputObjectTypeExtension: ensureReachability,
-      UnionTypeDefinition: ensureReachability,
-      UnionTypeExtension: ensureReachability,
-      EnumTypeDefinition: ensureReachability,
-      EnumTypeExtension: ensureReachability,
+      [selector](node: GraphQLESTreeNode<ValueOf<AllowedKindToNode>>) {
+        const typeName = node.name.value;
+
+        if (!reachableTypes.has(typeName)) {
+          context.report({
+            loc: getLocation(node.name.loc, typeName, { offsetStart: node.kind === Kind.DIRECTIVE_DEFINITION ? 2 : 1 }),
+            messageId: UNREACHABLE_TYPE,
+            data: { typeName },
+            suggest: [
+              {
+                desc: `Remove ${typeName}`,
+                fix: fixer => fixer.remove(node as any),
+              },
+            ],
+          });
+        }
+      },
     };
   },
 };

packages/plugin/src/rules/no-unreachable-types.ts

@@ -2,7 +2,7 @@ import { GraphQLESLintRule } from '../types';
 import { getLocation, requireUsedFieldsFromContext } from '../utils';
 
 const UNUSED_FIELD = 'UNUSED_FIELD';
-const RULE_NAME = 'no-unused-fields';
+const RULE_ID = 'no-unused-fields';
 
 const rule: GraphQLESLintRule = {
   meta: {
@@ -12,7 +12,7 @@ const rule: GraphQLESLintRule = {
     docs: {
       description: `Requires all fields to be used at some level by siblings operations.`,
       category: 'Schema',
-      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME}.md`,
+      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
       requiresSiblings: true,
       requiresSchema: true,
       examples: [
@@ -59,12 +59,12 @@ const rule: GraphQLESLintRule = {
         },
       ],
     },
-    fixable: 'code',
     type: 'suggestion',
     schema: [],
+    hasSuggestions: true,
   },
   create(context) {
-    const usedFields = requireUsedFieldsFromContext(RULE_NAME, context);
+    const usedFields = requireUsedFieldsFromContext(RULE_ID, context);
 
     return {
       FieldDefinition(node) {
@@ -80,24 +80,19 @@ const rule: GraphQLESLintRule = {
           loc: getLocation(node.loc, fieldName),
           messageId: UNUSED_FIELD,
           data: { fieldName },
-          fix(fixer) {
-            const sourceCode = context.getSourceCode();
-            const tokenBefore = (sourceCode as any).getTokenBefore(node);
-            const tokenAfter = (sourceCode as any).getTokenAfter(node);
-            const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
+          suggest: [
+            {
+              desc: `Remove "${fieldName}" field`,
+              fix(fixer) {
+                const sourceCode = context.getSourceCode() as any;
+                const tokenBefore = sourceCode.getTokenBefore(node);
+                const tokenAfter = sourceCode.getTokenAfter(node);
+                const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
 
-            if (isEmptyType) {
-              // Remove type
-              const { parent } = node as any;
-              const parentBeforeToken = sourceCode.getTokenBefore(parent);
-              return parentBeforeToken
-                ? fixer.removeRange([parentBeforeToken.range[1], parent.range[1]])
-                : fixer.remove(parent);
-            }
-
-            // Remove whitespace before token
-            return fixer.removeRange([tokenBefore.range[1], node.range[1]]);
-          },
+                return isEmptyType ? fixer.remove((node as any).parent) : fixer.remove(node as any);
+              },
+            },
+          ],
         });
       },
     };

packages/plugin/src/rules/no-unused-fields.ts

@@ -116,9 +116,7 @@ exports[` 4`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 5`] = `
@@ -153,9 +151,7 @@ exports[` 5`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 6`] = `
@@ -190,9 +186,7 @@ exports[` 6`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 7`] = `
@@ -227,9 +221,7 @@ exports[` 7`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 8`] = `
@@ -264,9 +256,7 @@ exports[` 8`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 9`] = `
@@ -301,9 +291,7 @@ exports[` 9`] = `
   28 |         type User implements Address {
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 10`] = `
@@ -338,9 +326,7 @@ exports[` 10`] = `
      |              ^^^^ Type "User" is unreachable
   29 |           city: String
   30 |         }
-  31 |
-  32 |         type Query
-  33 |       
+  31 |       
 `;
 
 exports[` 11`] = `

packages/plugin/tests/__snapshots__/no-unreachable-types.spec.ts.snap

@@ -2,25 +2,23 @@
 
 exports[` 1`] = `
   1 |
-  2 |         # normalize graphql
-  3 |         type User {
-  4 |           id: ID!
-> 5 |           firstName: String
+  2 |         type User {
+  3 |           id: ID!
+> 4 |           firstName: String
     |           ^^^^^^^^^ Field "firstName" is unused
-  6 |         }
-  7 |       
+  5 |         }
+  6 |       
 `;
 
 exports[` 2`] = `
-   1 |
-   2 |         # normalize graphql
-   3 |         type Query {
-   4 |           user(id: ID!): User
-   5 |         }
-   6 |
-   7 |         type Mutation {
->  8 |           deleteUser(id: ID!): User
-     |           ^^^^^^^^^^ Field "deleteUser" is unused
-   9 |         }
-  10 |       
+  1 |
+  2 |         type Query {
+  3 |           user(id: ID!): User
+  4 |         }
+  5 |
+  6 |         type Mutation {
+> 7 |           deleteUser(id: ID!): User
+    |           ^^^^^^^^^^ Field "deleteUser" is unused
+  8 |         }
+  9 |       
 `;