@graphql-eslint/eslint-plugin 3.19.3 → 3.20.0-alpha-20230703154330-0d51273

package/cjs/rules/lone-executable-definition.js

@@ -1,88 +1,117 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rule = void 0;
-const utils_js_1 = require("../utils.js");
-const RULE_ID = 'lone-executable-definition';
-const definitionTypes = ['fragment', 'query', 'mutation', 'subscription'];
+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 lone_executable_definition_exports = {};
+__export(lone_executable_definition_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(lone_executable_definition_exports);
+var import_utils = require("../utils.js");
+const RULE_ID = "lone-executable-definition";
+const definitionTypes = ["fragment", "query", "mutation", "subscription"];
 const schema = {
-    type: 'array',
-    maxItems: 1,
-    items: {
-        type: 'object',
-        minProperties: 1,
-        additionalProperties: false,
-        properties: {
-            ignore: {
-                ...utils_js_1.ARRAY_DEFAULT_OPTIONS,
-                maxItems: 3,
-                items: {
-                    enum: definitionTypes,
-                },
-                description: 'Allow certain definitions to be placed alongside others.',
-            },
+  type: "array",
+  maxItems: 1,
+  items: {
+    type: "object",
+    minProperties: 1,
+    additionalProperties: false,
+    properties: {
+      ignore: {
+        ...import_utils.ARRAY_DEFAULT_OPTIONS,
+        maxItems: 3,
+        // ignore all 4 types is redundant
+        items: {
+          enum: definitionTypes
         },
-    },
+        description: "Allow certain definitions to be placed alongside others."
+      }
+    }
+  }
 };
-exports.rule = {
-    meta: {
-        type: 'suggestion',
-        docs: {
-            category: 'Operations',
-            description: 'Require queries, mutations, subscriptions or fragments to be located in separate files.',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-            examples: [
-                {
-                    title: 'Incorrect',
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Operations",
+      description: "Require queries, mutations, subscriptions or fragments to be located in separate files.",
+      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+      examples: [
+        {
+          title: "Incorrect",
+          code: (
+            /* GraphQL */
+            `
             query Foo {
               id
             }
             fragment Bar on Baz {
               id
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          code: (
+            /* GraphQL */
+            `
             query Foo {
               id
             }
-          `,
-                },
-            ],
-        },
-        messages: {
-            [RULE_ID]: '{{name}} should be in a separate file.',
-        },
-        schema,
+          `
+          )
+        }
+      ]
     },
-    create(context) {
-        var _a;
-        const ignore = new Set(((_a = context.options[0]) === null || _a === void 0 ? void 0 : _a.ignore) || []);
-        const definitions = [];
-        return {
-            ':matches(OperationDefinition, FragmentDefinition)'(node) {
-                const type = 'operation' in node ? node.operation : 'fragment';
-                if (!ignore.has(type)) {
-                    definitions.push({ type, node });
-                }
-            },
-            'Document:exit'() {
-                var _a, _b;
-                for (const { node, type } of definitions.slice(1) /* ignore first definition */) {
-                    let name = (0, utils_js_1.pascalCase)(type);
-                    const definitionName = (_a = node.name) === null || _a === void 0 ? void 0 : _a.value;
-                    if (definitionName) {
-                        name += ` "${definitionName}"`;
-                    }
-                    context.report({
-                        loc: ((_b = node.name) === null || _b === void 0 ? void 0 : _b.loc) || (0, utils_js_1.getLocation)(node.loc.start, type),
-                        messageId: RULE_ID,
-                        data: { name },
-                    });
-                }
-            },
-        };
+    messages: {
+      [RULE_ID]: "{{name}} should be in a separate file."
     },
+    schema
+  },
+  create(context) {
+    const ignore = new Set(context.options[0]?.ignore || []);
+    const definitions = [];
+    return {
+      ":matches(OperationDefinition, FragmentDefinition)"(node) {
+        const type = "operation" in node ? node.operation : "fragment";
+        if (!ignore.has(type)) {
+          definitions.push({ type, node });
+        }
+      },
+      "Document:exit"() {
+        for (const { node, type } of definitions.slice(1)) {
+          let name = (0, import_utils.pascalCase)(type);
+          const definitionName = node.name?.value;
+          if (definitionName) {
+            name += ` "${definitionName}"`;
+          }
+          context.report({
+            loc: node.name?.loc || (0, import_utils.getLocation)(node.loc.start, type),
+            messageId: RULE_ID,
+            data: { name }
+          });
+        }
+      }
+    };
+  }
 };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});

package/{typings → cjs}/rules/match-document-filename.d.ts

@@ -1,7 +1,14 @@
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESLintRule } from '../types.js';
-import { CaseStyle as _CaseStyle } from '../utils.js';
-type CaseStyle = _CaseStyle | 'matchDocumentStyle';
+import { i as GraphQLESLintRule } from '../types-e3367e3c.js';
+import { CaseStyle as CaseStyle$1 } from '../utils.js';
+import '@graphql-tools/utils';
+import 'eslint';
+import 'estree';
+import 'graphql';
+import 'graphql-config';
+import '../estree-converter/types.js';
+
+type CaseStyle = CaseStyle$1 | 'matchDocumentStyle';
 declare const schema: {
     readonly definitions: {
         readonly asString: {
@@ -67,6 +74,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 };

package/cjs/rules/match-document-filename.js

@@ -1,77 +1,102 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rule = void 0;
-const path_1 = require("path");
-const graphql_1 = require("graphql");
-const utils_js_1 = require("../utils.js");
-const MATCH_EXTENSION = 'MATCH_EXTENSION';
-const MATCH_STYLE = 'MATCH_STYLE';
+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 match_document_filename_exports = {};
+__export(match_document_filename_exports, {
+  rule: () => rule
+});
+module.exports = __toCommonJS(match_document_filename_exports);
+var import_path = require("path");
+var import_graphql = require("graphql");
+var import_utils = require("../utils.js");
+const MATCH_EXTENSION = "MATCH_EXTENSION";
+const MATCH_STYLE = "MATCH_STYLE";
 const CASE_STYLES = [
-    'camelCase',
-    'PascalCase',
-    'snake_case',
-    'UPPER_CASE',
-    'kebab-case',
-    'matchDocumentStyle',
+  "camelCase",
+  "PascalCase",
+  "snake_case",
+  "UPPER_CASE",
+  "kebab-case",
+  "matchDocumentStyle"
 ];
 const schemaOption = {
-    oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
+  oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asObject" }]
 };
 const schema = {
-    definitions: {
-        asString: {
-            enum: CASE_STYLES,
-            description: `One of: ${CASE_STYLES.map(t => `\`${t}\``).join(', ')}`,
-        },
-        asObject: {
-            type: 'object',
-            additionalProperties: false,
-            minProperties: 1,
-            properties: {
-                style: { enum: CASE_STYLES },
-                suffix: { type: 'string' },
-                prefix: { type: 'string' },
-            },
-        },
-    },
-    type: 'array',
-    minItems: 1,
-    maxItems: 1,
-    items: {
-        type: 'object',
-        additionalProperties: false,
-        minProperties: 1,
-        properties: {
-            fileExtension: { enum: ['.gql', '.graphql'] },
-            query: schemaOption,
-            mutation: schemaOption,
-            subscription: schemaOption,
-            fragment: schemaOption,
-        },
+  definitions: {
+    asString: {
+      enum: CASE_STYLES,
+      description: `One of: ${CASE_STYLES.map((t) => `\`${t}\``).join(", ")}`
     },
+    asObject: {
+      type: "object",
+      additionalProperties: false,
+      minProperties: 1,
+      properties: {
+        style: { enum: CASE_STYLES },
+        suffix: { type: "string" },
+        prefix: { type: "string" }
+      }
+    }
+  },
+  type: "array",
+  minItems: 1,
+  maxItems: 1,
+  items: {
+    type: "object",
+    additionalProperties: false,
+    minProperties: 1,
+    properties: {
+      fileExtension: { enum: [".gql", ".graphql"] },
+      query: schemaOption,
+      mutation: schemaOption,
+      subscription: schemaOption,
+      fragment: schemaOption
+    }
+  }
 };
-exports.rule = {
-    meta: {
-        type: 'suggestion',
-        docs: {
-            category: 'Operations',
-            description: 'This rule allows you to enforce that the file name should match the operation name.',
-            url: 'https://the-guild.dev/graphql/eslint/rules/match-document-filename',
-            examples: [
-                {
-                    title: 'Correct',
-                    usage: [{ fileExtension: '.gql' }],
-                    code: /* GraphQL */ `
+const rule = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      category: "Operations",
+      description: "This rule allows you to enforce that the file name should match the operation name.",
+      url: "https://the-guild.dev/graphql/eslint/rules/match-document-filename",
+      examples: [
+        {
+          title: "Correct",
+          usage: [{ fileExtension: ".gql" }],
+          code: (
+            /* GraphQL */
+            `
             # user.gql
             type User {
               id: ID!
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ query: 'snake_case' }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ query: "snake_case" }],
+          code: (
+            /* GraphQL */
+            `
             # user_by_id.gql
             query UserById {
               userById(id: 5) {
@@ -80,43 +105,55 @@ exports.rule = {
                 fullName
               }
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ fragment: { style: 'kebab-case', suffix: '.fragment' } }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ fragment: { style: "kebab-case", suffix: ".fragment" } }],
+          code: (
+            /* GraphQL */
+            `
             # user-fields.fragment.gql
             fragment user_fields on User {
               id
               email
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ mutation: { style: 'PascalCase', suffix: 'Mutation' } }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ mutation: { style: "PascalCase", suffix: "Mutation" } }],
+          code: (
+            /* GraphQL */
+            `
             # DeleteUserMutation.gql
             mutation DELETE_USER {
               deleteUser(id: 5)
             }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    usage: [{ fileExtension: '.graphql' }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          usage: [{ fileExtension: ".graphql" }],
+          code: (
+            /* GraphQL */
+            `
             # post.gql
             type Post {
               id: ID!
             }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    usage: [{ query: 'PascalCase' }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Incorrect",
+          usage: [{ query: "PascalCase" }],
+          code: (
+            /* GraphQL */
+            `
             # user-by-id.gql
             query UserById {
               userById(id: 5) {
@@ -125,110 +162,120 @@ exports.rule = {
                 fullName
               }
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ fragment: { style: 'kebab-case', prefix: 'mutation.' } }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ fragment: { style: "kebab-case", prefix: "mutation." } }],
+          code: (
+            /* GraphQL */
+            `
             # mutation.add-alert.graphql
             mutation addAlert {
               foo
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ fragment: { prefix: 'query.' } }],
-                    code: /* GraphQL */ `
+          `
+          )
+        },
+        {
+          title: "Correct",
+          usage: [{ fragment: { prefix: "query." } }],
+          code: (
+            /* GraphQL */
+            `
             # query.me.graphql
             query me {
               foo
             }
-          `,
-                },
-            ],
-            configOptions: [
-                {
-                    query: 'kebab-case',
-                    mutation: 'kebab-case',
-                    subscription: 'kebab-case',
-                    fragment: 'kebab-case',
-                },
-            ],
-        },
-        messages: {
-            [MATCH_EXTENSION]: 'File extension "{{ fileExtension }}" don\'t match extension "{{ expectedFileExtension }}"',
-            [MATCH_STYLE]: 'Unexpected filename "{{ filename }}". Rename it to "{{ expectedFilename }}"',
-        },
-        schema,
-    },
-    create(context) {
-        const options = context.options[0] || {
-            fileExtension: null,
-        };
-        const filePath = context.getFilename();
-        const isVirtualFile = utils_js_1.VIRTUAL_DOCUMENT_REGEX.test(filePath);
-        if (process.env.NODE_ENV !== 'test' && isVirtualFile) {
-            // Skip validation for code files
-            return {};
+          `
+          )
         }
-        const fileExtension = (0, path_1.extname)(filePath);
-        const filename = (0, path_1.basename)(filePath, fileExtension);
-        return {
-            Document(documentNode) {
-                var _a;
-                if (options.fileExtension && options.fileExtension !== fileExtension) {
-                    context.report({
-                        loc: utils_js_1.REPORT_ON_FIRST_CHARACTER,
-                        messageId: MATCH_EXTENSION,
-                        data: {
-                            fileExtension,
-                            expectedFileExtension: options.fileExtension,
-                        },
-                    });
-                }
-                const firstOperation = documentNode.definitions.find(n => n.kind === graphql_1.Kind.OPERATION_DEFINITION);
-                const firstFragment = documentNode.definitions.find(n => n.kind === graphql_1.Kind.FRAGMENT_DEFINITION);
-                const node = firstOperation || firstFragment;
-                if (!node) {
-                    return;
-                }
-                const docName = (_a = node.name) === null || _a === void 0 ? void 0 : _a.value;
-                if (!docName) {
-                    return;
-                }
-                const docType = 'operation' in node ? node.operation : 'fragment';
-                let option = options[docType];
-                if (!option) {
-                    // Config not provided
-                    return;
-                }
-                if (typeof option === 'string') {
-                    option = { style: option };
-                }
-                const expectedExtension = options.fileExtension || fileExtension;
-                let expectedFilename = option.prefix || '';
-                if (option.style) {
-                    expectedFilename +=
-                        option.style === 'matchDocumentStyle' ? docName : (0, utils_js_1.convertCase)(option.style, docName);
-                }
-                else {
-                    expectedFilename += filename;
-                }
-                expectedFilename += (option.suffix || '') + expectedExtension;
-                const filenameWithExtension = filename + expectedExtension;
-                if (expectedFilename !== filenameWithExtension) {
-                    context.report({
-                        loc: utils_js_1.REPORT_ON_FIRST_CHARACTER,
-                        messageId: MATCH_STYLE,
-                        data: {
-                            expectedFilename,
-                            filename: filenameWithExtension,
-                        },
-                    });
-                }
-            },
-        };
+      ],
+      configOptions: [
+        {
+          query: "kebab-case",
+          mutation: "kebab-case",
+          subscription: "kebab-case",
+          fragment: "kebab-case"
+        }
+      ]
+    },
+    messages: {
+      [MATCH_EXTENSION]: `File extension "{{ fileExtension }}" don't match extension "{{ expectedFileExtension }}"`,
+      [MATCH_STYLE]: 'Unexpected filename "{{ filename }}". Rename it to "{{ expectedFilename }}"'
     },
+    schema
+  },
+  create(context) {
+    const options = context.options[0] || {
+      fileExtension: null
+    };
+    const filePath = context.getFilename();
+    const isVirtualFile = import_utils.VIRTUAL_DOCUMENT_REGEX.test(filePath);
+    if (process.env.NODE_ENV !== "test" && isVirtualFile) {
+      return {};
+    }
+    const fileExtension = (0, import_path.extname)(filePath);
+    const filename = (0, import_path.basename)(filePath, fileExtension);
+    return {
+      Document(documentNode) {
+        if (options.fileExtension && options.fileExtension !== fileExtension) {
+          context.report({
+            loc: import_utils.REPORT_ON_FIRST_CHARACTER,
+            messageId: MATCH_EXTENSION,
+            data: {
+              fileExtension,
+              expectedFileExtension: options.fileExtension
+            }
+          });
+        }
+        const firstOperation = documentNode.definitions.find(
+          (n) => n.kind === import_graphql.Kind.OPERATION_DEFINITION
+        );
+        const firstFragment = documentNode.definitions.find(
+          (n) => n.kind === import_graphql.Kind.FRAGMENT_DEFINITION
+        );
+        const node = firstOperation || firstFragment;
+        if (!node) {
+          return;
+        }
+        const docName = node.name?.value;
+        if (!docName) {
+          return;
+        }
+        const docType = "operation" in node ? node.operation : "fragment";
+        let option = options[docType];
+        if (!option) {
+          return;
+        }
+        if (typeof option === "string") {
+          option = { style: option };
+        }
+        const expectedExtension = options.fileExtension || fileExtension;
+        let expectedFilename = option.prefix || "";
+        if (option.style) {
+          expectedFilename += option.style === "matchDocumentStyle" ? docName : (0, import_utils.convertCase)(option.style, docName);
+        } else {
+          expectedFilename += filename;
+        }
+        expectedFilename += (option.suffix || "") + expectedExtension;
+        const filenameWithExtension = filename + expectedExtension;
+        if (expectedFilename !== filenameWithExtension) {
+          context.report({
+            loc: import_utils.REPORT_ON_FIRST_CHARACTER,
+            messageId: MATCH_STYLE,
+            data: {
+              expectedFilename,
+              filename: filenameWithExtension
+            }
+          });
+        }
+      }
+    };
+  }
 };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  rule
+});