@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230810155929-e89edf7

package/esm/rules/selection-set-depth.d.mts

@@ -0,0 +1,37 @@
+import { FromSchema } from 'json-schema-to-ts';
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const schema: {
+    readonly type: "array";
+    readonly minItems: 1;
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["maxDepth"];
+        readonly properties: {
+            readonly maxDepth: {
+                readonly type: "number";
+            };
+            readonly ignore: {
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+                readonly items: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

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

@@ -0,0 +1,133 @@
+import "../chunk-U3TKCM4X.js";
+import { Kind } from "graphql";
+import depthLimit from "graphql-depth-limit";
+import { ARRAY_DEFAULT_OPTIONS, logger, requireSiblingsOperations } from "../utils.js";
+const RULE_ID = "selection-set-depth", schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    required: ["maxDepth"],
+    properties: {
+      maxDepth: {
+        type: "number"
+      },
+      ignore: ARRAY_DEFAULT_OPTIONS
+    }
+  }
+}, rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: !0,
+    docs: {
+      category: "Operations",
+      description: "Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSiblings: !0,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ maxDepth: 1 }],
+          code: `
+            query deep2 {
+              viewer { # Level 0
+                albums { # Level 1
+                  title # Level 2
+                }
+              }
+            }
+          `
+        },
+        {
+          title: "Correct",
+          usage: [{ maxDepth: 4 }],
+          code: `
+            query deep2 {
+              viewer { # Level 0
+                albums { # Level 1
+                  title # Level 2
+                }
+              }
+            }
+          `
+        },
+        {
+          title: "Correct (ignored field)",
+          usage: [{ maxDepth: 1, ignore: ["albums"] }],
+          code: `
+            query deep2 {
+              viewer { # Level 0
+                albums { # Level 1
+                  title # Level 2
+                }
+              }
+            }
+          `
+        }
+      ],
+      recommended: !0,
+      configOptions: [{ maxDepth: 7 }]
+    },
+    schema
+  },
+  create(context) {
+    let siblings = null;
+    try {
+      siblings = requireSiblingsOperations(RULE_ID, context);
+    } catch {
+      logger.warn(
+        `Rule "${RULE_ID}" works best with siblings operations loaded. For more info: https://bit.ly/graphql-eslint-operations`
+      );
+    }
+    const { maxDepth, ignore = [] } = context.options[0], checkFn = depthLimit(maxDepth, { ignore });
+    return {
+      "OperationDefinition, FragmentDefinition"(node) {
+        try {
+          const rawNode = node.rawNode(), fragmentsInUse = siblings ? siblings.getFragmentsInUse(rawNode) : [], document = {
+            kind: Kind.DOCUMENT,
+            definitions: [rawNode, ...fragmentsInUse]
+          };
+          checkFn({
+            getDocument: () => document,
+            reportError(error) {
+              const { line, column } = error.locations[0], token = context.getAncestors()[0].tokens.find(
+                (token2) => token2.loc.start.line === line && token2.loc.start.column === column - 1
+              );
+              context.report({
+                loc: {
+                  line,
+                  column: column - 1
+                },
+                message: error.message,
+                // Don't provide suggestions for fragment that can be in a separate file
+                ...token && {
+                  suggest: [
+                    {
+                      desc: "Remove selections",
+                      fix(fixer) {
+                        const foundNode = context.getSourceCode().getNodeByRangeIndex(token.range[0]), parentNode = foundNode.parent.parent;
+                        return fixer.remove(
+                          foundNode.kind === "Name" ? parentNode.parent : parentNode
+                        );
+                      }
+                    }
+                  ]
+                }
+              });
+            }
+          });
+        } catch (e) {
+          logger.warn(
+            `Rule "${RULE_ID}" check failed due to a missing siblings operations. For more info: https://bit.ly/graphql-eslint-operations`,
+            e
+          );
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/strict-id-in-types.d.mts

@@ -0,0 +1,66 @@
+import { FromSchema } from 'json-schema-to-ts';
+import { GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import '../estree-converter/types.mjs';
+import 'graphql-config';
+
+declare const schema: {
+    readonly type: "array";
+    readonly maxItems: 1;
+    readonly items: {
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly acceptedIdNames: {
+                readonly default: readonly ["id"];
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+                readonly items: {
+                    readonly type: "string";
+                };
+            };
+            readonly acceptedIdTypes: {
+                readonly default: readonly ["ID"];
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+                readonly items: {
+                    readonly type: "string";
+                };
+            };
+            readonly exceptions: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly types: {
+                        readonly description: "This is used to exclude types with names that match one of the specified values.";
+                        readonly type: "array";
+                        readonly uniqueItems: true;
+                        readonly minItems: 1;
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly suffixes: {
+                        readonly description: "This is used to exclude types with names with suffixes that match one of the specified values.";
+                        readonly type: "array";
+                        readonly uniqueItems: true;
+                        readonly minItems: 1;
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    };
+                };
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

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

@@ -0,0 +1,155 @@
+import "../chunk-U3TKCM4X.js";
+import { Kind } from "graphql";
+import {
+  ARRAY_DEFAULT_OPTIONS,
+  displayNodeName,
+  englishJoinWords,
+  requireGraphQLSchemaFromContext,
+  truthy
+} from "../utils.js";
+const RULE_ID = "strict-id-in-types", schema = {
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    properties: {
+      acceptedIdNames: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        default: ["id"]
+      },
+      acceptedIdTypes: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        default: ["ID"]
+      },
+      exceptions: {
+        type: "object",
+        additionalProperties: !1,
+        properties: {
+          types: {
+            ...ARRAY_DEFAULT_OPTIONS,
+            description: "This is used to exclude types with names that match one of the specified values."
+          },
+          suffixes: {
+            ...ARRAY_DEFAULT_OPTIONS,
+            description: "This is used to exclude types with names with suffixes that match one of the specified values."
+          }
+        }
+      }
+    }
+  }
+}, rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.",
+      category: "Schema",
+      recommended: !0,
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSchema: !0,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [
+            {
+              acceptedIdNames: ["id", "_id"],
+              acceptedIdTypes: ["ID"],
+              exceptions: { suffixes: ["Payload"] }
+            }
+          ],
+          code: (
+            /* GraphQL */
+            `
+            # Incorrect field name
+            type InvalidFieldName {
+              key: ID!
+            }
+
+            # Incorrect field type
+            type InvalidFieldType {
+              id: String!
+            }
+
+            # Incorrect exception suffix
+            type InvalidSuffixResult {
+              data: String!
+            }
+
+            # Too many unique identifiers. Must only contain one.
+            type InvalidFieldName {
+              id: ID!
+              _id: ID!
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [
+            {
+              acceptedIdNames: ["id", "_id"],
+              acceptedIdTypes: ["ID"],
+              exceptions: { types: ["Error"], suffixes: ["Payload"] }
+            }
+          ],
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              id: ID!
+            }
+
+            type Post {
+              _id: ID!
+            }
+
+            type CreateUserPayload {
+              data: String!
+            }
+
+            type Error {
+              message: String!
+            }
+          `
+          )
+        }
+      ]
+    },
+    schema
+  },
+  create(context) {
+    const options = {
+      acceptedIdNames: ["id"],
+      acceptedIdTypes: ["ID"],
+      exceptions: {},
+      ...context.options[0]
+    }, schema2 = requireGraphQLSchemaFromContext(RULE_ID, context);
+    return {
+      [`ObjectTypeDefinition[name.value!=/^(${[
+        schema2.getQueryType(),
+        schema2.getMutationType(),
+        schema2.getSubscriptionType()
+      ].filter(truthy).map((type) => type.name).join("|")})$/]`](node) {
+        const typeName = node.name.value;
+        if (options.exceptions.types?.includes(typeName) || options.exceptions.suffixes?.some((suffix) => typeName.endsWith(suffix)))
+          return;
+        if (node.fields?.filter((field) => {
+          const fieldNode = field.rawNode(), isValidIdName = options.acceptedIdNames.includes(fieldNode.name.value);
+          let isValidIdType = !1;
+          return fieldNode.type.kind === Kind.NON_NULL_TYPE && fieldNode.type.type.kind === Kind.NAMED_TYPE && (isValidIdType = options.acceptedIdTypes.includes(fieldNode.type.type.name.value)), isValidIdName && isValidIdType;
+        })?.length !== 1) {
+          const pluralNamesSuffix = options.acceptedIdNames.length > 1 ? "s" : "", pluralTypesSuffix = options.acceptedIdTypes.length > 1 ? "s" : "";
+          context.report({
+            node: node.name,
+            message: `${displayNodeName(node)} must have exactly one non-nullable unique identifier.
+Accepted name${pluralNamesSuffix}: ${englishJoinWords(options.acceptedIdNames)}.
+Accepted type${pluralTypesSuffix}: ${englishJoinWords(options.acceptedIdTypes)}.`
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/unique-enum-value-names.d.mts

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

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

@@ -0,0 +1,72 @@
+import "../chunk-U3TKCM4X.js";
+import { Kind } from "graphql";
+import { getNodeName } from "../utils.js";
+const rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: !0,
+    docs: {
+      url: "https://the-guild.dev/graphql/eslint/rules/unique-enum-value-names",
+      category: "Schema",
+      recommended: !0,
+      description: `A GraphQL enum type is only valid if all its values are uniquely named.
+> This rule disallows case-insensitive enum values duplicates too.`,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            enum MyEnum {
+              Value
+              VALUE
+              ValuE
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            enum MyEnum {
+              Value1
+              Value2
+              Value3
+            }
+          `
+          )
+        }
+      ]
+    },
+    schema: []
+  },
+  create(context) {
+    return {
+      [[Kind.ENUM_TYPE_DEFINITION, Kind.ENUM_TYPE_EXTENSION].join(",")](node) {
+        const duplicates = node.values?.filter(
+          (item, index, array) => array.findIndex((v) => v.name.value.toLowerCase() === item.name.value.toLowerCase()) !== index
+        );
+        for (const duplicate of duplicates || []) {
+          const enumName = duplicate.name.value;
+          context.report({
+            node: duplicate.name,
+            message: `Unexpected case-insensitive enum values duplicates for ${getNodeName(
+              duplicate
+            )}`,
+            suggest: [
+              {
+                desc: `Remove \`${enumName}\` enum value`,
+                fix: (fixer) => fixer.remove(duplicate)
+              }
+            ]
+          });
+        }
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/unique-fragment-name.d.mts

@@ -0,0 +1,14 @@
+import { ExecutableDefinitionNode } from 'graphql';
+import { GraphQLESTreeNode } from '../estree-converter/types.mjs';
+import { GraphQLESLintRuleContext, GraphQLESLintRule } from '../types.mjs';
+import 'eslint';
+import 'estree';
+import 'json-schema-to-ts';
+import '../siblings.mjs';
+import '@graphql-tools/utils';
+import 'graphql-config';
+
+declare const checkNode: (context: GraphQLESLintRuleContext, node: GraphQLESTreeNode<ExecutableDefinitionNode>, ruleId: string) => void;
+declare const rule: GraphQLESLintRule;
+
+export { checkNode, rule };

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

@@ -0,0 +1,87 @@
+import "../chunk-U3TKCM4X.js";
+import { relative } from "node:path";
+import { Kind } from "graphql";
+import { CWD, normalizePath, requireSiblingsOperations, 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 isSameName = f.document.name?.value === documentName, isSamePath = normalizePath(f.filePath) === normalizePath(filepath);
+    return isSameName && !isSamePath;
+  });
+  conflictingDocuments.length > 0 && context.report({
+    messageId: ruleId,
+    data: {
+      documentName,
+      summary: conflictingDocuments.map((f) => `	${relative(CWD, f.filePath.replace(VIRTUAL_DOCUMENT_REGEX, ""))}`).join(`
+`)
+    },
+    // @ts-expect-error name will exist
+    node: node.name
+  });
+}, rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Operations",
+      description: "Enforce unique fragment names across your project.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSiblings: !0,
+      recommended: !0,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            # user.fragment.graphql
+            fragment UserFields on User {
+              id
+              name
+              fullName
+            }
+
+            # user-fields.graphql
+            fragment UserFields on User {
+              id
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            # user.fragment.graphql
+            fragment AllUserFields on User {
+              id
+              name
+              fullName
+            }
+
+            # user-fields.graphql
+            fragment UserFields on User {
+              id
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [RULE_ID]: `Fragment named "{{ documentName }}" already defined in:
+{{ summary }}`
+    },
+    schema: []
+  },
+  create(context) {
+    return {
+      FragmentDefinition(node) {
+        checkNode(context, node, RULE_ID);
+      }
+    };
+  }
+};
+export {
+  checkNode,
+  rule
+};

