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

package/esm/parser.js

@@ -1,77 +1,68 @@
-import { parseGraphQLSDL } from '@graphql-tools/utils';
-import debugFactory from 'debug';
-import { buildSchema, GraphQLError } from 'graphql';
-import { convertToESTree, extractComments, extractTokens } from './estree-converter/index.js';
-import { loadGraphQLConfig } from './graphql-config.js';
-import { getSchema } from './schema.js';
-import { getSiblings } from './siblings.js';
-import { CWD, VIRTUAL_DOCUMENT_REGEX } from './utils.js';
-const debug = debugFactory('graphql-eslint:parser');
-debug('cwd %o', CWD);
-export function parseForESLint(code, options) {
-    var _a, _b;
+import { parseGraphQLSDL } from "@graphql-tools/utils";
+import debugFactory from "debug";
+import { buildSchema, GraphQLError } from "graphql";
+import { convertToESTree, extractComments, extractTokens } from "./estree-converter/index.js";
+import { loadGraphQLConfig } from "./graphql-config.js";
+import { getSchema } from "./schema.js";
+import { getSiblings } from "./siblings.js";
+import { CWD, VIRTUAL_DOCUMENT_REGEX } from "./utils.js";
+const debug = debugFactory("graphql-eslint:parser");
+debug("cwd %o", CWD);
+function parseForESLint(code, options) {
+  try {
+    const { filePath } = options;
+    options.documents ||= options.operations;
+    const { document } = parseGraphQLSDL(filePath, code, {
+      ...options.graphQLParserOptions,
+      noLocation: false
+    });
+    const gqlConfig = loadGraphQLConfig(options);
+    const realFilepath = filePath.replace(VIRTUAL_DOCUMENT_REGEX, "");
+    const project = gqlConfig.getProjectForFile(realFilepath);
+    let schema = null;
     try {
-        const { filePath } = options;
-        // TODO: remove in graphql-eslint v4
-        options.documents || (options.documents = options.operations);
-        // First parse code from file, in case of syntax error do not try load schema,
-        // documents or even graphql-config instance
-        const { document } = parseGraphQLSDL(filePath, code, {
-            ...options.graphQLParserOptions,
-            noLocation: false,
-        });
-        const gqlConfig = loadGraphQLConfig(options);
-        const realFilepath = filePath.replace(VIRTUAL_DOCUMENT_REGEX, '');
-        const project = gqlConfig.getProjectForFile(realFilepath);
-        let schema = null;
-        try {
-            schema = project
-                ? getSchema(project, options.schemaOptions)
-                : typeof options.schema === 'string'
-                    ? buildSchema(options.schema)
-                    : null;
-        }
-        catch (error) {
-            if (error instanceof Error) {
-                error.message = `Error while loading schema: ${error.message}`;
-            }
-            throw error;
-        }
-        const rootTree = convertToESTree(document, schema);
-        return {
-            services: {
-                schema,
-                siblingOperations: getSiblings(project, options.documents),
-            },
-            ast: {
-                comments: extractComments(document.loc),
-                tokens: extractTokens(filePath, code),
-                loc: rootTree.loc,
-                range: rootTree.range,
-                type: 'Program',
-                sourceType: 'script',
-                body: [rootTree],
-            },
-        };
+      schema = project ? getSchema(project, options.schemaOptions) : typeof options.schema === "string" ? buildSchema(options.schema) : null;
+    } catch (error) {
+      if (error instanceof Error) {
+        error.message = `Error while loading schema: ${error.message}`;
+      }
+      throw error;
     }
-    catch (error) {
-        if (error instanceof Error) {
-            error.message = `[graphql-eslint] ${error.message}`;
-        }
-        // In case of GraphQL parser error, we report it to ESLint as a parser error that matches the requirements
-        // of ESLint. This will make sure to display it correctly in IDEs and lint results.
-        if (error instanceof GraphQLError) {
-            const location = (_a = error.locations) === null || _a === void 0 ? void 0 : _a[0];
-            const eslintError = {
-                index: (_b = error.positions) === null || _b === void 0 ? void 0 : _b[0],
-                ...(location && {
-                    lineNumber: location.line,
-                    column: location.column - 1,
-                }),
-                message: error.message,
-            };
-            throw eslintError;
-        }
-        throw error;
+    const rootTree = convertToESTree(document, schema);
+    return {
+      services: {
+        schema,
+        siblingOperations: getSiblings(project, options.documents)
+      },
+      ast: {
+        comments: extractComments(document.loc),
+        tokens: extractTokens(filePath, code),
+        loc: rootTree.loc,
+        range: rootTree.range,
+        type: "Program",
+        sourceType: "script",
+        body: [rootTree]
+      }
+    };
+  } catch (error) {
+    if (error instanceof Error) {
+      error.message = `[graphql-eslint] ${error.message}`;
     }
+    if (error instanceof GraphQLError) {
+      const location = error.locations?.[0];
+      const eslintError = {
+        index: error.positions?.[0],
+        ...location && {
+          lineNumber: location.line,
+          column: location.column - 1
+        },
+        message: error.message
+      };
+      throw eslintError;
+    }
+    throw error;
+  }
 }
+export {
+  parseForESLint
+};

package/esm/processor.d.mts

@@ -0,0 +1,9 @@
+import { Linter } from 'eslint';
+
+type Block = Linter.ProcessorFile & {
+    lineOffset: number;
+    offset: number;
+};
+declare const processor: Linter.Processor<Block | string>;
+
+export { Block, processor };

package/esm/processor.js

@@ -1,93 +1,105 @@
-import { relative } from '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 = new Map();
+import { relative } from "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;
 let onDiskConfigLoaded = false;
-const RELEVANT_KEYWORDS = ['gql', 'graphql', 'GraphQL'];
-export const processor = {
-    supportsAutofix: true,
-    preprocess(code, filePath) {
-        if (!onDiskConfigLoaded) {
-            onDiskConfig = loadOnDiskGraphQLConfig(filePath);
-            onDiskConfigLoaded = true;
+const RELEVANT_KEYWORDS = ["gql", "graphql", "GraphQL"];
+const processor = {
+  supportsAutofix: true,
+  preprocess(code, filePath) {
+    if (!onDiskConfigLoaded) {
+      onDiskConfig = loadOnDiskGraphQLConfig(filePath);
+      onDiskConfigLoaded = true;
+    }
+    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 sources = gqlPluckFromCodeStringSync(filePath, code, {
+        skipIndent: true,
+        ...pluckConfig
+      });
+      const blocks = sources.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
+      }));
+      blocksMap.set(filePath, blocks);
+      return [
+        ...blocks,
+        code
+        /* source code must be provided and be last */
+      ];
+    } catch (error) {
+      if (error instanceof Error) {
+        error.message = `[graphql-eslint] Error while preprocessing "${relative(
+          CWD,
+          filePath
+        )}" file
+
+${error.message}`;
+      }
+      console.error(error);
+      return [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] || []) {
+        const isVueOrSvelte = /\.(vue|svelte)$/.test(filePath);
+        if (isVueOrSvelte) {
+          delete message.endLine;
+          delete message.endColumn;
+          delete message.fix;
+          delete message.suggestions;
+          Object.assign(message, REPORT_ON_FIRST_CHARACTER);
+          continue;
         }
-        let keywords = RELEVANT_KEYWORDS;
-        const pluckConfig = onDiskConfig === null || onDiskConfig === void 0 ? void 0 : 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)),
-            ];
+        message.line += lineOffset;
+        if (typeof message.endLine === "number") {
+          message.endLine += lineOffset;
         }
-        if (keywords.every(keyword => !code.includes(keyword))) {
-            return [code];
+        if (message.fix) {
+          message.fix.range[0] += offset;
+          message.fix.range[1] += offset;
         }
-        try {
-            const sources = gqlPluckFromCodeStringSync(filePath, code, {
-                skipIndent: true,
-                ...pluckConfig,
-            });
-            const blocks = sources.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,
-            }));
-            blocksMap.set(filePath, blocks);
-            return [...blocks, code /* source code must be provided and be last */];
+        for (const suggestion of message.suggestions || []) {
+          const [start, end] = suggestion.fix.range;
+          suggestion.fix.range = [start + offset, end + offset];
         }
