fixes

Author: dotansimha

example/.eslintrc.json

@@ -5,7 +5,9 @@
   },
   "plugins": ["@graphql-eslint"],
   "rules": {
-    "@graphql-eslint/require-id-when-available": "error",
+    "@graphql-eslint/require-id-when-available": ["error", {
+      "fieldName": "_id" 
+    }],
     "@graphql-eslint/validate-against-schema": "error",
     "@graphql-eslint/no-anonymous-operations": "warn",
     "@graphql-eslint/no-operation-name-suffix": "error",

example/query.graphql

@@ -1,5 +1,9 @@
 query test {
   user {
+    id
     name
+    ... on User {
+      name
+    }
   }
 }

packages/plugin/src/rules/require-id-when-available.ts

@@ -1,50 +1,74 @@
-import { GraphQLESLintRule } from "@graphql-eslint/types";
+import { GraphQLESLintRule, getBaseType } from "@graphql-eslint/types";
 import { GraphQLInterfaceType, GraphQLObjectType } from "graphql";
 
 const REQUIRE_ID_WHEN_AVAILABLE = "REQUIRE_ID_WHEN_AVAILABLE";
-const ID_FIELD_NAME = "id";
+const DEFAULT_ID_FIELD_NAME = "id";
 
-const rule: GraphQLESLintRule<any, true> = {
+type RequireIdWhenAvailableRuleConfig = { fieldName: string };
+
+const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true> = {
   meta: {
     messages: {
-      [REQUIRE_ID_WHEN_AVAILABLE]: `Field "id" must be selected when it's available on a type. Please make sure to include it in your selection set!`,
+      [REQUIRE_ID_WHEN_AVAILABLE]: `Field "{{ fieldName }}" must be selected when it's available on a type. Please make sure to include it in your selection set!`,
+    },
+    schema: {
+      type: "array",
+      additionalItems: false,
+      minItems: 0,
+      maxItems: 1,
+      items: {
+        type: "object",
+        properties: {
+          fieldName: {
+            type: "string",
+            default: DEFAULT_ID_FIELD_NAME,
+          },
+        },
+      },
     },
   },
   create(context) {
     return {
       SelectionSet(node) {
-        if (!node.selections || node.selections.length > 0) {
+        const fieldName =
+          (context.options[0] || {}).fieldName || DEFAULT_ID_FIELD_NAME;
+
+        if (!node.selections || node.selections.length === 0) {
           return;
         }
 
         if (node.typeInfo && node.typeInfo.gqlType) {
+          const rawType = getBaseType(node.typeInfo.gqlType);
           if (
-            node.typeInfo.gqlType instanceof GraphQLObjectType ||
-            node.typeInfo.gqlType instanceof GraphQLInterfaceType
+            rawType instanceof GraphQLObjectType ||
+            rawType instanceof GraphQLInterfaceType
           ) {
-            const fields = node.typeInfo.gqlType.getFields();
-            const hasIdFieldInType = !!fields[ID_FIELD_NAME];
-            const hasIdFieldInSelectionSet = !!node.selections.find(
-              (s) => s.kind === "Field" && s.name.value === ID_FIELD_NAME
-            );
-
-            if (hasIdFieldInType && !hasIdFieldInSelectionSet) {
-              context.report({
-                loc: {
-                  start: {
-                    line: node.loc.start.line,
-                    column: node.loc.start.column - 1,
+            const fields = rawType.getFields();
+            const hasIdFieldInType = !!fields[fieldName];
+
+            if (hasIdFieldInType) {
+              const hasIdFieldInSelectionSet = !!node.selections.find(
+                (s) => s.kind === "Field" && s.name.value === fieldName
+              );
+
+              if (!hasIdFieldInSelectionSet) {
+                context.report({
+                  loc: {
+                    start: {
+                      line: node.loc.start.line,
+                      column: node.loc.start.column - 1,
+                    },
+                    end: {
+                      line: node.loc.end.line,
+                      column: node.loc.end.column - 1,
+                    },
                   },
-                  end: {
-                    line: node.loc.end.line,
-                    column: node.loc.end.column - 1,
+                  messageId: REQUIRE_ID_WHEN_AVAILABLE,
+                  data: {
+                    fieldName,
                   },
-                },
-                messageId: REQUIRE_ID_WHEN_AVAILABLE,
-                data: {
-                  nodeType: node.kind,
-                },
-              });
+                });
+              }
             }
           }
         }

packages/types/src/utils.ts

@@ -13,6 +13,10 @@ import {
   ObjectValueNode,
   VariableNode,
   TokenKind,
+  GraphQLOutputType,
+  GraphQLNamedType,
+  isNonNullType,
+  isListType,
 } from "graphql";
 import { SourceLocation, Comment } from "estree";
 import { GraphQLESTreeNode } from "./estree-ast";
@@ -77,6 +81,14 @@ export function valueFromNode(
   }
 }
 
+export function getBaseType(type: GraphQLOutputType): GraphQLNamedType {
+  if (isNonNullType(type) || isListType(type)) {
+    return getBaseType(type.ofType);
+  }
+
+  return type;
+}
+
 export function convertRange(gqlLocation: Location): [number, number] {
   return [gqlLocation.start, gqlLocation.end];
 }