@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230810155929-e89edf7

package/esm/rules/relay-edge-types.js

@@ -0,0 +1,148 @@
+import "../chunk-U3TKCM4X.js";
+import { getDocumentNodeFromSchema } from "@graphql-tools/utils";
+import {
+  isObjectType,
+  isScalarType,
+  Kind,
+  visit
+} from "graphql";
+import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "relay-edge-types", MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE", MESSAGE_MISSING_EDGE_SUFFIX = "MESSAGE_MISSING_EDGE_SUFFIX", MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE = "MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE", MESSAGE_SHOULD_IMPLEMENTS_NODE = "MESSAGE_SHOULD_IMPLEMENTS_NODE";
+let edgeTypesCache;
+function getEdgeTypes(schema2) {
+  if (edgeTypesCache)
+    return edgeTypesCache;
+  const edgeTypes = /* @__PURE__ */ new Set(), visitor = {
+    ObjectTypeDefinition(node) {
+      if (!node.name.value.endsWith("Connection"))
+        return;
+      const edges = node.fields?.find((field) => field.name.value === "edges");
+      if (edges) {
+        const edgesTypeName = getTypeName(edges), edgesType = schema2.getType(edgesTypeName);
+        isObjectType(edgesType) && edgeTypes.add(edgesTypeName);
+      }
+    }
+  }, astNode = getDocumentNodeFromSchema(schema2);
+  return visit(astNode, visitor), edgeTypesCache = edgeTypes, edgeTypesCache;
+}
+const schema = {
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    minProperties: 1,
+    properties: {
+      withEdgeSuffix: {
+        type: "boolean",
+        default: !0,
+        description: 'Edge type name must end in "Edge".'
+      },
+      shouldImplementNode: {
+        type: "boolean",
+        default: !0,
+        description: "Edge type's field `node` must implement `Node` interface."
+      },
+      listTypeCanWrapOnlyEdgeType: {
+        type: "boolean",
+        default: !0,
+        description: "A list type should only wrap an edge type."
+      }
+    }
+  }
+}, rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      category: "Schema",
+      description: [
+        "Set of rules to follow Relay specification for Edge types.",
+        "",
+        "- A type that is returned in list form by a connection type's `edges` field is considered by this spec to be an Edge type",
+        "- Edge type must be an Object type",
+        "- Edge type must contain a field `node` that return either Scalar, Enum, Object, Interface, Union, or a non-null wrapper around one of those types. Notably, this field cannot return a list",
+        "- Edge type must contain a field `cursor` that return either String, Scalar, or a non-null wrapper around one of those types",
+        '- Edge type name must end in "Edge" _(optional)_',
+        "- Edge type's field `node` must implement `Node` interface _(optional)_",
+        "- A list type should only wrap an edge type _(optional)_"
+      ].join(`
+`),
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      isDisabledForAllConfig: !0,
+      requiresSchema: !0,
+      examples: [
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type UserConnection {
+              edges: [UserEdge]
+              pageInfo: PageInfo!
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [MESSAGE_MUST_BE_OBJECT_TYPE]: "Edge type must be an Object type.",
+      [MESSAGE_MISSING_EDGE_SUFFIX]: 'Edge type must have "Edge" suffix.',
+      [MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE]: "A list type should only wrap an edge type.",
+      [MESSAGE_SHOULD_IMPLEMENTS_NODE]: "Edge type's field `node` must implement `Node` interface."
+    },
+    schema
+  },
+  create(context) {
+    const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context), edgeTypes = getEdgeTypes(schema2), options = {
+      withEdgeSuffix: !0,
+      shouldImplementNode: !0,
+      listTypeCanWrapOnlyEdgeType: !0,
+      ...context.options[0]
+    }, isNamedOrNonNullNamed = (node) => node.kind === Kind.NAMED_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.NAMED_TYPE, checkNodeField = (node) => {
+      const nodeField = node.fields?.find((field) => field.name.value === "node"), message = "return either a Scalar, Enum, Object, Interface, Union, or a non-null wrapper around one of those types.";
+      if (!nodeField)
+        context.report({
+          node: node.name,
+          message: `Edge type must contain a field \`node\` that ${message}`
+        });
+      else if (!isNamedOrNonNullNamed(nodeField.gqlType))
+        context.report({ node: nodeField.name, message: `Field \`node\` must ${message}` });
+      else if (options.shouldImplementNode) {
+        const nodeReturnTypeName = getTypeName(nodeField.gqlType.rawNode()), type = schema2.getType(nodeReturnTypeName);
+        if (!isObjectType(type))
+          return;
+        type.astNode.interfaces?.some((n) => n.name.value === "Node") || context.report({ node: node.name, messageId: MESSAGE_SHOULD_IMPLEMENTS_NODE });
+      }
+    }, checkCursorField = (node) => {
+      const cursorField = node.fields?.find((field) => field.name.value === "cursor"), message = "return either a String, Scalar, or a non-null wrapper wrapper around one of those types.";
+      if (!cursorField) {
+        context.report({
+          node: node.name,
+          message: `Edge type must contain a field \`cursor\` that ${message}`
+        });
+        return;
+      }
+      const typeName = getTypeName(cursorField.rawNode());
+      (!isNamedOrNonNullNamed(cursorField.gqlType) || typeName !== "String" && !isScalarType(schema2.getType(typeName))) && context.report({ node: cursorField.name, message: `Field \`cursor\` must ${message}` });
+    }, listeners = {
+      ":matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/Connection$/] > FieldDefinition[name.value=edges] > .gqlType Name"(node) {
+        const type = schema2.getType(node.value);
+        isObjectType(type) || context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
+      },
+      ":matches(ObjectTypeDefinition, ObjectTypeExtension)"(node) {
+        const typeName = node.name.value;
+        edgeTypes.has(typeName) && (checkNodeField(node), checkCursorField(node), options.withEdgeSuffix && !typeName.endsWith("Edge") && context.report({ node: node.name, messageId: MESSAGE_MISSING_EDGE_SUFFIX }));
+      }
+    };
+    return options.listTypeCanWrapOnlyEdgeType && (listeners["FieldDefinition > .gqlType"] = (node) => {
+      if (node.kind === Kind.LIST_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.LIST_TYPE) {
+        const typeName = getTypeName(node.rawNode());
+        edgeTypes.has(typeName) || context.report({ node, messageId: MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE });
+      }
+    }), listeners;
+  }
+};
+export {
+  rule
+};