-        catch (error) {
-            if (error instanceof Error) {
-                error.message = `[graphql-eslint] Error while preprocessing "${relative(CWD, filePath)}" file\n\n${error.message}`;
-            }
-            // eslint-disable-next-line no-console
-            console.error(error);
-            // in case of parsing error return code as is
-            return [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] || []) {
-                const isVueOrSvelte = /\.(vue|svelte)$/.test(filePath);
-                if (isVueOrSvelte) {
-                    // We can't show correct report location because after processing with
-                    // graphql-tag-pluck location is incorrect, disable fixes as well
-                    delete message.endLine;
-                    delete message.endColumn;
-                    delete message.fix;
-                    delete message.suggestions;
-                    Object.assign(message, REPORT_ON_FIRST_CHARACTER);
-                    continue;
-                }
-                message.line += lineOffset;
-                // endLine can not exist if only `loc: { start, column }` was provided to context.report
-                if (typeof message.endLine === 'number') {
-                    message.endLine += lineOffset;
-                }
-                if (message.fix) {
-                    message.fix.range[0] += offset;
-                    message.fix.range[1] += offset;
-                }
-                for (const suggestion of message.suggestions || []) {
-                    // DO NOT mutate until https://github.com/eslint/eslint/issues/16716
-                    const [start, end] = suggestion.fix.range;
-                    suggestion.fix.range = [start + offset, end + offset];
-                }
-            }
-        }
-        const result = messages.flat();
-        // sort eslint/graphql-eslint messages by line/column
-        return result.sort((a, b) => a.line - b.line || a.column - b.column);
-    },
+      }
+    }
+    const result = messages.flat();
+    return result.sort((a, b) => a.line - b.line || a.column - b.column);
+  }
+};
+export {
+  processor
 };

package/{typings/rules/alphabetize.d.cts → esm/rules/alphabetize.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;
@@ -71,6 +78,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 };