package/esm/rules/unique-operation-name.d.mts

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

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

@@ -0,0 +1,73 @@
+import "../chunk-U3TKCM4X.js";
+import { checkNode } from "./unique-fragment-name.js";
+const RULE_ID = "unique-operation-name", rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Operations",
+      description: "Enforce unique operation names across your project.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      requiresSiblings: !0,
+      recommended: !0,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
+            # foo.query.graphql
+            query user {
+              user {
+                id
+              }
+            }
+
+            # bar.query.graphql
+            query user {
+              me {
+                id
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
+            # foo.query.graphql
+            query user {
+              user {
+                id
+              }
+            }
+
+            # bar.query.graphql
+            query me {
+              me {
+                id
+              }
+            }
+          `
+          )
+        }
+      ]
+    },
+    messages: {
+      [RULE_ID]: `Operation named "{{ documentName }}" already defined in:
+{{ summary }}`
+    },
+    schema: []
+  },
+  create(context) {
+    return {
+      "OperationDefinition[name!=undefined]"(node) {
+        checkNode(context, node, RULE_ID);
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/schema.d.mts

@@ -0,0 +1,13 @@
+import { GraphQLProjectConfig } from 'graphql-config';
+import { Schema } from './types.mjs';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'json-schema-to-ts';
+import './siblings.mjs';
+import '@graphql-tools/utils';
+import './estree-converter/types.mjs';
+
+declare function getSchema(project: GraphQLProjectConfig): Schema;
+
+export { getSchema };