package/esm/rules/relay-page-info.d.mts

@@ -0,0 +1,13 @@
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'json-schema-to-ts';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const rule: GraphQLESLintRule;
+
+export { rule };

package/esm/rules/relay-page-info.js

@@ -0,0 +1,80 @@
+import "../chunk-U3TKCM4X.js";
+import { isScalarType, Kind } from "graphql";
+import { REPORT_ON_FIRST_CHARACTER, requireGraphQLSchemaFromContext } from "../utils.js";
+import { NON_OBJECT_TYPES } from "./relay-connection-types.js";
+const RULE_ID = "relay-page-info", MESSAGE_MUST_EXIST = "MESSAGE_MUST_EXIST", MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE", notPageInfoTypesSelector = `:matches(${NON_OBJECT_TYPES})[name.value=PageInfo] > .name`;
+let hasPageInfoChecked = !1;
+const rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      category: "Schema",
+      description: [
+        "Set of rules to follow Relay specification for `PageInfo` object.",
+        "",
+        "- `PageInfo` must be an Object type",
+        "- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean",
+        "- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results"
+      ].join(`
+`),
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type PageInfo {
+              hasPreviousPage: Boolean!
+              hasNextPage: Boolean!
+              startCursor: String
+              endCursor: String
+            }
+          `
+          )
+        }
+      ],
+      isDisabledForAllConfig: !0,
+      requiresSchema: !0
+    },
+    messages: {
+      [MESSAGE_MUST_EXIST]: "The server must provide a `PageInfo` object.",
+      [MESSAGE_MUST_BE_OBJECT_TYPE]: "`PageInfo` must be an Object type."
+    },
+    schema: []
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    return hasPageInfoChecked || (schema.getType("PageInfo") || context.report({
+      loc: REPORT_ON_FIRST_CHARACTER,
+      messageId: MESSAGE_MUST_EXIST
+    }), hasPageInfoChecked = !0), {
+      [notPageInfoTypesSelector](node) {
+        context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
+      },
+      "ObjectTypeDefinition[name.value=PageInfo]"(node) {
+        const fieldMap = Object.fromEntries(
+          node.fields?.map((field) => [field.name.value, field]) || []
+        ), checkField = (fieldName, typeName) => {
+          const field = fieldMap[fieldName];
+          let isAllowedType = !1;
+          if (field) {
+            const type = field.gqlType;
+            typeName === "Boolean" ? isAllowedType = type.kind === Kind.NON_NULL_TYPE && type.gqlType.kind === Kind.NAMED_TYPE && type.gqlType.name.value === "Boolean" : type.kind === Kind.NAMED_TYPE && (isAllowedType = type.name.value === "String" || isScalarType(schema.getType(type.name.value)));
+          }
+          if (!isAllowedType) {
+            const returnType = typeName === "Boolean" ? "non-null Boolean" : "either String or Scalar, which can be null if there are no results";
+            context.report({
+              node: field ? field.name : node.name,
+              message: field ? `Field \`${fieldName}\` must return ${returnType}.` : `\`PageInfo\` must contain a field \`${fieldName}\`, that return ${returnType}.`
+            });
+          }
+        };
+        checkField("hasPreviousPage", "Boolean"), checkField("hasNextPage", "Boolean"), checkField("startCursor", "String"), checkField("endCursor", "String");
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/require-deprecation-date.d.mts

