@graphql-eslint/eslint-plugin 4.0.0-alpha.9 → 4.0.1-alpha-20241127205058-a4fec1a6cf7006ea913f13e6afbf7ed2d82503c3

package/esm/rules/require-selections/index.js

@@ -1,4 +1,3 @@
-import "../../chunk-UIAXBAMD.js";
 import {
   GraphQLInterfaceType,
   GraphQLObjectType,
@@ -13,8 +12,8 @@ import { getBaseType } from "../../estree-converter/index.js";
 import {
   ARRAY_DEFAULT_OPTIONS,
   englishJoinWords,
-  requireGraphQLSchemaFromContext,
-  requireSiblingsOperations
+  requireGraphQLOperations,
+  requireGraphQLSchema
 } from "../../utils.js";
 const RULE_ID = "require-selections", DEFAULT_ID_FIELD_NAME = "id", schema = {
   definitions: {
@@ -95,7 +94,8 @@ const RULE_ID = "require-selections", DEFAULT_ID_FIELD_NAME = "id", schema = {
           )
         }
       ],
-      recommended: !0
+      recommended: !0,
+      whenNotToUseIt: "Relay Compiler automatically adds an `id` field to any type that has an `id` field, even if it hasn't been explicitly requested. Requesting a field that is not used directly in the code can conflict with another Relay rule: `relay/unused-fields`."
     },
     messages: {
       [RULE_ID]: `Field{{ pluralSuffix }} {{ fieldName }} must be selected when it's available on a type.
@@ -104,7 +104,7 @@ Include it in your selection set{{ addition }}.`
     schema
   },
   create(context) {
-    const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context), siblings = requireSiblingsOperations(RULE_ID, context), { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {}, idNames = asArray(fieldName), selector = "OperationDefinition SelectionSet[parent.kind!=/(^OperationDefinition|InlineFragment)$/]", typeInfo = new TypeInfo(schema2);
+    const schema2 = requireGraphQLSchema(RULE_ID, context), siblings = requireGraphQLOperations(RULE_ID, context), { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {}, idNames = asArray(fieldName), selector = "SelectionSet[parent.kind!=/(^OperationDefinition|InlineFragment)$/]", typeInfo = new TypeInfo(schema2);
     function checkFragments(node) {
       for (const selection of node.selections) {
         if (selection.kind !== Kind.FRAGMENT_SPREAD)
@@ -131,13 +131,19 @@ Include it in your selection set{{ addition }}.`
       const rawType = getBaseType(type);
       if (rawType instanceof GraphQLObjectType || rawType instanceof GraphQLInterfaceType)
         checkFields(rawType);
-      else if (rawType instanceof GraphQLUnionType) {
-        for (const selection of node.selections)
+      else if (rawType instanceof GraphQLUnionType)
+        for (const selection of node.selections) {
+          const types = rawType.getTypes();
           if (selection.kind === Kind.INLINE_FRAGMENT) {
-            const t = rawType.getTypes().find((t2) => t2.name === selection.typeCondition.name.value);
+            const t = types.find((t2) => t2.name === selection.typeCondition.name.value);
             t && checkFields(t);
+          } else if (selection.kind === Kind.FRAGMENT_SPREAD) {
+            const [foundSpread] = siblings.getFragment(selection.name.value);
+            if (!foundSpread) return;
+            const fragmentSpread = foundSpread.document, t = fragmentSpread.typeCondition.name.value === rawType.name ? rawType : types.find((t2) => t2.name === fragmentSpread.typeCondition.name.value);
+            checkedFragmentSpreads.add(fragmentSpread.name.value), checkSelections(fragmentSpread.selectionSet, t, loc, parent, checkedFragmentSpreads);
           }
-      }
+        }
       function checkFields(rawType2) {
         const fields = rawType2.getFields();
         if (!idNames.some((name) => fields[name]))

package/esm/rules/require-type-pattern-with-oneof/index.js

@@ -1,4 +1,3 @@
-import "../../chunk-UIAXBAMD.js";
 import { displayNodeName } from "../../utils.js";
 const RULE_ID = "require-type-pattern-with-oneof", rule = {
   meta: {

package/esm/rules/selection-set-depth/index.js

@@ -1,7 +1,6 @@
-import "../../chunk-UIAXBAMD.js";
 import { Kind } from "graphql";
 import depthLimit from "graphql-depth-limit";
-import { ARRAY_DEFAULT_OPTIONS, logger, requireSiblingsOperations } from "../../utils.js";
+import { ARRAY_DEFAULT_OPTIONS, logger, requireGraphQLOperations } from "../../utils.js";
 const RULE_ID = "selection-set-depth", schema = {
   type: "array",
   minItems: 1,
@@ -75,10 +74,10 @@ const RULE_ID = "selection-set-depth", schema = {
   create(context) {
     let siblings = null;
     try {
-      siblings = requireSiblingsOperations(RULE_ID, context);
+      siblings = requireGraphQLOperations(RULE_ID, context);
     } catch {
       logger.warn(
-        `Rule "${RULE_ID}" works best with siblings operations loaded. For more info: https://bit.ly/graphql-eslint-operations`
+        `Rule "${RULE_ID}" works best with siblings operations loaded. See https://the-guild.dev/graphql/eslint/docs/usage#providing-operations for more info`
       );
     }
     const { maxDepth, ignore = [] } = context.options[0], checkFn = depthLimit(maxDepth, { ignore });
@@ -120,7 +119,7 @@ const RULE_ID = "selection-set-depth", schema = {
           });
         } catch (e) {
           logger.warn(
-            `Rule "${RULE_ID}" check failed due to a missing siblings operations. For more info: https://bit.ly/graphql-eslint-operations`,
+            `Rule "${RULE_ID}" check failed due to a missing siblings operations. See https://the-guild.dev/graphql/eslint/docs/usage#providing-operations for more info`,
             e
           );
         }

