@graphql-eslint/eslint-plugin 4.3.0-alpha-20241205065956-601947f40654914ef0effc1cdf4fe269245fc7bc → 4.3.1-alpha-20241207204625-6a4230707a78900a6339b03afe904b9dd6c31561

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

@@ -6,50 +6,66 @@ import {
 } from "graphql";
 import { getDocumentNodeFromSchema } from "@graphql-tools/utils";
 import { getTypeName, requireGraphQLSchema } 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";
+const RULE_ID = "relay-edge-types";
+const MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE";
+const MESSAGE_MISSING_EDGE_SUFFIX = "MESSAGE_MISSING_EDGE_SUFFIX";
+const MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE = "MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE";
+const MESSAGE_SHOULD_IMPLEMENTS_NODE = "MESSAGE_SHOULD_IMPLEMENTS_NODE";
 let edgeTypesCache;
 function getEdgeTypes(schema2) {
-  if (process.env.NODE_ENV !== "test" && edgeTypesCache)
+  if (process.env.NODE_ENV !== "test" && edgeTypesCache) {
     return edgeTypesCache;
-  const edgeTypes = /* @__PURE__ */ new Set(), visitor = {
+  }
+  const edgeTypes = /* @__PURE__ */ new Set();
+  const visitor = {
     ObjectTypeDefinition(node) {
-      if (!node.name.value.endsWith("Connection"))
+      const typeName = node.name.value;
+      const hasConnectionSuffix = typeName.endsWith("Connection");
+      if (!hasConnectionSuffix) {
         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);
+        const edgesTypeName = getTypeName(edges);
+        const edgesType = schema2.getType(edgesTypeName);
+        if (isObjectType(edgesType)) {
+          edgeTypes.add(edgesTypeName);
+        }
       }
     }
-  }, astNode = getDocumentNodeFromSchema(schema2);
-  return visit(astNode, visitor), edgeTypesCache = edgeTypes, edgeTypesCache;
+  };
+  const astNode = getDocumentNodeFromSchema(schema2);
+  visit(astNode, visitor);
+  edgeTypesCache = edgeTypes;
+  return edgeTypesCache;
 }
 const schema = {
   type: "array",
   maxItems: 1,
   items: {
     type: "object",
-    additionalProperties: !1,
+    additionalProperties: false,
     minProperties: 1,
     properties: {
       withEdgeSuffix: {
         type: "boolean",
-        default: !0,
+        default: true,
         description: 'Edge type name must end in "Edge".'
       },
       shouldImplementNode: {
         type: "boolean",
-        default: !0,
+        default: true,
         description: "Edge type's field `node` must implement `Node` interface."
       },
       listTypeCanWrapOnlyEdgeType: {
         type: "boolean",
-        default: !0,
+        default: true,
         description: "A list type should only wrap an edge type."
       }
     }
   }
-}, rule = {
+};
+const rule = {
   meta: {
     type: "problem",
     docs: {
@@ -64,11 +80,10 @@ const schema = {
         '- 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(`
-`),
+      ].join("\n"),
       url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-      isDisabledForAllConfig: !0,
-      requiresSchema: !0,
+      isDisabledForAllConfig: true,
+      requiresSchema: true,
       examples: [
         {
           title: "Correct",
@@ -93,28 +108,40 @@ const schema = {
     schema
   },
   create(context) {
-    const schema2 = requireGraphQLSchema(RULE_ID, context), edgeTypes = getEdgeTypes(schema2), options = {
-      withEdgeSuffix: !0,
-      shouldImplementNode: !0,
-      listTypeCanWrapOnlyEdgeType: !0,
+    const schema2 = requireGraphQLSchema(RULE_ID, context);
+    const edgeTypes = getEdgeTypes(schema2);
+    const options = {
+      withEdgeSuffix: true,
+      shouldImplementNode: true,
+      listTypeCanWrapOnlyEdgeType: true,
       ...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)
+    };
+    const isNamedOrNonNullNamed = (node) => node.kind === Kind.NAMED_TYPE || node.kind === Kind.NON_NULL_TYPE && node.gqlType.kind === Kind.NAMED_TYPE;
+    const checkNodeField = (node) => {
+      const nodeField = node.fields?.find((field) => field.name.value === "node");
+      const 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))
+      } 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))
+      } else if (options.shouldImplementNode) {
+        const nodeReturnTypeName = getTypeName(nodeField.gqlType.rawNode());
+        const 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 });
+        }
+        const implementsNode = type.astNode.interfaces?.some((n) => n.name.value === "Node");
+        if (!implementsNode) {
+          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.";
+    };
+    const checkCursorField = (node) => {
+      const cursorField = node.fields?.find((field) => field.name.value === "cursor");
+      const message = "return either a String, Scalar, or a non-null wrapper wrapper around one of those types.";
       if (!cursorField) {
         context.report({
           node: node.name,
@@ -123,23 +150,39 @@ const schema = {
         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 = {
+      if (!isNamedOrNonNullNamed(cursorField.gqlType) || typeName !== "String" && !isScalarType(schema2.getType(typeName))) {
+        context.report({ node: cursorField.name, message: `Field \`cursor\` must ${message}` });
+      }
+    };
+    const 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 });
+        if (!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 }));
+        if (edgeTypes.has(typeName)) {
+          checkNodeField(node);
+          checkCursorField(node);
+          if (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;
+    if (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());
+          if (!edgeTypes.has(typeName)) {
+            context.report({ node, messageId: MESSAGE_LIST_TYPE_ONLY_EDGE_TYPE });
+          }
+        }
+      };
+    }
+    return listeners;
   }
 };
 export {

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

@@ -1,8 +1,11 @@
 import { isScalarType, Kind } from "graphql";
 import { REPORT_ON_FIRST_CHARACTER, requireGraphQLSchema } from "../../utils.js";
 import { NON_OBJECT_TYPES } from "../relay-connection-types/index.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_ID = "relay-page-info";
+const MESSAGE_MUST_EXIST = "MESSAGE_MUST_EXIST";
+const MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE";
+const notPageInfoTypesSelector = `:matches(${NON_OBJECT_TYPES})[name.value=PageInfo] > .name`;
+let hasPageInfoChecked = false;
 const rule = {
   meta: {
     type: "problem",
@@ -14,8 +17,7 @@ const rule = {
         "- `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(`
-`),
+      ].join("\n"),
       url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
       examples: [
         {
@@ -33,8 +35,8 @@ const rule = {
           )
         }
       ],
-      isDisabledForAllConfig: !0,
-      requiresSchema: !0
+      isDisabledForAllConfig: true,
+      requiresSchema: true
     },
     messages: {
       [MESSAGE_MUST_EXIST]: "The server must provide a `PageInfo` object.",
@@ -44,22 +46,34 @@ const rule = {
   },
   create(context) {
     const schema = requireGraphQLSchema(RULE_ID, context);
-    return (process.env.NODE_ENV === "test" || !hasPageInfoChecked) && (schema.getType("PageInfo") || context.report({
-      loc: REPORT_ON_FIRST_CHARACTER,
-      messageId: MESSAGE_MUST_EXIST
-    }), hasPageInfoChecked = !0), {
+    if (process.env.NODE_ENV === "test" || !hasPageInfoChecked) {
+      const pageInfoType = schema.getType("PageInfo");
+      if (!pageInfoType) {
+        context.report({
+          loc: REPORT_ON_FIRST_CHARACTER,
+          messageId: MESSAGE_MUST_EXIST
+        });
+      }
+      hasPageInfoChecked = true;
+    }
+    return {
       [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 checkField = (fieldName, typeName) => {
           const field = fieldMap[fieldName];
-          let isAllowedType = !1;
+          let isAllowedType = false;
           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 (typeName === "Boolean") {
+              isAllowedType = type.kind === Kind.NON_NULL_TYPE && type.gqlType.kind === Kind.NAMED_TYPE && type.gqlType.name.value === "Boolean";
+            } else if (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";
@@ -69,7 +83,10 @@ const rule = {
             });
           }
         };
-        checkField("hasPreviousPage", "Boolean"), checkField("hasNextPage", "Boolean"), checkField("startCursor", "String"), checkField("endCursor", "String");
+        checkField("hasPreviousPage", "Boolean");
+        checkField("hasNextPage", "Boolean");
+        checkField("startCursor", "String");
+        checkField("endCursor", "String");
       }
     };
   }

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

@@ -1,21 +1,27 @@
 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 = {
+const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/;
+const MESSAGE_REQUIRE_DATE = "MESSAGE_REQUIRE_DATE";
+const MESSAGE_INVALID_FORMAT = "MESSAGE_INVALID_FORMAT";
+const MESSAGE_INVALID_DATE = "MESSAGE_INVALID_DATE";
+const MESSAGE_CAN_BE_REMOVED = "MESSAGE_CAN_BE_REMOVED";
+const schema = {
   type: "array",
   maxItems: 1,
   items: {
     type: "object",
-    additionalProperties: !1,
+    additionalProperties: false,
     properties: {
       argumentName: {
         type: "string"
       }
     }
   }
-}, rule = {
+};
+const rule = {
   meta: {
     type: "suggestion",
-    hasSuggestions: !0,
+    hasSuggestions: true,
     docs: {
       category: "Schema",
       description: "Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.",
@@ -71,7 +77,8 @@ const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/, MESSAGE_REQUIRE_DATE = "MESSAGE_REQU
   create(context) {
     return {
       "Directive[name.value=deprecated]"(node) {
-        const argName = context.options[0]?.argumentName || "deletionDate", deletionDateNode = node.arguments?.find((arg) => arg.name.value === argName);
+        const argName = context.options[0]?.argumentName || "deletionDate";
+        const deletionDateNode = node.arguments?.find((arg) => arg.name.value === argName);
         if (!deletionDateNode) {
           context.report({
             node: node.name,
@@ -83,7 +90,8 @@ const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/, MESSAGE_REQUIRE_DATE = "MESSAGE_REQU
           return;
         }
         const deletionDate = valueFromNode(deletionDateNode.value);
-        if (!DATE_REGEX.test(deletionDate)) {
+        const isValidDate = DATE_REGEX.test(deletionDate);
+        if (!isValidDate) {
           context.report({
             node: deletionDateNode.value,
             messageId: MESSAGE_INVALID_FORMAT,
@@ -92,7 +100,8 @@ const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/, MESSAGE_REQUIRE_DATE = "MESSAGE_REQU
           return;
         }
         let [day, month, year] = deletionDate.split("/");
-        day = day.padStart(2, "0"), month = month.padStart(2, "0");
+        day = day.padStart(2, "0");
+        month = month.padStart(2, "0");
         const deletionDateInMS = Date.parse(`${year}-${month}-${day}`);
         if (Number.isNaN(deletionDateInMS)) {
           context.report({
@@ -105,8 +114,10 @@ const DATE_REGEX = /^\d{2}\/\d{2}\/\d{4}$/, MESSAGE_REQUIRE_DATE = "MESSAGE_REQU
           });
           return;
         }
-        if (Date.now() > deletionDateInMS) {
-          const { parent } = node, nodeName = parent.name.value;
+        const canRemove = Date.now() > deletionDateInMS;
+        if (canRemove) {
+          const { parent } = node;
+          const nodeName = parent.name.value;
           context.report({
             node: parent.name,
             messageId: MESSAGE_CAN_BE_REMOVED,

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

@@ -6,7 +6,7 @@ const rule = {
       description: "Require all deprecation directives to specify a reason.",
       category: "Schema",
       url: "https://the-guild.dev/graphql/eslint/rules/require-deprecation-reason",
-      recommended: !0,
+      recommended: true,
       examples: [
         {
           title: "Incorrect",
@@ -52,10 +52,13 @@ const rule = {
         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)}.`
-        });
+        const value = reasonArgument && String(valueFromNode(reasonArgument.value)).trim();
+        if (!value) {
+          context.report({
+            node: node.name,
+            message: `Deprecation reason is required for ${getNodeName(node.parent)}.`
+          });
+        }
       }
     };
   }

