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

package/esm/processor.js

@@ -0,0 +1,81 @@
+import "./chunk-U3TKCM4X.js";
+import { relative } from "node:path";
+import {
+  gqlPluckFromCodeStringSync
+} from "@graphql-tools/graphql-tag-pluck";
+import { asArray } from "@graphql-tools/utils";
+import { loadOnDiskGraphQLConfig } from "./graphql-config.js";
+import { CWD, REPORT_ON_FIRST_CHARACTER, truthy } from "./utils.js";
+const blocksMap = /* @__PURE__ */ new Map();
+let onDiskConfig, onDiskConfigLoaded = !1;
+const RELEVANT_KEYWORDS = ["gql", "graphql", "GraphQL"], processor = {
+  supportsAutofix: !0,
+  preprocess(code, filePath) {
+    onDiskConfigLoaded || (onDiskConfig = loadOnDiskGraphQLConfig(filePath), onDiskConfigLoaded = !0);
+    let keywords = RELEVANT_KEYWORDS;
+    const pluckConfig = onDiskConfig?.getProjectForFile(filePath).extensions.pluckConfig;
+    if (pluckConfig) {
+      const {
+        modules = [],
+        globalGqlIdentifierName = ["gql", "graphql"],
+        gqlMagicComment = "GraphQL"
+      } = pluckConfig;
+      keywords = [
+        ...new Set(
+          [
+            ...modules.map(({ identifier }) => identifier),
+            ...asArray(globalGqlIdentifierName),
+            gqlMagicComment
+          ].filter(truthy)
+        )
+      ];
+    }
+    if (keywords.every((keyword) => !code.includes(keyword)))
+      return [code];
+    try {
+      const blocks = gqlPluckFromCodeStringSync(filePath, code, {
+        skipIndent: !0,
+        ...pluckConfig
+      }).map((item) => ({
+        filename: "document.graphql",
+        text: item.body,
+        lineOffset: item.locationOffset.line - 1,
+        // @ts-expect-error -- `index` field exist but show ts error
+        offset: item.locationOffset.index + 1
+      }));
+      return blocksMap.set(filePath, blocks), [
+        ...blocks,
+        code
+        /* source code must be provided and be last */
+      ];
+    } catch (error) {
+      return error instanceof Error && (error.message = `[graphql-eslint] Error while preprocessing "${relative(
+        CWD,
+        filePath
+      )}" file
+
+${error.message}`), console.error(error), [code];
+    }
+  },
+  postprocess(messages, filePath) {
+    const blocks = blocksMap.get(filePath) || [];
+    for (let i = 0; i < blocks.length; i += 1) {
+      const { lineOffset, offset } = blocks[i];
+      for (const message of messages[i] || []) {
+        if (/\.(vue|svelte)$/.test(filePath)) {
+          delete message.endLine, delete message.endColumn, delete message.fix, delete message.suggestions, Object.assign(message, REPORT_ON_FIRST_CHARACTER);
+          continue;
+        }
+        message.line += lineOffset, typeof message.endLine == "number" && (message.endLine += lineOffset), message.fix && (message.fix.range[0] += offset, message.fix.range[1] += offset);
+        for (const suggestion of message.suggestions || []) {
+          const [start, end] = suggestion.fix.range;
+          suggestion.fix.range = [start + offset, end + offset];
+        }
+      }
+    }
+    return messages.flat().sort((a, b) => a.line - b.line || a.column - b.column);
+  }
+};
+export {
+  processor
+};

package/esm/rules/alphabetize.d.mts

