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

package/esm/rules/no-deprecated.js

@@ -0,0 +1,134 @@
+import "../chunk-BMTV3EA2.js";
+import { Kind } from "graphql";
+import { requireGraphQLSchemaFromContext } from "../utils.js";
+const RULE_ID = "no-deprecated";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      category: "Operations",
+      description: "Enforce that deprecated fields or enum values are not in use by operations.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: true,
+      examples: [
+        {
+          title: "Incorrect (field)",
+          code: (
+            /* GraphQL */
+            `
+            # In your schema
+            type User {
+              id: ID!
+              name: String! @deprecated(reason: "old field, please use fullName instead")
+              fullName: String!
+            }
+
+            # Query
+            query user {
+              user {
+                name # This is deprecated, so you'll get an error
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect (enum value)",
+          code: (
+            /* GraphQL */
+            `
+            # In your schema
+            type Mutation {
+              changeSomething(type: SomeType): Boolean!
+            }
+
+            enum SomeType {
+              NEW
+              OLD @deprecated(reason: "old field, please use NEW instead")
+            }
+
+            # Mutation
+            mutation {
+              changeSomething(
+                type: OLD # This is deprecated, so you'll get an error
+              ) {
+                ...
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            # In your schema
+            type User {
+              id: ID!
+              name: String! @deprecated(reason: "old field, please use fullName instead")
+              fullName: String!
+            }
+
+            # Query
+            query user {
+              user {
+                id
+                fullName
+              }
+            }
+          `
+          )
+        }
+      ],
+      recommended: true
+    },
+    messages: {
+      [RULE_ID]: "This {{ type }} is marked as deprecated in your GraphQL schema (reason: {{ reason }})"
+    },
+    schema: []
+  },
+  create(context) {
+    requireGraphQLSchemaFromContext(RULE_ID, context);
+    function report(node, reason) {
+      const nodeName = node.kind === Kind.ENUM ? node.value : node.name.value;
+      const nodeType = node.kind === Kind.ENUM ? "enum value" : "field";
+      context.report({
+        node,
+        messageId: RULE_ID,
+        data: {
+          type: nodeType,
+          reason
+        },
+        suggest: [
+          {
+            desc: `Remove \`${nodeName}\` ${nodeType}`,
+            fix: (fixer) => fixer.remove(node)
+          }
+        ]
+      });
+    }
+    return {
+      EnumValue(node) {
+        var _a;
+        const typeInfo = node.typeInfo();
+        const reason = (_a = typeInfo.enumValue) == null ? void 0 : _a.deprecationReason;
+        if (reason) {
+          report(node, reason);
+        }
+      },
+      Field(node) {
+        var _a;
+        const typeInfo = node.typeInfo();
+        const reason = (_a = typeInfo.fieldDef) == null ? void 0 : _a.deprecationReason;
+        if (reason) {
+          report(node, reason);
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

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

@@ -0,0 +1,123 @@
+import "../chunk-BMTV3EA2.js";
+import { Kind } from "graphql";
+const RULE_ID = "no-duplicate-fields";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    docs: {
+      description: "Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.",
+      category: "Operations",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      recommended: true,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            query {
+              user {
+                name
+                email
+                name # duplicate field
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            query {
+              users(
+                first: 100
+                skip: 50
+                after: "cji629tngfgou0b73kt7vi5jo"
+                first: 100 # duplicate argument
+              ) {
+                id
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            query (
+              $first: Int!
+              $first: Int! # duplicate variable
+            ) {
+              users(first: $first, skip: 50) {
+                id
+              }
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [RULE_ID]: "{{ type }} `{{ fieldName }}` defined multiple times."
+    },
+    schema: []
+  },
+  create(context) {
+    function checkNode(usedFields, node) {
+      const fieldName = node.value;
+      if (usedFields.has(fieldName)) {
+        const { parent } = node;
+        context.report({
+          node,
+          messageId: RULE_ID,
+          data: {
+            type: parent.type,
+            fieldName
+          },
+          suggest: [
+            {
+              desc: `Remove \`${fieldName}\` ${parent.type.toLowerCase()}`,
+              fix(fixer) {
+                return fixer.remove(
+                  parent.type === Kind.VARIABLE ? parent.parent : parent
+                );
+              }
+            }
+          ]
+        });
+      } else {
+        usedFields.add(fieldName);
+      }
+    }
+    return {
+      OperationDefinition(node) {
+        const set = /* @__PURE__ */ new Set();
+        for (const varDef of node.variableDefinitions || []) {
+          checkNode(set, varDef.variable.name);
+        }
+      },
+      Field(node) {
+        const set = /* @__PURE__ */ new Set();
+        for (const arg of node.arguments || []) {
+          checkNode(set, arg.name);
+        }
+      },
+      SelectionSet(node) {
+        const set = /* @__PURE__ */ new Set();
+        for (const selection of node.selections) {
+          if (selection.kind === Kind.FIELD) {
+            checkNode(set, selection.alias || selection.name);
+          }
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-hashtag-description.d.mts

@@ -0,0 +1,13 @@
+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_ID = "HASHTAG_COMMENT";
+declare const rule: GraphQLESLintRule;
+
+export { RULE_ID, rule };

package/esm/rules/no-hashtag-description.js

@@ -0,0 +1,116 @@
+import "../chunk-BMTV3EA2.js";
+import { TokenKind } from "graphql";
+import { getNodeName } from "../utils.js";
+const RULE_ID = "HASHTAG_COMMENT";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: true,
+    schema: [],
+    messages: {
+      [RULE_ID]: 'Unexpected GraphQL descriptions as hashtag `#` for {{ nodeName }}.\nPrefer using `"""` for multiline, or `"` for a single line description.'
+    },
+    docs: {
+      description: 'Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.\nAllows to use hashtag for comments, as long as it\'s not attached to an AST definition.',
+      category: "Schema",
+      url: "https://the-guild.dev/graphql/eslint/rules/no-hashtag-description",
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            # Represents a user
+            type User {
+              id: ID!
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            " Represents a user "
+            type User {
+              id: ID!
+              name: String
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            # This file defines the basic User type.
+            # This comment is valid because it's not attached specifically to an AST object.
+
+            " Represents a user "
+            type User {
+              id: ID! # This one is also valid, since it comes after the AST object
+              name: String
+            }
+          `
+          )
+        }
+      ],
+      recommended: true
+    }
+  },
+  create(context) {
+    const selector = "Document[definitions.0.kind!=/^(OperationDefinition|FragmentDefinition)$/]";
+    return {
+      [selector](node) {
+        const rawNode = node.rawNode();
+        let token = rawNode.loc.startToken;
+        while (token) {
+          const { kind, prev, next, value, line, column } = token;
+          if (kind === TokenKind.COMMENT && prev && next) {
+            const isEslintComment = value.trimStart().startsWith("eslint");
+            const linesAfter = next.line - line;
+            if (!isEslintComment && line !== prev.line && next.kind === TokenKind.NAME && linesAfter < 2) {
+              const sourceCode = context.getSourceCode();
+              const { tokens } = sourceCode.ast;
+              const t = tokens.find(
+                (token2) => token2.loc.start.line === next.line && token2.loc.start.column === next.column - 1
+              );
+              const nextNode = sourceCode.getNodeByRangeIndex(t.range[1] + 1);
+              context.report({
+                messageId: RULE_ID,
+                data: {
+                  nodeName: getNodeName(
+                    "name" in nextNode ? nextNode : nextNode.parent
+                  )
+                },
+                loc: {
+                  line,
+                  column: column - 1
+                },
+                suggest: ['"""', '"'].map((descriptionSyntax) => ({
+                  desc: `Replace with \`${descriptionSyntax}\` description syntax`,
+                  fix: (fixer) => fixer.replaceTextRange(
+                    [token.start, token.end],
+                    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- TODO: remove `!` when drop support of graphql@15
+                    [descriptionSyntax, value.trim(), descriptionSyntax].join("")
+                  )
+                }))
+              });
+            }
+          }
+          if (!next) {
+            break;
+          }
+          token = next;
+        }
+      }
+    };
+  }
+};
+export {
+  RULE_ID,
+  rule
+};

package/esm/rules/no-one-place-fragments.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-one-place-fragments.js

@@ -0,0 +1,90 @@
+import "../chunk-BMTV3EA2.js";
+import { relative } from "path";
+import { visit } from "graphql";
+import { CWD, requireSiblingsOperations } from "../utils.js";
+const RULE_ID = "no-one-place-fragments";
+const rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Operations",
+      description: "Disallow fragments that are used only in one place.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            fragment UserFields on User {
+              id
+            }
+
+            {
+              user {
+                ...UserFields
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            fragment UserFields on User {
+              id
+            }
+
+            {
+              user {
+                ...UserFields
+                friends {
+                  ...UserFields
+                }
+              }
+            }
+          `
+          )
+        }
+      ],
+      requiresSiblings: true
+    },
+    messages: {
+      [RULE_ID]: 'Fragment `{{fragmentName}}` used only once. Inline him in "{{filePath}}".'
+    },
+    schema: []
+  },
+  create(context) {
+    const operations = requireSiblingsOperations(RULE_ID, context);
+    const allDocuments = [...operations.getOperations(), ...operations.getFragments()];
+    const usedFragmentsMap = /* @__PURE__ */ Object.create(null);
+    for (const { document, filePath } of allDocuments) {
+      const relativeFilePath = relative(CWD, filePath);
+      visit(document, {
+        FragmentSpread({ name }) {
+          const spreadName = name.value;
+          usedFragmentsMap[spreadName] || (usedFragmentsMap[spreadName] = []);
+          usedFragmentsMap[spreadName].push(relativeFilePath);
+        }
+      });
+    }
+    return {
+      "FragmentDefinition > Name"(node) {
+        const fragmentName = node.value;
+        const fragmentUsage = usedFragmentsMap[fragmentName];
+        if (fragmentUsage.length === 1) {
+          context.report({
+            node,
+            messageId: RULE_ID,
+            data: { fragmentName, filePath: fragmentUsage[0] }
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-root-type.d.mts

@@ -0,0 +1,33 @@
+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 minItems: 1;
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["disallow"];
+        readonly properties: {
+            readonly disallow: {
+                readonly items: {
+                    readonly enum: readonly ["mutation", "subscription"];
+                };
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

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

@@ -0,0 +1,90 @@
+import "../chunk-BMTV3EA2.js";
+import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchemaFromContext, truthy } from "../utils.js";
+const schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    required: ["disallow"],
+    properties: {
+      disallow: {
+        ...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 = 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(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)
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/no-scalar-result-type-on-mutation.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 };