package/esm/rules/require-description/index.d.ts

@@ -1,25 +1,91 @@
-import { Kind } from 'graphql';
+import { FromSchema } from 'json-schema-to-ts';
 import { GraphQLESLintRule } from '../../types.js';
 import 'eslint';
 import 'estree';
+import 'graphql';
 import 'graphql-config';
-import 'json-schema-to-ts';
 import '../../estree-converter/types.js';
 import '../../siblings.js';
 import '@graphql-tools/utils';
 
 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?: true;
-        rootField?: true;
-        ignoredSelectors?: string[];
-    }
-];
+declare const schema: {
+    readonly type: "array";
+    readonly minItems: 1;
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly OperationDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly ScalarTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly ObjectTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly FieldDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly InputValueDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly InterfaceTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly UnionTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly EnumTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly EnumValueDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly InputObjectTypeDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly DirectiveDefinition: {
+                type: "boolean";
+                description: string;
+            };
+            readonly types: {
+                readonly type: "boolean";
+                readonly enum: readonly [true];
+                readonly description: `Includes:
+${string}`;
+            };
+            readonly rootField: {
+                readonly type: "boolean";
+                readonly enum: readonly [true];
+                readonly description: "Definitions within `Query`, `Mutation`, and `Subscription` root types.";
+            };
+            readonly ignoredSelectors: {
+                readonly description: string;
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+                readonly items: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
 declare const rule: GraphQLESLintRule<RuleOptions>;
 
 export { RULE_ID, type RuleOptions, rule };