@@ -0,0 +1,74 @@
+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 minProperties: 1;
+        readonly properties: {
+            readonly fields: {
+                readonly items: {
+                    readonly enum: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[];
+                };
+                readonly description: "Fields of `type`, `interface`, and `input`.";
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+            };
+            readonly values: {
+                readonly type: "boolean";
+                readonly description: "Values of `enum`.";
+            };
+            readonly selections: {
+                readonly items: {
+                    readonly enum: ("OperationDefinition" | "FragmentDefinition")[];
+                };
+                readonly description: "Selections of `fragment` and operations `query`, `mutation` and `subscription`.";
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+            };
+            readonly variables: {
+                readonly type: "boolean";
+                readonly description: "Variables of operations `query`, `mutation` and `subscription`.";
+            };
+            readonly arguments: {
+                readonly items: {
+                    readonly enum: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[];
+                };
+                readonly description: "Arguments of fields and directives.";
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly minItems: 1;
+            };
+            readonly definitions: {
+                readonly type: "boolean";
+                readonly description: "Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.";
+            };
+            readonly groups: {
+                readonly minItems: 2;
+                readonly description: "Custom order group. Example: `['id', '*', 'createdAt', 'updatedAt']` where `*` says for everything else.";
+                readonly type: "array";
+                readonly uniqueItems: true;
+                readonly items: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

package/esm/rules/alphabetize.js

@@ -0,0 +1,299 @@
+import "../chunk-U3TKCM4X.js";
+import {
+  Kind
+} from "graphql";
+import lowerCase from "lodash.lowercase";
+import { ARRAY_DEFAULT_OPTIONS, displayNodeName, truthy } from "../utils.js";
+const RULE_ID = "alphabetize", fieldsEnum = [
+  Kind.OBJECT_TYPE_DEFINITION,
+  Kind.INTERFACE_TYPE_DEFINITION,
+  Kind.INPUT_OBJECT_TYPE_DEFINITION
+], selectionsEnum = [
+  Kind.OPERATION_DEFINITION,
+  Kind.FRAGMENT_DEFINITION
+], argumentsEnum = [
+  Kind.FIELD_DEFINITION,
+  Kind.FIELD,
+  Kind.DIRECTIVE_DEFINITION,
+  Kind.DIRECTIVE
+], schema = {
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    minProperties: 1,
+    properties: {
+      fields: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        items: {
+          enum: fieldsEnum
+        },
+        description: "Fields of `type`, `interface`, and `input`."
+      },
+      values: {
+        type: "boolean",
+        description: "Values of `enum`."
+      },
+      selections: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        items: {
+          enum: selectionsEnum
+        },
+        description: "Selections of `fragment` and operations `query`, `mutation` and `subscription`."
+      },
+      variables: {
+        type: "boolean",
+        description: "Variables of operations `query`, `mutation` and `subscription`."
+      },
+      arguments: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        items: {
+          enum: argumentsEnum
+        },
+        description: "Arguments of fields and directives."
+      },
+      definitions: {
+        type: "boolean",
+        description: "Definitions \u2013 `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`."
+      },
+      groups: {
+        ...ARRAY_DEFAULT_OPTIONS,
+        minItems: 2,
+        description: "Custom order group. Example: `['id', '*', 'createdAt', 'updatedAt']` where `*` says for everything else."
+      }
+    }
+  }
+}, rule = {
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    docs: {
+      category: ["Schema", "Operations"],
+      description: "Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ fields: [Kind.OBJECT_TYPE_DEFINITION] }],
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              password: String
+              firstName: String! # should be before "password"
+              age: Int # should be before "firstName"
+              lastName: String!
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ fields: [Kind.OBJECT_TYPE_DEFINITION] }],
+          code: (
+            /* GraphQL */
+            `
+            type User {
+              age: Int
+              firstName: String!
+              lastName: String!
+              password: String
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          usage: [{ values: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            enum Role {
+              SUPER_ADMIN
+              ADMIN # should be before "SUPER_ADMIN"
+              USER
+              GOD # should be before "USER"
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ values: !0 }],
+          code: (
+            /* GraphQL */
+            `
+            enum Role {
+              ADMIN
+              GOD
+              SUPER_ADMIN
+              USER
+            }
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          usage: [{ selections: [Kind.OPERATION_DEFINITION] }],
+          code: (
+            /* GraphQL */
+            `
+            query {
+              me {
+                firstName
+                lastName
+                email # should be before "lastName"
+              }
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ selections: [Kind.OPERATION_DEFINITION] }],
+          code: (
+            /* GraphQL */
+            `
+            query {
+              me {
+                email
+                firstName
+                lastName
+              }
+            }
+          `
+          )
+        }
+      ],
+      configOptions: {
+        schema: [
+          {
+            definitions: !0,
+            fields: fieldsEnum,
+            values: !0,
+            arguments: argumentsEnum,
+            groups: ["id", "*", "createdAt", "updatedAt"]
+          }
+        ],
+        operations: [
+          {
+            definitions: !0,
+            selections: selectionsEnum,
+            variables: !0,
+            arguments: [Kind.FIELD, Kind.DIRECTIVE],
+            groups: ["id", "*", "createdAt", "updatedAt"]
+          }
+        ]
+      }
+    },
+    messages: {
+      [RULE_ID]: "{{ currNode }} should be before {{ prevNode }}"
+    },
+    schema
+  },
+  create(context) {
+    const sourceCode = context.getSourceCode();
+    function isNodeAndCommentOnSameLine(node, comment) {
+      return node.loc.end.line === comment.loc.start.line;
+    }
+    function getBeforeComments(node) {
+      const commentsBefore = sourceCode.getCommentsBefore(node);
+      if (commentsBefore.length === 0)
+        return [];
+      const tokenBefore = sourceCode.getTokenBefore(node);
+      if (tokenBefore)
+        return commentsBefore.filter((comment) => !isNodeAndCommentOnSameLine(tokenBefore, comment));
+      const filteredComments = [], nodeLine = node.loc.start.line;
+      for (let i = commentsBefore.length - 1; i >= 0; i -= 1) {
+        const comment = commentsBefore[i];
+        if (nodeLine - comment.loc.start.line - filteredComments.length > 1)
+          break;
+        filteredComments.unshift(comment);
+      }
+      return filteredComments;
+    }
+    function getRangeWithComments(node) {
+      node.kind === Kind.VARIABLE && (node = node.parent);
+      const [firstBeforeComment] = getBeforeComments(node), [firstAfterComment] = sourceCode.getCommentsAfter(node), from = firstBeforeComment || node, to = firstAfterComment && isNodeAndCommentOnSameLine(node, firstAfterComment) ? firstAfterComment : node;
+      return [from.range[0], to.range[1]];
+    }
+    function checkNodes(nodes = []) {
+      for (let i = 1; i < nodes.length; i += 1) {
+        const currNode = nodes[i], currName = "alias" in currNode && currNode.alias?.value || "name" in currNode && currNode.name?.value;
+        if (!currName)
+          continue;
+        const prevNode = nodes[i - 1], prevName = "alias" in prevNode && prevNode.alias?.value || "name" in prevNode && prevNode.name?.value;
+        if (prevName) {
+          const compareResult = prevName.localeCompare(currName), { groups } = opts;
+          let shouldSortByGroup = !1;
+          if (groups?.length) {
+            if (!groups.includes("*"))
+              throw new Error("`groups` option should contain `*` string.");
+            let indexForPrev = groups.indexOf(prevName);
+            indexForPrev === -1 && (indexForPrev = groups.indexOf("*"));
+            let indexForCurr = groups.indexOf(currName);
+            if (indexForCurr === -1 && (indexForCurr = groups.indexOf("*")), shouldSortByGroup = indexForPrev - indexForCurr > 0, indexForPrev < indexForCurr)
+              continue;
+          }
+          if (!shouldSortByGroup && !(compareResult === 1) && (!(compareResult === 0) || !prevNode.kind.endsWith("Extension") || currNode.kind.endsWith("Extension")))
+            continue;
+        }
+        context.report({
+          // @ts-expect-error can't be undefined
+          node: "alias" in currNode && currNode.alias || currNode.name,
+          messageId: RULE_ID,
+          data: {
+            currNode: displayNodeName(currNode),
+            prevNode: prevName ? displayNodeName(prevNode) : lowerCase(prevNode.kind)
+          },
+          *fix(fixer) {
+            const prevRange = getRangeWithComments(prevNode), currRange = getRangeWithComments(currNode);
+            yield fixer.replaceTextRange(
+              prevRange,
+              sourceCode.getText({ range: currRange })
+            ), yield fixer.replaceTextRange(
+              currRange,
+              sourceCode.getText({ range: prevRange })
+            );
+          }
+        });
+      }
+    }
+    const opts = context.options[0], fields = new Set(opts.fields ?? []), listeners = {}, fieldsSelector = [
+      fields.has(Kind.OBJECT_TYPE_DEFINITION) && [
+        Kind.OBJECT_TYPE_DEFINITION,
+        Kind.OBJECT_TYPE_EXTENSION
+      ],
+      fields.has(Kind.INTERFACE_TYPE_DEFINITION) && [
+        Kind.INTERFACE_TYPE_DEFINITION,
+        Kind.INTERFACE_TYPE_EXTENSION
+      ],
+      fields.has(Kind.INPUT_OBJECT_TYPE_DEFINITION) && [
+        Kind.INPUT_OBJECT_TYPE_DEFINITION,
+        Kind.INPUT_OBJECT_TYPE_EXTENSION
+      ]
+    ].filter(truthy).flat().join(","), selectionsSelector = opts.selections?.join(","), argumentsSelector = opts.arguments?.join(",");
+    if (fieldsSelector && (listeners[fieldsSelector] = (node) => {
+      checkNodes(node.fields);
+    }), opts.values) {
+      const enumValuesSelector = [Kind.ENUM_TYPE_DEFINITION, Kind.ENUM_TYPE_EXTENSION].join(",");
+      listeners[enumValuesSelector] = (node) => {
+        checkNodes(node.values);
+      };
+    }
+    return selectionsSelector && (listeners[`:matches(${selectionsSelector}) SelectionSet`] = (node) => {
+      checkNodes(node.selections);
+    }), opts.variables && (listeners.OperationDefinition = (node) => {
+      checkNodes(node.variableDefinitions?.map((varDef) => varDef.variable));
+    }), argumentsSelector && (listeners[argumentsSelector] = (node) => {
+      checkNodes(node.arguments);
+    }), opts.definitions && (listeners.Document = (node) => {
+      checkNodes(node.definitions);
+    }), listeners;
+  }
+};
+export {
+  rule
+};

package/esm/rules/description-style.d.mts

@@ -0,0 +1,29 @@
+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 minProperties: 1;
+        readonly properties: {
+            readonly style: {
+                readonly enum: readonly ["block", "inline"];
+                readonly default: "block";
+            };
+        };
+    };
+};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };

package/esm/rules/description-style.js

@@ -0,0 +1,82 @@
+import "../chunk-U3TKCM4X.js";
+import { getNodeName } from "../utils.js";
+const schema = {
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: !1,
+    minProperties: 1,
+    properties: {
+      style: {
+        enum: ["block", "inline"],
+        default: "block"
+      }
+    }
+  }
+}, rule = {
+  meta: {
+    type: "suggestion",
+    hasSuggestions: !0,
+    docs: {
+      examples: [
+        {
+          title: "Incorrect",
+          usage: [{ style: "inline" }],
+          code: (
+            /* GraphQL */
+            `
+            """ Description """
+            type someTypeName {
+              # ...
+            }
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ style: "inline" }],
+          code: (
+            /* GraphQL */
+            `
+            " Description "
+            type someTypeName {
+              # ...
+            }
+          `
+          )
+        }
+      ],
+      description: "Require all comments to follow the same style (either block or inline).",
+      category: "Schema",
+      url: "https://the-guild.dev/graphql/eslint/rules/description-style",
+      recommended: !0
+    },
+    schema
+  },
+  create(context) {
+    const { style = "block" } = context.options[0] || {}, isBlock = style === "block";
+    return {
+      [`.description[type=StringValue][block!=${isBlock}]`](node) {
+        context.report({
+          loc: isBlock ? node.loc : node.loc.start,
+          message: `Unexpected ${isBlock ? "inline" : "block"} description for ${getNodeName(
+            node.parent
+          )}`,
+          suggest: [
+            {
+              desc: `Change to ${isBlock ? "block" : "inline"} style description`,
+              fix(fixer) {
+                const originalText = context.getSourceCode().getText(node), newText = isBlock ? originalText.replace(/(^")|("$)/g, '"""') : originalText.replace(/(^""")|("""$)/g, '"').replace(/\s+/g, " ");
+                return fixer.replaceText(node, newText);
+              }
+            }
+          ]
+        });
+      }
+    };
+  }
+};
+export {
+  rule
+};

package/esm/rules/graphql-js-validation.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 GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule>;
+
+export { GRAPHQL_JS_VALIDATIONS };