@graphql-eslint/eslint-plugin 3.19.3 → 3.20.0-alpha-20230703155329-a20556f

package/esm/rules/no-duplicate-fields.js

@@ -1,18 +1,20 @@
-import { Kind } from 'graphql';
-const RULE_ID = 'no-duplicate-fields';
-export 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 */ `
+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
@@ -20,11 +22,14 @@ export const rule = {
                 name # duplicate field
               }
             }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             query {
               users(
                 first: 100
@@ -35,11 +40,14 @@ export const rule = {
                 id
               }
             }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             query (
               $first: Int!
               $first: Int! # duplicate variable
@@ -48,62 +56,67 @@ export const rule = {
                 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);
+    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);
         }
-        return {
-            OperationDefinition(node) {
-                const set = new Set();
-                for (const varDef of node.variableDefinitions || []) {
-                    checkNode(set, varDef.variable.name);
-                }
-            },
-            Field(node) {
-                const set = new Set();
-                for (const arg of node.arguments || []) {
-                    checkNode(set, arg.name);
-                }
-            },
-            SelectionSet(node) {
-                const set = new Set();
-                for (const selection of node.selections) {
-                    if (selection.kind === Kind.FIELD) {
-                        checkNode(set, selection.alias || selection.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 { i as GraphQLESLintRule } from '../types-2e1afd7c.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

@@ -1,42 +1,50 @@
-import { TokenKind } from 'graphql';
-import { getNodeName } from '../utils.js';
-export const RULE_ID = 'HASHTAG_COMMENT';
-export 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 */ `
+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 */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             " Represents a user "
             type User {
               id: ID!
               name: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          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.
 
@@ -45,56 +53,63 @@ export const rule = {
               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
+                  )
                 },
-            ],
-            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) {
-                        // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- TODO: remove `!` when drop support of graphql@15
-                        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(token => token.loc.start.line === next.line && token.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;
-                }
-            },
-        };
-    },
+                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 { i as GraphQLESLintRule } from '../types-2e1afd7c.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

@@ -1,18 +1,20 @@
-import { relative } from 'path';
-import { visit } from 'graphql';
-import { CWD, requireSiblingsOperations } from '../utils.js';
-const RULE_ID = 'no-one-place-fragments';
-export 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 */ `
+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
             }
@@ -22,11 +24,14 @@ export const rule = {
                 ...UserFields
               }
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             fragment UserFields on User {
               id
             }
@@ -39,42 +44,46 @@ export const rule = {
                 }
               }
             }
-          `,
-                },
-            ],
-            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 = 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] },
-                    });
-                }
-            },
-        };
+      ],
+      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].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/{typings/rules/no-root-type.d.cts → esm/rules/no-root-type.d.mts}

@@ -1,5 +1,12 @@
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESLintRule } from '../types.cjs';
+import { i as GraphQLESLintRule } from '../types-2e1afd7c.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;
@@ -20,6 +27,7 @@ declare const schema: {
         };
     };
 };
-export type RuleOptions = FromSchema<typeof schema>;
-export declare const rule: GraphQLESLintRule<RuleOptions>;
-export {};
+type RuleOptions = FromSchema<typeof schema>;
+declare const rule: GraphQLESLintRule<RuleOptions>;
+
+export { RuleOptions, rule };