@@ -0,0 +1,27 @@
+import { FromSchema } from 'json-schema-to-ts';
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const schema: {
+    readonly type: "array";
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly argumentName: {
+                readonly type: "string";
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

package/esm/rules/require-deprecation-date.js

@@ -0,0 +1,129 @@
+import "../chunk-U3TKCM4X.js";
+import { valueFromNode } from "../estree-converter/index.js";
+import { getNodeName } from "../utils.js";
+const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/, MESSAGE_REQUIRE_DATE = "MESSAGE_REQUIRE_DATE", MESSAGE_INVALID_FORMAT = "MESSAGE_INVALID_FORMAT", MESSAGE_INVALID_DATE = "MESSAGE_INVALID_DATE", MESSAGE_CAN_BE_REMOVED = "MESSAGE_CAN_BE_REMOVED", schema = {
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    properties: {
+      argumentName: {
+        type: "string"
+      }
+    }
+  }
+}, rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: !0,
+    docs: {
+      category: "Schema",
+      description: "Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.",
+      url: "https://the-guild.dev/graphql/eslint/rules/require-deprecation-date",
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              firstname: String @deprecated
+              firstName: String
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              firstname: String @deprecated(reason: "Use 'firstName' instead")
+              firstName: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              firstname: String
+                @deprecated(reason: "Use 'firstName' instead", deletionDate: "25/12/2022")
+              firstName: String
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [MESSAGE_REQUIRE_DATE]: 'Directive "@deprecated" must have a deletion date for {{ nodeName }}',
+      [MESSAGE_INVALID_FORMAT]: 'Deletion date must be in format "DD/MM/YYYY" for {{ nodeName }}',
+      [MESSAGE_INVALID_DATE]: 'Invalid "{{ deletionDate }}" deletion date for {{ nodeName }}',
+      [MESSAGE_CAN_BE_REMOVED]: "{{ nodeName }} \u0441an be removed"
+    },
+    schema
+  },
+  create(context) {
+    return {
+      "Directive[name.value=deprecated]"(node) {
+        const argName = context.options[0]?.argumentName || "deletionDate", deletionDateNode = node.arguments?.find((arg) => arg.name.value === argName);
+        if (!deletionDateNode) {
+          context.report({
+            node: node.name,
+            messageId: MESSAGE_REQUIRE_DATE,
+            data: {
+              nodeName: getNodeName(node.parent)
+            }
+          });
+          return;
+        }
+        const deletionDate = valueFromNode(deletionDateNode.value);
+        if (!DATE_REGEX.test(deletionDate)) {
+          context.report({
+            node: deletionDateNode.value,
+            messageId: MESSAGE_INVALID_FORMAT,
+            data: { nodeName: getNodeName(node.parent) }
+          });
+          return;
+        }
+        let [day, month, year] = deletionDate.split("/");
+        day = day.padStart(2, "0"), month = month.padStart(2, "0");
+        const deletionDateInMS = Date.parse(`${year}-${month}-${day}`);
+        if (Number.isNaN(deletionDateInMS)) {
+          context.report({
+            node: deletionDateNode.value,
+            messageId: MESSAGE_INVALID_DATE,
+            data: {
+              deletionDate,
+              nodeName: getNodeName(node.parent)
+            }
+          });
+          return;
+        }
+        if (Date.now() > deletionDateInMS) {
+          const { parent } = node, nodeName = parent.name.value;
+          context.report({
+            node: parent.name,
+            messageId: MESSAGE_CAN_BE_REMOVED,
+            data: { nodeName: getNodeName(parent) },
+            suggest: [
+              {
+                desc: `Remove \`${nodeName}\``,
+                fix: (fixer) => fixer.remove(parent)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/require-deprecation-reason.d.mts

@@ -0,0 +1,13 @@
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'json-schema-to-ts';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const rule: GraphQLESLintRule;
+
+export { rule };

package/esm/rules/require-deprecation-reason.js

@@ -0,0 +1,66 @@
+import "../chunk-U3TKCM4X.js";
+import { valueFromNode } from "../estree-converter/index.js";
+import { getNodeName } from "../utils.js";
+const rule = {
+  meta: {
+    docs: {
+      description: "Require all deprecation directives to specify a reason.",
+      category: "Schema",
+      url: "https://the-guild.dev/graphql/eslint/rules/require-deprecation-reason",
+      recommended: !0,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type MyType {
+              name: String @deprecated
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type MyType {
+              name: String @deprecated(reason: "")
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type MyType {
+              name: String @deprecated(reason: "no longer relevant, please use fullName field")
+            }
+          `
+          )
+        }
+      ]
+    },
+    type: "suggestion",
+    schema: []
+  },
+  create(context) {
+    return {
+      "Directive[name.value=deprecated]"(node) {
+        const reasonArgument = node.arguments?.find(
+          (arg) => arg.name.value === "reason"
+        );
+        reasonArgument && String(valueFromNode(reasonArgument.value)).trim() || context.report({
+          node: node.name,
+          message: `Deprecation reason is required for ${getNodeName(node.parent)}.`
+        });
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/require-description.d.mts

@@ -0,0 +1,24 @@
+import { Kind } from 'graphql';
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'json-schema-to-ts';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const RULE_ID = "require-description";
+declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
+type AllowedKind = (typeof ALLOWED_KINDS)[number];
+type RuleOptions = [
+    {
+        [key in AllowedKind]?: boolean;
+    } & {
+        types?: boolean;
+        rootField?: boolean;
+    }
+];
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RULE_ID, RuleOptions, rule };

package/esm/rules/require-description.js

@@ -0,0 +1,165 @@
+import "../chunk-U3TKCM4X.js";
+import { getRootTypeNames } from "@graphql-tools/utils";
+import { Kind, TokenKind } from "graphql";
+import {
+  getLocation,
+  getNodeName,
+  requireGraphQLSchemaFromContext,
+  TYPES_KINDS
+} from "../utils.js";
+const RULE_ID = "require-description", ALLOWED_KINDS = [
+  ...TYPES_KINDS,
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.FIELD_DEFINITION,
+  Kind.INPUT_VALUE_DEFINITION,
+  Kind.ENUM_VALUE_DEFINITION,
+  Kind.OPERATION_DEFINITION
+], schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    minProperties: 1,
+    properties: {
+      types: {
+        type: "boolean",
+        description: `Includes:
+${TYPES_KINDS.map((kind) => `- \`${kind}\``).join(`
+`)}`
+      },
+      rootField: {
+        type: "boolean",
+        description: "Definitions within `Query`, `Mutation`, and `Subscription` root types."
+      },
+      ...Object.fromEntries(
+        [...ALLOWED_KINDS].sort().map((kind) => {
+          let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+          return kind === Kind.OPERATION_DEFINITION && (description += '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.'), [kind, { type: "boolean", description }];
+        })
+      )
+    }
+  }
+}, rule = {
+  meta: {
+    docs: {
+      category: "Schema",
+      description: "Enforce descriptions in type definitions and operations.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ types: !0, FieldDefinition: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            type someTypeName {
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ types: !0, FieldDefinition: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            """
+            Some type description
+            """
+            type someTypeName {
+              """
+              Name description
+              """
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ OperationDefinition: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ rootField: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            type Mutation {
+              "Create a new user"
+              createUser: User
+            }
+
+            type User {
+              name: String
+            }
+          `
+          )
+        }
+      ],
+      configOptions: [
+        {
+          types: !0,
+          [Kind.DIRECTIVE_DEFINITION]: !0,
+          rootField: !0
+        }
+      ],
+      recommended: !0
+    },
+    type: "suggestion",
+    messages: {
+      [RULE_ID]: "Description is required for {{ nodeName }}"
+    },
+    schema
+  },
+  create(context) {
+    const { types, rootField, ...restOptions } = context.options[0] || {}, kinds = new Set(types ? TYPES_KINDS : []);
+    for (const [kind, isEnabled] of Object.entries(restOptions))
+      isEnabled ? kinds.add(kind) : kinds.delete(kind);
+    if (rootField) {
+      const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context), rootTypeNames = getRootTypeNames(schema2);
+      kinds.add(
+        `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/^(${[
+          ...rootTypeNames
+        ].join(",")})$/] > FieldDefinition`
+      );
+    }
+    return {
+      [[...kinds].join(",")](node) {
+        let description = "";
+        const isOperation = node.kind === Kind.OPERATION_DEFINITION;
+        if (isOperation) {
+          const rawNode = node.rawNode(), { prev, line } = rawNode.loc.startToken;
+          if (prev?.kind === TokenKind.COMMENT) {
+            const value = prev.value.trim(), linesBefore = line - prev.line;
+            !value.startsWith("eslint") && linesBefore === 1 && (description = value);
+          }
+        } else
+          description = node.description?.value.trim() || "";
+        description.length === 0 && context.report({
+          loc: isOperation ? getLocation(node.loc.start, node.operation) : node.name.loc,
+          messageId: RULE_ID,
+          data: {
+            nodeName: getNodeName(node)
+          }
+        });
+      }
+    };
+  }
+};
+export {
+  RULE_ID,
+  rule
+};

package/esm/rules/require-field-of-type-query-in-mutation-result.d.mts

@@ -0,0 +1,13 @@
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'json-schema-to-ts';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const rule: GraphQLESLintRule;
+
+export { rule };