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

package/cjs/rules/no-root-type.js

@@ -0,0 +1,113 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var no_root_type_exports = {};
+__export(no_root_type_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(no_root_type_exports);
+var import_utils = require("../utils.js");
+const schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    required: ["disallow"],
+    properties: {
+      disallow: {
+        ...import_utils.ARRAY_DEFAULT_OPTIONS,
+        items: {
+          enum: ["mutation", "subscription"]
+        }
+      }
+    }
+  }
+};
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Schema",
+      description: "Disallow using root types `mutation` and/or `subscription`.",
+      url: "https://the-guild.dev/graphql/eslint/rules/no-root-type",
+      requiresSchema: true,
+      isDisabledForAllConfig: true,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ disallow: ["mutation", "subscription"] }],
+          code: (
+            /* GraphQL */
+            `
+            type Mutation {
+              createUser(input: CreateUserInput!): User!
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ disallow: ["mutation", "subscription"] }],
+          code: (
+            /* GraphQL */
+            `
+            type Query {
+              users: [User!]!
+            }
+          `
+          )
+        }
+      ]
+    },
+    schema
+  },
+  create(context) {
+    const schema2 = (0, import_utils.requireGraphQLSchemaFromContext)("no-root-type", context);
+    const disallow = new Set(context.options[0].disallow);
+    const rootTypeNames = [
+      disallow.has("mutation") && schema2.getMutationType(),
+      disallow.has("subscription") && schema2.getSubscriptionType()
+    ].filter(import_utils.truthy).map((type) => type.name).join("|");
+    if (!rootTypeNames) {
+      return {};
+    }
+    const selector = `:matches(ObjectTypeDefinition, ObjectTypeExtension) > .name[value=/^(${rootTypeNames})$/]`;
+    return {
+      [selector](node) {
+        const typeName = node.value;
+        context.report({
+          node,
+          message: `Root type \`${typeName}\` is forbidden.`,
+          suggest: [
+            {
+              desc: `Remove \`${typeName}\` type`,
+              fix: (fixer) => fixer.remove(node.parent)
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});

package/cjs/rules/no-scalar-result-type-on-mutation.d.ts

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

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

@@ -0,0 +1,100 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var no_scalar_result_type_on_mutation_exports = {};
+__export(no_scalar_result_type_on_mutation_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(no_scalar_result_type_on_mutation_exports);
+var import_graphql = require("graphql");
+var import_utils = require("../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 = (0, import_utils.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 ((0, import_graphql.isScalarType)(graphQLType)) {
+          let fieldDef = node.parent;
+          while (fieldDef.kind !== import_graphql.Kind.FIELD_DEFINITION) {
+            fieldDef = fieldDef.parent;
+          }
+          context.report({
+            node,
+            message: `Unexpected scalar result type \`${typeName}\` for ${(0, import_utils.getNodeName)(fieldDef)}`,
+            suggest: [
+              {
+                desc: `Remove \`${typeName}\``,
+                fix: (fixer) => fixer.remove(node)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});

package/cjs/rules/no-typename-prefix.d.ts

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

package/cjs/rules/no-typename-prefix.js

@@ -0,0 +1,98 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var no_typename_prefix_exports = {};
+__export(no_typename_prefix_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(no_typename_prefix_exports);
+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"), "")
+                  )
+                }
+              ]
+            });
+          }
+        }
+      }
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});

package/cjs/rules/no-unreachable-types.d.ts

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

package/cjs/rules/no-unreachable-types.js

@@ -0,0 +1,199 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var no_unreachable_types_exports = {};
+__export(no_unreachable_types_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(no_unreachable_types_exports);
+var import_graphql = require("graphql");
+var import_lodash = __toESM(require("lodash.lowercase"));
+var import_utils = require("../utils.js");
+const RULE_ID = "no-unreachable-types";
+const KINDS = [
+  import_graphql.Kind.DIRECTIVE_DEFINITION,
+  import_graphql.Kind.OBJECT_TYPE_DEFINITION,
+  import_graphql.Kind.OBJECT_TYPE_EXTENSION,
+  import_graphql.Kind.INTERFACE_TYPE_DEFINITION,
+  import_graphql.Kind.INTERFACE_TYPE_EXTENSION,
+  import_graphql.Kind.SCALAR_TYPE_DEFINITION,
+  import_graphql.Kind.SCALAR_TYPE_EXTENSION,
+  import_graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION,
+  import_graphql.Kind.INPUT_OBJECT_TYPE_EXTENSION,
+  import_graphql.Kind.UNION_TYPE_DEFINITION,
+  import_graphql.Kind.UNION_TYPE_EXTENSION,
+  import_graphql.Kind.ENUM_TYPE_DEFINITION,
+  import_graphql.Kind.ENUM_TYPE_EXTENSION
+];
+let reachableTypesCache;
+const RequestDirectiveLocations = /* @__PURE__ */ new Set([
+  import_graphql.DirectiveLocation.QUERY,
+  import_graphql.DirectiveLocation.MUTATION,
+  import_graphql.DirectiveLocation.SUBSCRIPTION,
+  import_graphql.DirectiveLocation.FIELD,
+  import_graphql.DirectiveLocation.FRAGMENT_DEFINITION,
+  import_graphql.DirectiveLocation.FRAGMENT_SPREAD,
+  import_graphql.DirectiveLocation.INLINE_FRAGMENT,
+  import_graphql.DirectiveLocation.VARIABLE_DEFINITION
+]);
+function getReachableTypes(schema) {
+  if (reachableTypesCache) {
+    return reachableTypesCache;
+  }
+  const reachableTypes = /* @__PURE__ */ new Set();
+  const collect = (node) => {
+    const typeName = (0, import_utils.getTypeName)(node);
+    if (reachableTypes.has(typeName)) {
+      return;
+    }
+    reachableTypes.add(typeName);
+    const type = schema.getType(typeName) || schema.getDirective(typeName);
+    if ((0, import_graphql.isInterfaceType)(type)) {
+      const { objects, interfaces } = schema.getImplementations(type);
+      for (const { astNode } of [...objects, ...interfaces]) {
+        (0, import_graphql.visit)(astNode, visitor);
+      }
+    } else if (type == null ? void 0 : type.astNode) {
+      (0, import_graphql.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) {
+      (0, import_graphql.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 = (0, import_utils.requireGraphQLSchemaFromContext)(RULE_ID, context);
+    const reachableTypes = getReachableTypes(schema);
+    return {
+      [`:matches(${KINDS}) > .name`](node) {
+        const typeName = node.value;
+        if (!reachableTypes.has(typeName)) {
+          const type = (0, import_lodash.default)(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)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});

package/cjs/rules/no-unused-fields.d.ts

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