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

package/esm/rules/no-scalar-result-type-on-mutation.js

@@ -0,0 +1,77 @@
+import "../chunk-BMTV3EA2.js";
+import { isScalarType, Kind } from "graphql";
+import { getNodeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "no-scalar-result-type-on-mutation";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Avoid scalar result type on mutation type to make sure to return a valid state.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type Mutation {
+              createUser: Boolean
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type Mutation {
+              createUser: User!
+            }
+          `
+          )
+        }
+      ]
+    },
+    schema: []
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const mutationType = schema.getMutationType();
+    if (!mutationType) {
+      return {};
+    }
+    const selector = [
+      `:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=${mutationType.name}]`,
+      "> FieldDefinition > .gqlType Name"
+    ].join(" ");
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        const graphQLType = schema.getType(typeName);
+        if (isScalarType(graphQLType)) {
+          let fieldDef = node.parent;
+          while (fieldDef.kind !== Kind.FIELD_DEFINITION) {
+            fieldDef = fieldDef.parent;
+          }
+          context.report({
+            node,
+            message: `Unexpected scalar result type \`${typeName}\` for ${getNodeName(fieldDef)}`,
+            suggest: [
+              {
+                desc: `Remove \`${typeName}\``,
+                fix: (fixer) => fixer.remove(node)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-typename-prefix.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/no-typename-prefix.js

@@ -0,0 +1,75 @@
+import "../chunk-BMTV3EA2.js";
+const NO_TYPENAME_PREFIX = "NO_TYPENAME_PREFIX";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Enforces users to avoid using the type name in a field name while defining your schema.",
+      recommended: true,
+      url: "https://the-guild.dev/graphql/eslint/rules/no-typename-prefix",
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              userId: ID!
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [NO_TYPENAME_PREFIX]: 'Field "{{ fieldName }}" starts with the name of the parent type "{{ typeName }}"'
+    },
+    schema: []
+  },
+  create(context) {
+    return {
+      "ObjectTypeDefinition, ObjectTypeExtension, InterfaceTypeDefinition, InterfaceTypeExtension"(node) {
+        const typeName = node.name.value;
+        const lowerTypeName = typeName.toLowerCase();
+        for (const field of node.fields || []) {
+          const fieldName = field.name.value;
+          if (fieldName.toLowerCase().startsWith(lowerTypeName)) {
+            context.report({
+              data: {
+                fieldName,
+                typeName
+              },
+              messageId: NO_TYPENAME_PREFIX,
+              node: field.name,
+              suggest: [
+                {
+                  desc: `Remove \`${fieldName.slice(0, typeName.length)}\` prefix`,
+                  fix: (fixer) => fixer.replaceText(
+                    field.name,
+                    fieldName.replace(new RegExp(`^${typeName}`, "i"), "")
+                  )
+                }
+              ]
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-unreachable-types.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/no-unreachable-types.js

@@ -0,0 +1,171 @@
+import "../chunk-BMTV3EA2.js";
+import {
+  DirectiveLocation,
+  isInterfaceType,
+  Kind,
+  visit
+} from "graphql";
+import lowerCase from "lodash.lowercase";
+import { getTypeName, requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "no-unreachable-types";
+const KINDS = [
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.OBJECT_TYPE_DEFINITION,
+  Kind.OBJECT_TYPE_EXTENSION,
+  Kind.INTERFACE_TYPE_DEFINITION,
+  Kind.INTERFACE_TYPE_EXTENSION,
+  Kind.SCALAR_TYPE_DEFINITION,
+  Kind.SCALAR_TYPE_EXTENSION,
+  Kind.INPUT_OBJECT_TYPE_DEFINITION,
+  Kind.INPUT_OBJECT_TYPE_EXTENSION,
+  Kind.UNION_TYPE_DEFINITION,
+  Kind.UNION_TYPE_EXTENSION,
+  Kind.ENUM_TYPE_DEFINITION,
+  Kind.ENUM_TYPE_EXTENSION
+];
+let reachableTypesCache;
+const RequestDirectiveLocations = /* @__PURE__ */ new Set([
+  DirectiveLocation.QUERY,
+  DirectiveLocation.MUTATION,
+  DirectiveLocation.SUBSCRIPTION,
+  DirectiveLocation.FIELD,
+  DirectiveLocation.FRAGMENT_DEFINITION,
+  DirectiveLocation.FRAGMENT_SPREAD,
+  DirectiveLocation.INLINE_FRAGMENT,
+  DirectiveLocation.VARIABLE_DEFINITION
+]);
+function getReachableTypes(schema) {
+  if (reachableTypesCache) {
+    return reachableTypesCache;
+  }
+  const reachableTypes = /* @__PURE__ */ new Set();
+  const collect = (node) => {
+    const typeName = getTypeName(node);
+    if (reachableTypes.has(typeName)) {
+      return;
+    }
+    reachableTypes.add(typeName);
+    const type = schema.getType(typeName) || schema.getDirective(typeName);
+    if (isInterfaceType(type)) {
+      const { objects, interfaces } = schema.getImplementations(type);
+      for (const { astNode } of [...objects, ...interfaces]) {
+        visit(astNode, visitor);
+      }
+    } else if (type == null ? void 0 : type.astNode) {
+      visit(type.astNode, visitor);
+    }
+  };
+  const visitor = {
+    InterfaceTypeDefinition: collect,
+    ObjectTypeDefinition: collect,
+    InputValueDefinition: collect,
+    UnionTypeDefinition: collect,
+    FieldDefinition: collect,
+    Directive: collect,
+    NamedType: collect
+  };
+  for (const type of [
+    schema,
+    // visiting SchemaDefinition node
+    schema.getQueryType(),
+    schema.getMutationType(),
+    schema.getSubscriptionType()
+  ]) {
+    if (type == null ? void 0 : type.astNode) {
+      visit(type.astNode, visitor);
+    }
+  }
+  for (const node of schema.getDirectives()) {
+    if (node.locations.some((location) => RequestDirectiveLocations.has(location))) {
+      reachableTypes.add(node.name);
+      for (const arg of node.args) {
+        const argTypeName = "name" in arg.type && arg.type.name;
+        if (argTypeName) {
+          reachableTypes.add(argTypeName);
+        }
+      }
+    }
+  }
+  reachableTypesCache = reachableTypes;
+  return reachableTypesCache;
+}
+const rule = {
+  meta: {
+    messages: {
+      [RULE_ID]: "{{ type }} `{{ typeName }}` is unreachable."
+    },
+    docs: {
+      description: "Requires all types to be reachable at some level by root level fields.",
+      category: "Schema",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+              name: String
+            }
+
+            type Query {
+              me: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+              name: String
+            }
+
+            type Query {
+              me: User
+            }
+          `
+          )
+        }
+      ],
+      recommended: true
+    },
+    type: "suggestion",
+    schema: [],
+    hasSuggestions: true
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const reachableTypes = getReachableTypes(schema);
+    return {
+      [`:matches(${KINDS}) > .name`](node) {
+        const typeName = node.value;
+        if (!reachableTypes.has(typeName)) {
+          const type = lowerCase(node.parent.kind.replace(/(Extension|Definition)$/, ""));
+          context.report({
+            node,
+            messageId: RULE_ID,
+            data: {
+              type: type[0].toUpperCase() + type.slice(1),
+              typeName
+            },
+            suggest: [
+              {
+                desc: `Remove \`${typeName}\``,
+                fix: (fixer) => fixer.remove(node.parent)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-unused-fields.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/no-unused-fields.js

@@ -0,0 +1,134 @@
+import "../chunk-BMTV3EA2.js";
+import { TypeInfo, visit, visitWithTypeInfo } from "graphql";
+import { requireGraphQLSchemaFromContext, requireSiblingsOperations } from "../utils.js";
+const RULE_ID = "no-unused-fields";
+let usedFieldsCache;
+function getUsedFields(schema, operations) {
+  if (usedFieldsCache) {
+    return usedFieldsCache;
+  }
+  const usedFields = /* @__PURE__ */ Object.create(null);
+  const typeInfo = new TypeInfo(schema);
+  const visitor = visitWithTypeInfo(typeInfo, {
+    Field(node) {
+      var _a;
+      const fieldDef = typeInfo.getFieldDef();
+      if (!fieldDef) {
+        return false;
+      }
+      const parentTypeName = typeInfo.getParentType().name;
+      const fieldName = node.name.value;
+      (_a = usedFields[parentTypeName]) != null ? _a : usedFields[parentTypeName] = /* @__PURE__ */ new Set();
+      usedFields[parentTypeName].add(fieldName);
+    }
+  });
+  const allDocuments = [...operations.getOperations(), ...operations.getFragments()];
+  for (const { document } of allDocuments) {
+    visit(document, visitor);
+  }
+  usedFieldsCache = usedFields;
+  return usedFieldsCache;
+}
+const rule = {
+  meta: {
+    messages: {
+      [RULE_ID]: 'Field "{{fieldName}}" is unused'
+    },
+    docs: {
+      description: "Requires all fields to be used at some level by siblings operations.",
+      category: "Schema",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSiblings: true,
+      requiresSchema: true,
+      isDisabledForAllConfig: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+              name: String
+              someUnusedField: String
+            }
+
+            type Query {
+              me: User
+            }
+
+            query {
+              me {
+                id
+                name
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+              name: String
+            }
+
+            type Query {
+              me: User
+            }
+
+            query {
+              me {
+                id
+                name
+              }
+            }
+          `
+          )
+        }
+      ]
+    },
+    type: "suggestion",
+    schema: [],
+    hasSuggestions: true
+  },
+  create(context) {
+    const schema = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const siblingsOperations = requireSiblingsOperations(RULE_ID, context);
+    const usedFields = getUsedFields(schema, siblingsOperations);
+    return {
+      FieldDefinition(node) {
+        var _a;
+        const fieldName = node.name.value;
+        const parentTypeName = node.parent.name.value;
+        const isUsed = (_a = usedFields[parentTypeName]) == null ? void 0 : _a.has(fieldName);
+        if (isUsed) {
+          return;
+        }
+        context.report({
+          node: node.name,
+          messageId: RULE_ID,
+          data: { fieldName },
+          suggest: [
+            {
+              desc: `Remove \`${fieldName}\` field`,
+              fix(fixer) {
+                const sourceCode = context.getSourceCode();
+                const tokenBefore = sourceCode.getTokenBefore(node);
+                const tokenAfter = sourceCode.getTokenAfter(node);
+                const isEmptyType = tokenBefore.type === "{" && tokenAfter.type === "}";
+                return fixer.remove(isEmptyType ? node.parent : node);
+              }
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/relay-arguments.d.mts

@@ -0,0 +1,29 @@
+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 type: "array";
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly includeBoth: {
+                readonly type: "boolean";
+                readonly default: true;
+                readonly description: "Enforce including both forward and backward pagination arguments";
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions, true>;
+
+export { RuleOptions, rule };

package/esm/rules/relay-arguments.js

@@ -0,0 +1,126 @@
+import "../chunk-BMTV3EA2.js";
+import { isScalarType, Kind } from "graphql";
+import { requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "relay-arguments";
+const MISSING_ARGUMENTS = "MISSING_ARGUMENTS";
+const schema = {
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+      includeBoth: {
+        type: "boolean",
+        default: true,
+        description: "Enforce including both forward and backward pagination arguments"
+      }
+    }
+  }
+};
+const rule = {
+  meta: {
+    type: "problem",
+    docs: {
+      category: "Schema",
+      description: [
+        "Set of rules to follow Relay specification for Arguments.",
+        "",
+        "- A field that returns a Connection type must include forward pagination arguments (`first` and `after`), backward pagination arguments (`last` and `before`), or both",
+        "",
+        "Forward pagination arguments",
+        "",
+        "- `first` takes a non-negative integer",
+        "- `after` takes the Cursor type",
+        "",
+        "Backward pagination arguments",
+        "",
+        "- `last` takes a non-negative integer",
+        "- `before` takes the Cursor type"
+      ].join("\n"),
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              posts: PostConnection
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              posts(after: String, first: Int, before: String, last: Int): PostConnection
+            }
+          `
+          )
+        }
+      ],
+      isDisabledForAllConfig: true
+    },
+    messages: {
+      [MISSING_ARGUMENTS]: "A field that returns a Connection type must include forward pagination arguments (`first` and `after`), backward pagination arguments (`last` and `before`), or both."
+    },
+    schema
+  },
+  create(context) {
+    const schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+    const { includeBoth = true } = context.options[0] || {};
+    return {
+      "FieldDefinition > .gqlType Name[value=/Connection$/]"(node) {
+        var _a;
+        let fieldNode = node.parent;
+        while (fieldNode.kind !== Kind.FIELD_DEFINITION) {
+          fieldNode = fieldNode.parent;
+        }
+        const args = Object.fromEntries(
+          ((_a = fieldNode.arguments) == null ? void 0 : _a.map((argument) => [argument.name.value, argument])) || []
+        );
+        const hasForwardPagination = !!(args.first && args.after);
+        const hasBackwardPagination = !!(args.last && args.before);
+        if (!hasForwardPagination && !hasBackwardPagination) {
+          context.report({
+            node: fieldNode.name,
+            messageId: MISSING_ARGUMENTS
+          });
+          return;
+        }
+        function checkField(typeName, argumentName) {
+          const argument = args[argumentName];
+          const hasArgument = !!argument;
+          let type = argument;
+          if (hasArgument && type.gqlType.kind === Kind.NON_NULL_TYPE) {
+            type = type.gqlType;
+          }
+          const isAllowedNonNullType = hasArgument && type.gqlType.kind === Kind.NAMED_TYPE && (type.gqlType.name.value === typeName || typeName === "String" && isScalarType(schema2.getType(type.gqlType.name.value)));
+          if (!isAllowedNonNullType) {
+            const returnType = typeName === "String" ? "String or Scalar" : typeName;
+            context.report({
+              node: (argument || fieldNode).name,
+              message: hasArgument ? `Argument \`${argumentName}\` must return ${returnType}.` : `Field \`${fieldNode.name.value}\` must contain an argument \`${argumentName}\`, that return ${returnType}.`
+            });
+          }
+        }
+        if (includeBoth || args.first || args.after) {
+          checkField("Int", "first");
+          checkField("String", "after");
+        }
+        if (includeBoth || args.last || args.before) {
+          checkField("Int", "last");
+          checkField("String", "before");
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/relay-connection-types.d.mts

@@ -0,0 +1,13 @@
+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 NON_OBJECT_TYPES: Kind[];
+declare const rule: GraphQLESLintRule;
+
+export { NON_OBJECT_TYPES, rule };