package/esm/rules/strict-id-in-types/index.js

@@ -1,10 +1,9 @@
-import "../../chunk-UIAXBAMD.js";
 import { Kind } from "graphql";
 import {
   ARRAY_DEFAULT_OPTIONS,
   displayNodeName,
   englishJoinWords,
-  requireGraphQLSchemaFromContext,
+  requireGraphQLSchema,
   truthy
 } from "../../utils.js";
 const RULE_ID = "strict-id-in-types", schema = {
@@ -123,7 +122,7 @@ const RULE_ID = "strict-id-in-types", schema = {
       acceptedIdTypes: ["ID"],
       exceptions: {},
       ...context.options[0]
-    }, schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+    }, schema2 = requireGraphQLSchema(RULE_ID, context);
     return {
       [`ObjectTypeDefinition[name.value!=/^(${[
         schema2.getQueryType(),

package/esm/rules/unique-enum-value-names/index.js

@@ -1,4 +1,3 @@
-import "../../chunk-UIAXBAMD.js";
 import { Kind } from "graphql";
 import { getNodeName } from "../../utils.js";
 const rule = {

package/esm/rules/unique-fragment-name/index.js

@@ -1,9 +1,8 @@
-import "../../chunk-UIAXBAMD.js";
 import { relative } from "node:path";
 import { Kind } from "graphql";
-import { CWD, requireSiblingsOperations, slash, VIRTUAL_DOCUMENT_REGEX } from "../../utils.js";
+import { CWD, requireGraphQLOperations, slash, VIRTUAL_DOCUMENT_REGEX } from "../../utils.js";
 const RULE_ID = "unique-fragment-name", checkNode = (context, node, ruleId) => {
-  const documentName = node.name.value, siblings = requireSiblingsOperations(ruleId, context), siblingDocuments = node.kind === Kind.FRAGMENT_DEFINITION ? siblings.getFragment(documentName) : siblings.getOperation(documentName), filepath = context.filename, conflictingDocuments = siblingDocuments.filter((f) => {
+  const documentName = node.name.value, siblings = requireGraphQLOperations(ruleId, context), siblingDocuments = node.kind === Kind.FRAGMENT_DEFINITION ? siblings.getFragment(documentName) : siblings.getOperation(documentName), filepath = context.filename, conflictingDocuments = siblingDocuments.filter((f) => {
     const isSameName = f.document.name?.value === documentName, isSamePath = slash(f.filePath) === slash(filepath);
     return isSameName && !isSamePath;
   });

package/esm/rules/unique-operation-name/index.js

@@ -1,4 +1,3 @@
-import "../../chunk-UIAXBAMD.js";
 import { checkNode } from "../unique-fragment-name/index.js";
 const RULE_ID = "unique-operation-name", rule = {
   meta: {

package/esm/schema.js

@@ -1,4 +1,3 @@
-import "./chunk-UIAXBAMD.js";
 import debugFactory from "debug";
 import fg from "fast-glob";
 import { GraphQLSchema } from "graphql";

package/esm/siblings.js

@@ -1,4 +1,3 @@
-import "./chunk-UIAXBAMD.js";
 import {
   Kind,
   visit

package/esm/types.d.ts

@@ -52,6 +52,7 @@ type RuleDocsInfo<T> = Omit<RuleMetaDataDocs, 'category' | 'suggestion'> & {
     };
     graphQLJSRuleName?: string;
     isDisabledForAllConfig?: true;
+    whenNotToUseIt?: string;
 };
 type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;

package/esm/utils.d.ts

@@ -8,8 +8,8 @@ import '@graphql-tools/utils';
 import 'graphql-config';
 import 'json-schema-to-ts';
 
-declare function requireSiblingsOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
-declare function requireGraphQLSchemaFromContext(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
+declare function requireGraphQLOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
+declare function requireGraphQLSchema(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
 declare const logger: {
     error: (...args: unknown[]) => void;
     warn: (...args: unknown[]) => void;
@@ -39,7 +39,7 @@ declare const ARRAY_DEFAULT_OPTIONS: {
 declare const englishJoinWords: (words: string[]) => string;
 type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T;
 declare function truthy<T>(value: T): value is Truthy<T>;
-declare function displayNodeName(node: GraphQLESTreeNode<ASTNode>): string;
+declare function displayNodeName(node: GraphQLESTreeNode<ASTNode, boolean>): string;
 declare function getNodeName(node: GraphQLESTreeNode<ASTNode>): string;
 
-export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLSchemaFromContext, requireSiblingsOperations, slash, truthy };
+export { ARRAY_DEFAULT_OPTIONS, CWD, type CaseStyle, REPORT_ON_FIRST_CHARACTER, TYPES_KINDS, VIRTUAL_DOCUMENT_REGEX, camelCase, convertCase, displayNodeName, englishJoinWords, getLocation, getNodeName, getTypeName, logger, pascalCase, requireGraphQLOperations, requireGraphQLSchema, slash, truthy };

package/esm/utils.js

@@ -1,19 +1,18 @@
-import "./chunk-UIAXBAMD.js";
 import { Kind } from "graphql";
 import lowerCase from "lodash.lowercase";
-function requireSiblingsOperations(ruleId, context) {
+function requireGraphQLOperations(ruleId, context) {
   const { siblingOperations } = context.sourceCode.parserServices;
   if (!siblingOperations.available)
     throw new Error(
-      `Rule \`${ruleId}\` requires graphql-config \`documents\` field to be set and loaded. See https://the-guild.dev/graphql/config/docs/user/documents for more info`
+      `Rule \`${ruleId}\` requires graphql-config \`documents\` field to be set and loaded. See https://the-guild.dev/graphql/eslint/docs/usage#providing-operations for more info`
     );
   return siblingOperations;
 }
