@graphql-eslint/eslint-plugin 4.3.0 → 4.4.0-alpha-20241207210859-41eb4549764dc0314b5bd4f257ea6667b178540e

package/cjs/rules/graphql-js-validation.js

@@ -49,61 +49,77 @@ function validateDocument({
   rule,
   hasDidYouMeanSuggestions
 }) {
-  if (documentNode.definitions.length !== 0)
-    try {
-      const validationErrors = schema ? _graphql.validate.call(void 0, schema, documentNode, [rule]) : _validatejs.validateSDL.call(void 0, documentNode, null, [rule]);
-      for (const error of validationErrors) {
-        const { line, column } = error.locations[0], sourceCode = context.getSourceCode(), { tokens } = sourceCode.ast, token = tokens.find(
-          (token2) => token2.loc.start.line === line && token2.loc.start.column === column - 1
-        );
-        let loc = {
-          line,
-          column: column - 1
-        };
-        token && (loc = // if cursor on `@` symbol than use next node
-        token.type === "@" ? sourceCode.getNodeByRangeIndex(token.range[1] + 1).loc : token.loc);
-        const didYouMeanContent = _optionalChain([error, 'access', _ => _.message, 'access', _2 => _2.match, 'call', _3 => _3(/Did you mean (?<content>.*)\?$/), 'optionalAccess', _4 => _4.groups, 'access', _5 => _5.content]), matches = didYouMeanContent ? [...didYouMeanContent.matchAll(/"(?<name>[^"]*)"/g)] : [];
-        context.report({
-          loc,
-          message: error.message,
-          suggest: hasDidYouMeanSuggestions ? matches.map((match) => {
-            const { name } = match.groups;
-            return {
-              desc: `Rename to \`${name}\``,
-              fix: (fixer) => fixer.replaceText(token, name)
-            };
-          }) : []
-        });
+  if (documentNode.definitions.length === 0) {
+    return;
+  }
+  try {
+    const validationErrors = schema ? _graphql.validate.call(void 0, schema, documentNode, [rule]) : _validatejs.validateSDL.call(void 0, documentNode, null, [rule]);
+    for (const error of validationErrors) {
+      const { line, column } = error.locations[0];
+      const sourceCode = context.getSourceCode();
+      const { tokens } = sourceCode.ast;
+      const token = tokens.find(
+        (token2) => token2.loc.start.line === line && token2.loc.start.column === column - 1
+      );
+      let loc = {
+        line,
+        column: column - 1
+      };
+      if (token) {
+        loc = // if cursor on `@` symbol than use next node
+        token.type === "@" ? sourceCode.getNodeByRangeIndex(token.range[1] + 1).loc : token.loc;
       }
-    } catch (error) {
+      const didYouMeanContent = _optionalChain([error, 'access', _ => _.message, 'access', _2 => _2.match, 'call', _3 => _3(/Did you mean (?<content>.*)\?$/), 'optionalAccess', _4 => _4.groups, 'access', _5 => _5.content]);
+      const matches = didYouMeanContent ? [...didYouMeanContent.matchAll(/"(?<name>[^"]*)"/g)] : [];
       context.report({
-        loc: _utilsjs.REPORT_ON_FIRST_CHARACTER,
-        message: error.message
+        loc,
+        message: error.message,
+        suggest: hasDidYouMeanSuggestions ? matches.map((match) => {
+          const { name } = match.groups;
+          return {
+            desc: `Rename to \`${name}\``,
+            fix: (fixer) => fixer.replaceText(token, name)
+          };
+        }) : []
       });
     }
+  } catch (error) {
+    context.report({
+      loc: _utilsjs.REPORT_ON_FIRST_CHARACTER,
+      message: error.message
+    });
+  }
 }
 const getFragmentDefsAndFragmentSpreads = (node) => {
-  const fragmentDefs = /* @__PURE__ */ new Set(), fragmentSpreads = /* @__PURE__ */ new Set();
-  return _graphql.visit.call(void 0, node, {
+  const fragmentDefs = /* @__PURE__ */ new Set();
+  const fragmentSpreads = /* @__PURE__ */ new Set();
+  const visitor = {
     FragmentDefinition(node2) {
       fragmentDefs.add(node2.name.value);
     },
     FragmentSpread(node2) {
       fragmentSpreads.add(node2.name.value);
     }
-  }), { fragmentDefs, fragmentSpreads };
-}, getMissingFragments = (node) => {
+  };
+  _graphql.visit.call(void 0, node, visitor);
+  return { fragmentDefs, fragmentSpreads };
+};
+const getMissingFragments = (node) => {
   const { fragmentDefs, fragmentSpreads } = getFragmentDefsAndFragmentSpreads(node);
   return [...fragmentSpreads].filter((name) => !fragmentDefs.has(name));
-}, handleMissingFragments = ({ ruleId, context, node }) => {
+};
+const handleMissingFragments = ({ ruleId, context, node }) => {
   const missingFragments = getMissingFragments(node);
   if (missingFragments.length > 0) {
-    const siblings = _utilsjs.requireGraphQLOperations.call(void 0, ruleId, context), fragmentsToAdd = [];
+    const siblings = _utilsjs.requireGraphQLOperations.call(void 0, ruleId, context);
+    const fragmentsToAdd = [];
     for (const fragmentName of missingFragments) {
       const [foundFragment] = siblings.getFragment(fragmentName).map((source) => source.document);
-      foundFragment && fragmentsToAdd.push(foundFragment);
+      if (foundFragment) {
+        fragmentsToAdd.push(foundFragment);
+      }
     }
-    if (fragmentsToAdd.length > 0)
+    if (fragmentsToAdd.length > 0) {
       return handleMissingFragments({
         ruleId,
         context,
@@ -112,44 +128,50 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
           definitions: [...node.definitions, ...fragmentsToAdd]
         }
       });
+    }
   }
   return node;
-}, validationToRule = ({
+};
+const validationToRule = ({
   ruleId,
   rule,
   getDocumentNode,
   schema = [],
   hasDidYouMeanSuggestions
-}, docs) => ({
-  [ruleId]: {
-    meta: {
-      docs: {
-        recommended: !0,
-        ...docs,
-        graphQLJSRuleName: rule.name,
-        url: `https://the-guild.dev/graphql/eslint/rules/${ruleId}`,
-        description: `${docs.description}
+}, docs) => {
+  return {
+    [ruleId]: {
+      meta: {
+        docs: {
+          recommended: true,
+          ...docs,
+          graphQLJSRuleName: rule.name,
+          url: `https://the-guild.dev/graphql/eslint/rules/${ruleId}`,
+          description: `${docs.description}
 > This rule is a wrapper around a \`graphql-js\` validation function.`
+        },
+        schema,
+        hasSuggestions: hasDidYouMeanSuggestions
       },
-      schema,
-      hasSuggestions: hasDidYouMeanSuggestions
-    },
-    create(context) {
-      return {
-        Document(node) {
-          const schema2 = docs.requiresSchema ? _utilsjs.requireGraphQLSchema.call(void 0, ruleId, context) : null, documentNode = getDocumentNode ? getDocumentNode({ ruleId, context, node: node.rawNode() }) : node.rawNode();
-          validateDocument({
-            context,
-            schema: schema2,
-            documentNode,
-            rule,
-            hasDidYouMeanSuggestions
-          });
-        }
-      };
+      create(context) {
+        return {
+          Document(node) {
+            const schema2 = docs.requiresSchema ? _utilsjs.requireGraphQLSchema.call(void 0, ruleId, context) : null;
+            const documentNode = getDocumentNode ? getDocumentNode({ ruleId, context, node: node.rawNode() }) : node.rawNode();
+            validateDocument({
+              context,
+              schema: schema2,
+              documentNode,
+              rule,
+              hasDidYouMeanSuggestions
+            });
+          }
+        };
+      }
     }
-  }
-}), GRAPHQL_JS_VALIDATIONS = exports.GRAPHQL_JS_VALIDATIONS = Object.assign(
+  };
+};
+const GRAPHQL_JS_VALIDATIONS = Object.assign(
   {},
   validationToRule(
     {
@@ -159,19 +181,19 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
     {
       ruleId: "fields-on-correct-type",
       rule: _indexjs.FieldsOnCorrectTypeRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: "Operations",
       description: "A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -182,19 +204,19 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
     {
       ruleId: "known-argument-names",
       rule: _indexjs.KnownArgumentNamesRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: ["Schema", "Operations"],
       description: "A GraphQL field is only valid if all supplied arguments are defined by that field.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -203,8 +225,9 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
       rule: _indexjs.KnownDirectivesRule,
       getDocumentNode({ context, node: documentNode }) {
         const { ignoreClientDirectives = [] } = context.options[0] || {};
-        if (ignoreClientDirectives.length === 0)
+        if (ignoreClientDirectives.length === 0) {
           return documentNode;
+        }
         const filterDirectives = (node) => ({
           ...node,
           directives: _optionalChain([node, 'access', _6 => _6.directives, 'optionalAccess', _7 => _7.filter, 'call', _8 => _8(
@@ -221,7 +244,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
         maxItems: 1,
         items: {
           type: "object",
-          additionalProperties: !1,
+          additionalProperties: false,
           required: ["ignoreClientDirectives"],
           properties: {
             ignoreClientDirectives: _utilsjs.ARRAY_DEFAULT_OPTIONS
@@ -232,7 +255,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: ["Schema", "Operations"],
       description: "A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.",
-      requiresSchema: !0,
+      requiresSchema: true,
       examples: [
         {
           title: "Valid",
@@ -260,8 +283,8 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.",
-      requiresSchema: !0,
-      requiresSiblings: !0,
+      requiresSchema: true,
+      requiresSiblings: true,
       examples: [
         {
           title: "Incorrect",
@@ -323,12 +346,12 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       ruleId: "known-type-names",
       rule: _indexjs.KnownTypeNamesRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: ["Schema", "Operations"],
       description: "A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -339,7 +362,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL document that contains an anonymous operation (the `query` short-hand) is only valid if it contains only that one operation definition.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -360,7 +383,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL fragment is only valid when it does not have cycles in fragments usage.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -372,8 +395,8 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.",
-      requiresSchema: !0,
-      requiresSiblings: !0
+      requiresSchema: true,
+      requiresSiblings: true
     }
   ),
   validationToRule(
@@ -381,25 +404,36 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
       ruleId: "no-unused-fragments",
       rule: _indexjs.NoUnusedFragmentsRule,
       getDocumentNode: ({ ruleId, context, node }) => {
-        const siblings = _utilsjs.requireGraphQLOperations.call(void 0, ruleId, context), FilePathToDocumentsMap = [
+        const siblings = _utilsjs.requireGraphQLOperations.call(void 0, ruleId, context);
+        const FilePathToDocumentsMap = [
           ...siblings.getOperations(),
           ...siblings.getFragments()
-        ].reduce((map, { filePath, document }) => (map[filePath] ??= [], map[filePath].push(document), map), /* @__PURE__ */ Object.create(null)), getParentNode = (currentFilePath, node2) => {
+        ].reduce((map, { filePath, document }) => {
+          map[filePath] ??= [];
+          map[filePath].push(document);
+          return map;
+        }, /* @__PURE__ */ Object.create(null));
+        const getParentNode = (currentFilePath, node2) => {
           const { fragmentDefs } = getFragmentDefsAndFragmentSpreads(node2);
-          if (fragmentDefs.size === 0)
+          if (fragmentDefs.size === 0) {
             return node2;
+          }
           delete FilePathToDocumentsMap[currentFilePath];
-          for (const [filePath, documents] of Object.entries(FilePathToDocumentsMap))
-            if (getMissingFragments({
+          for (const [filePath, documents] of Object.entries(FilePathToDocumentsMap)) {
+            const missingFragments = getMissingFragments({
               kind: _graphql.Kind.DOCUMENT,
               definitions: documents
-            }).some(
+            });
+            const isCurrentFileImportFragment = missingFragments.some(
               (fragment) => fragmentDefs.has(fragment)
-            ))
+            );
+            if (isCurrentFileImportFragment) {
               return getParentNode(filePath, {
                 kind: _graphql.Kind.DOCUMENT,
                 definitions: [...node2.definitions, ...documents]
               });
+            }
+          }
           return node2;
         };
         return getParentNode(context.filename, node);
@@ -408,8 +442,8 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.",
-      requiresSchema: !0,
-      requiresSiblings: !0
+      requiresSchema: true,
+      requiresSiblings: true
     }
   ),
   validationToRule(
@@ -421,8 +455,8 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.",
-      requiresSchema: !0,
-      requiresSiblings: !0
+      requiresSchema: true,
+      requiresSiblings: true
     }
   ),
   validationToRule(
@@ -433,7 +467,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -444,20 +478,20 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
     {
       ruleId: "possible-type-extension",
       rule: _indexjs.PossibleTypeExtensionsRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: "Schema",
       description: "A type extension is only valid if the type is defined and has the same kind.",
-      recommended: !0,
-      requiresSchema: !0
+      recommended: true,
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -468,19 +502,19 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: ["Schema", "Operations"],
       description: "A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
     {
       ruleId: "scalar-leafs",
       rule: _indexjs.ScalarLeafsRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: "Operations",
       description: "A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -491,7 +525,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL subscription is valid only if it contains a single root field.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -502,7 +536,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL field or directive is only valid if all supplied arguments are uniquely named.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -523,7 +557,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: ["Schema", "Operations"],
       description: "A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -574,19 +608,19 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL operation is only valid if all its variables are uniquely named.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
     {
       ruleId: "value-literals-of-correct-type",
       rule: _indexjs.ValuesOfCorrectTypeRule,
-      hasDidYouMeanSuggestions: !0
+      hasDidYouMeanSuggestions: true
     },
     {
       category: "Operations",
       description: "A GraphQL document is only valid if all value literals are of the type expected at their position.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -597,7 +631,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).",
-      requiresSchema: !0
+      requiresSchema: true
     }
   ),
   validationToRule(
@@ -608,7 +642,7 @@ const getFragmentDefsAndFragmentSpreads = (node) => {
     {
       category: "Operations",
       description: "Variables passed to field arguments conform to type.",
-      requiresSchema: !0
+      requiresSchema: true
     }
   )
 );

package/cjs/rules/index.d.cts

@@ -1,4 +1,3 @@
-import { RuleOptions } from './require-description/index.cjs';
 import { CaseStyle } from '../utils.cjs';
 import * as graphql from 'graphql';
 import { GraphQLESLintRule } from '../types.cjs';
@@ -64,9 +63,9 @@ declare const rules: {
             forbiddenPatterns?: {
                 [x: string]: unknown;
             }[] | undefined;
-            requiredPatterns?: {
+            requiredPattern?: {
                 [x: string]: unknown;
-            }[] | undefined;
+            } | undefined;
             forbiddenPrefixes?: string[] | undefined;
             forbiddenSuffixes?: string[] | undefined;
             requiredPrefixes?: string[] | undefined;
@@ -104,7 +103,22 @@ declare const rules: {
         argumentName?: string | undefined;
     }[]>;
     'require-deprecation-reason': GraphQLESLintRule;
-    'require-description': GraphQLESLintRule<RuleOptions>;
+    'require-description': GraphQLESLintRule<{
+        types?: true | undefined;
+        OperationDefinition?: boolean | undefined;
+        ScalarTypeDefinition?: boolean | undefined;
+        ObjectTypeDefinition?: boolean | undefined;
+        FieldDefinition?: boolean | undefined;
+        InputValueDefinition?: boolean | undefined;
+        InterfaceTypeDefinition?: boolean | undefined;
+        UnionTypeDefinition?: boolean | undefined;
+        EnumTypeDefinition?: boolean | undefined;
+        EnumValueDefinition?: boolean | undefined;
+        InputObjectTypeDefinition?: boolean | undefined;
+        DirectiveDefinition?: boolean | undefined;
+        rootField?: true | undefined;
+        ignoredSelectors?: string[] | undefined;
+    }[]>;
     'require-field-of-type-query-in-mutation-result': GraphQLESLintRule;
     'require-import-fragment': GraphQLESLintRule;
     'require-nullable-fields-with-oneof': GraphQLESLintRule;