@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230801163310-8bc4340

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

@@ -0,0 +1,70 @@
+import "../chunk-BMTV3EA2.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: true,
+      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) {
+        var _a;
+        const reasonArgument = (_a = node.arguments) == null ? void 0 : _a.find(
+          (arg) => arg.name.value === "reason"
+        );
+        const value = reasonArgument && String(valueFromNode(reasonArgument.value)).trim();
+        if (!value) {
+          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,23 @@
+import { Kind } from 'graphql';
+import { f as GraphQLESLintRule } from '../types-ace77d86.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql-config';
+import 'json-schema-to-ts';
+import '../estree-converter/types.mjs';
+
+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,186 @@
+import "../chunk-BMTV3EA2.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";
+const ALLOWED_KINDS = [
+  ...TYPES_KINDS,
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.FIELD_DEFINITION,
+  Kind.INPUT_VALUE_DEFINITION,
+  Kind.ENUM_VALUE_DEFINITION,
+  Kind.OPERATION_DEFINITION
+];
+const schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+      types: {
+        type: "boolean",
+        description: `Includes:
+${TYPES_KINDS.map((kind) => `- \`${kind}\``).join("\n")}`
+      },
+      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}).`;
+          if (kind === Kind.OPERATION_DEFINITION) {
+            description += '\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+          }
+          return [kind, { type: "boolean", description }];
+        })
+      )
+    }
+  }
+};
+const 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: true, FieldDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
+            type someTypeName {
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ types: true, FieldDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
+            """
+            Some type description
+            """
+            type someTypeName {
+              """
+              Name description
+              """
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ OperationDefinition: true }],
+          code: (
+            /* GraphQL */
+            `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ rootField: true }],
+          code: (
+            /* GraphQL */
+            `
+            type Mutation {
+              "Create a new user"
+              createUser: User
+            }
+
+            type User {
+              name: String
+            }
+          `
+          )
+        }
+      ],
+      configOptions: [
+        {
+          types: true,
+          [Kind.DIRECTIVE_DEFINITION]: true
+          // rootField: true TODO enable in graphql-eslint v4
+        }
+      ],
+      recommended: true
+    },
+    type: "suggestion",
+    messages: {
+      [RULE_ID]: "Description is required for {{ nodeName }}"
+    },
+    schema
+  },
+  create(context) {
+    const { types, rootField, ...restOptions } = context.options[0] || {};
+    const kinds = new Set(types ? TYPES_KINDS : []);
+    for (const [kind, isEnabled] of Object.entries(restOptions)) {
+      if (isEnabled) {
+        kinds.add(kind);
+      } else {
+        kinds.delete(kind);
+      }
+    }
+    if (rootField) {
+      const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+      const rootTypeNames = getRootTypeNames(schema2);
+      kinds.add(
+        `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/^(${[
+          ...rootTypeNames
+        ].join(",")})$/] > FieldDefinition`
+      );
+    }
+    const selector = [...kinds].join(",");
+    return {
+      [selector](node) {
+        var _a;
+        let description = "";
+        const isOperation = node.kind === Kind.OPERATION_DEFINITION;
+        if (isOperation) {
+          const rawNode = node.rawNode();
+          const { prev, line } = rawNode.loc.startToken;
+          if ((prev == null ? void 0 : prev.kind) === TokenKind.COMMENT) {
+            const value = prev.value.trim();
+            const linesBefore = line - prev.line;
+            if (!value.startsWith("eslint") && linesBefore === 1) {
+              description = value;
+            }
+          }
+        } else {
+          description = ((_a = node.description) == null ? void 0 : _a.value.trim()) || "";
+        }
+        if (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,12 @@
+import { f as GraphQLESLintRule } from '../types-ace77d86.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'graphql-config';
+import 'json-schema-to-ts';
+import '../estree-converter/types.mjs';
+
+declare const rule: GraphQLESLintRule;
+
+export { rule };

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

@@ -0,0 +1,79 @@
+import "../chunk-BMTV3EA2.js";
+import { isObjectType } from "graphql";
+import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "require-field-of-type-query-in-mutation-result";
+const rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Schema",
+      description: "Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.\n> Currently, no errors are reported for result type `union`, `interface` and `scalar`.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User { ... }
+
+            type Mutation {
+              createUser: User!
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User { ... }
+
+            type Query { ... }
+
+            type CreateUserPayload {
+              user: User!
+              query: Query!
+            }
+
+            type Mutation {
+              createUser: CreateUserPayload!
+            }
+          `
+          )
+        }
+      ]
+    },
+    schema: []
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const mutationType = schema.getMutationType();
+    const queryType = schema.getQueryType();
+    if (!mutationType || !queryType) {
+      return {};
+    }
+    const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}] > FieldDefinition > .gqlType Name`;
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        const graphQLType = schema.getType(typeName);
+        if (isObjectType(graphQLType)) {
+          const { fields } = graphQLType.astNode;
+          const hasQueryType = fields == null ? void 0 : fields.some((field) => getTypeName(field) === queryType.name);
+          if (!hasQueryType) {
+            context.report({
+              node,
+              message: `Mutation result type "${graphQLType.name}" must contain field of type "${queryType.name}"`
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/require-id-when-available.d.mts

@@ -0,0 +1,44 @@
+import { FromSchema } from 'json-schema-to-ts';
+import { f as GraphQLESLintRule } from '../types-ace77d86.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'graphql-config';
+import '../estree-converter/types.mjs';
+
+declare const schema: {
+    readonly definitions: {
+        readonly asString: {
+            readonly type: "string";
+        };
+        readonly asArray: {
+            readonly type: "array";
+            readonly uniqueItems: true;
+            readonly minItems: 1;
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly type: "array";
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly fieldName: {
+                readonly oneOf: readonly [{
+                    readonly $ref: "#/definitions/asString";
+                }, {
+                    readonly $ref: "#/definitions/asArray";
+                }];
+                readonly default: "id";
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions, true>;
+
+export { RuleOptions, rule };

package/esm/rules/require-id-when-available.js

@@ -0,0 +1,231 @@
+import "../chunk-BMTV3EA2.js";
+import { asArray } from "@graphql-tools/utils";
+import {
+  GraphQLInterfaceType,
+  GraphQLObjectType,
+  GraphQLUnionType,
+  Kind,
+  TypeInfo,
+  visit,
+  visitWithTypeInfo
+} from "graphql";
+import { getBaseType } from "../estree-converter/index.js";
+import {
+  ARRAY_DEFAULT_OPTIONS,
+  englishJoinWords,
+  requireGraphQLSchemaFromContext,
+  requireSiblingsOperations
+} from "../utils.js";
+const RULE_ID = "require-id-when-available";
+const DEFAULT_ID_FIELD_NAME = "id";
+const schema = {
+  definitions: {
+    asString: {
+      type: "string"
+    },
+    asArray: ARRAY_DEFAULT_OPTIONS
+  },
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+      fieldName: {
+        oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asArray" }],
+        default: DEFAULT_ID_FIELD_NAME
+      }
+    }
+  }
+};
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Operations",
+      description: "Enforce selecting specific fields when they are available on the GraphQL type.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      requiresSiblings: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            # In your schema
+            type User {
+              id: ID!
+              name: String!
+            }
+
+            # Query
+            query {
+              user {
+                name
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            # In your schema
+            type User {
+              id: ID!
+              name: String!
+            }
+
+            # Query
+            query {
+              user {
+                id
+                name
+              }
+            }
+
+            # Selecting \`id\` with an alias is also valid
+            query {
+              user {
+                id: name
+              }
+            }
+          `
+          )
+        }
+      ],
+      recommended: true
+    },
+    messages: {
+      [RULE_ID]: "Field{{ pluralSuffix }} {{ fieldName }} must be selected when it's available on a type.\nInclude it in your selection set{{ addition }}."
+    },
+    schema
+  },
+  create(context) {
+    const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const siblings = requireSiblingsOperations(RULE_ID, context);
+    const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
+    const idNames = asArray(fieldName);
+    const selector = "OperationDefinition SelectionSet[parent.kind!=/(^OperationDefinition|InlineFragment)$/]";
+    const typeInfo = new TypeInfo(schema2);
+    function checkFragments(node) {
+      for (const selection of node.selections) {
+        if (selection.kind !== Kind.FRAGMENT_SPREAD) {
+          continue;
+        }
+        const [foundSpread] = siblings.getFragment(selection.name.value);
+        if (!foundSpread) {
+          continue;
+        }
+        const checkedFragmentSpreads = /* @__PURE__ */ new Set();
+        const visitor = visitWithTypeInfo(typeInfo, {
+          SelectionSet(node2, key, _parent) {
+            const parent = _parent;
+            if (parent.kind === Kind.FRAGMENT_DEFINITION) {
+              checkedFragmentSpreads.add(parent.name.value);
+            } else if (parent.kind !== Kind.INLINE_FRAGMENT) {
+              checkSelections(
+                node2,
+                typeInfo.getType(),
+                selection.loc.start,
+                parent,
+                checkedFragmentSpreads
+              );
+            }
+          }
+        });
+        visit(foundSpread.document, visitor);
+      }
+    }
+    function checkSelections(node, type, loc, parent, checkedFragmentSpreads = /* @__PURE__ */ new Set()) {
+      const rawType = getBaseType(type);
+      if (rawType instanceof GraphQLObjectType || rawType instanceof GraphQLInterfaceType) {
+        checkFields(rawType);
+      } else if (rawType instanceof GraphQLUnionType) {
+        for (const selection of node.selections) {
+          if (selection.kind === Kind.INLINE_FRAGMENT) {
+            const types = rawType.getTypes();
+            const t = types.find((t2) => t2.name === selection.typeCondition.name.value);
+            if (t) {
+              checkFields(t);
+            }
+          }
+        }
+      }
+      function checkFields(rawType2) {
+        const fields = rawType2.getFields();
+        const hasIdFieldInType = idNames.some((name) => fields[name]);
+        if (!hasIdFieldInType) {
+          return;
+        }
+        function hasIdField({ selections }) {
+          return selections.some((selection) => {
+            if (selection.kind === Kind.FIELD) {
+              if (selection.alias && idNames.includes(selection.alias.value)) {
+                return true;
+              }
+              return idNames.includes(selection.name.value);
+            }
+            if (selection.kind === Kind.INLINE_FRAGMENT) {
+              return hasIdField(selection.selectionSet);
+            }
+            if (selection.kind === Kind.FRAGMENT_SPREAD) {
+              const [foundSpread] = siblings.getFragment(selection.name.value);
+              if (foundSpread) {
+                const fragmentSpread = foundSpread.document;
+                checkedFragmentSpreads.add(fragmentSpread.name.value);
+                return hasIdField(fragmentSpread.selectionSet);
+              }
+            }
+            return false;
+          });
+        }
+        const hasId = hasIdField(node);
+        checkFragments(node);
+        if (hasId) {
+          return;
+        }
+        const pluralSuffix = idNames.length > 1 ? "s" : "";
+        const fieldName2 = englishJoinWords(
+          idNames.map((name) => `\`${(parent.alias || parent.name).value}.${name}\``)
+        );
+        const addition = checkedFragmentSpreads.size === 0 ? "" : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? "s" : ""} ${englishJoinWords([...checkedFragmentSpreads].map((name) => `\`${name}\``))}`;
+        const problem = {
+          loc,
+          messageId: RULE_ID,
+          data: {
+            pluralSuffix,
+            fieldName: fieldName2,
+            addition
+          }
+        };
+        if ("type" in node) {
+          problem.suggest = idNames.map((idName) => ({
+            desc: `Add \`${idName}\` selection`,
+            fix: (fixer) => {
+              let insertNode = node.selections[0];
+              insertNode = insertNode.kind === Kind.INLINE_FRAGMENT ? insertNode.selectionSet.selections[0] : insertNode;
+              return fixer.insertTextBefore(insertNode, `${idName} `);
+            }
+          }));
+        }
+        context.report(problem);
+      }
+    }
+    return {
+      [selector](node) {
+        const typeInfo2 = node.typeInfo();
+        if (typeInfo2.gqlType) {
+          checkSelections(node, typeInfo2.gqlType, node.loc.start, node.parent);
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/require-import-fragment.d.mts

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