-function requireGraphQLSchemaFromContext(ruleId, context) {
+function requireGraphQLSchema(ruleId, context) {
   const { schema } = context.sourceCode.parserServices;
   if (!schema)
     throw new Error(
-      `Rule \`${ruleId}\` requires graphql-config \`schema\` field to be set and loaded. See https://the-guild.dev/graphql/config/docs/user/schema for more info`
+      `Rule \`${ruleId}\` requires graphql-config \`schema\` field to be set and loaded. See https://the-guild.dev/graphql/eslint/docs/usage#providing-schema for more info`
     );
   return schema;
 }
@@ -123,7 +122,7 @@ const DisplayNodeNameMap = {
   [Kind.VARIABLE]: "variable"
 };
 function displayNodeName(node) {
-  return `${node.kind === Kind.OPERATION_DEFINITION ? node.operation : DisplayNodeNameMap[node.kind]} "${"alias" in node && node.alias?.value || "name" in node && node.name?.value}"`;
+  return `${node.kind === Kind.OPERATION_DEFINITION ? node.operation : DisplayNodeNameMap[node.kind]} "${"alias" in node && node.alias?.value || "name" in node && node.name?.value || node.value}"`;
 }
 function getNodeName(node) {
   switch (node.kind) {
@@ -160,8 +159,8 @@ export {
   getTypeName,
   logger,
   pascalCase,
-  requireGraphQLSchemaFromContext,
-  requireSiblingsOperations,
+  requireGraphQLOperations,
+  requireGraphQLSchema,
   slash,
   truthy
 };