@graphql-eslint/eslint-plugin 3.12.0-alpha-20220929104135-4ef9ac0 → 3.12.0-alpha-20221008232037-33da317

package/graphql-config.d.ts

@@ -1,4 +1,4 @@
 import { GraphQLConfig } from 'graphql-config';
 import { ParserOptions } from './types';
 export declare function loadOnDiskGraphQLConfig(filePath: string): GraphQLConfig;
-export declare function loadGraphQLConfig(options?: ParserOptions): GraphQLConfig;
+export declare function loadGraphQLConfig(options: ParserOptions): GraphQLConfig;

package/index.js

@@ -24,15 +24,24 @@ const codeFrame = require('@babel/code-frame');
 const debug = debugFactory('graphql-eslint:graphql-config');
 let graphQLConfig;
 function loadOnDiskGraphQLConfig(filePath) {
-    return graphqlConfig.loadConfigSync({
+    const rootDir = path.dirname(filePath);
+    const config = graphqlConfig.loadConfigSync({
         // load config relative to the file being linted
-        rootDir: filePath ? path.dirname(filePath) : undefined,
+        rootDir,
         throwOnEmpty: false,
         throwOnMissing: false,
-        extensions: [addCodeFileLoaderExtension],
+    });
+    if (!config) {
+        return null;
+    }
+    const project = config.getProjectForFile(filePath);
+    return graphqlConfig.loadConfigSync({
+        rootDir,
+        extensions: [codeFileLoaderExtension(project.extensions.pluckConfig)],
     });
 }
-function loadGraphQLConfig(options = {}) {
+function loadGraphQLConfig(options) {
+    var _a;
     // We don't want cache config on test environment
     // Otherwise schema and documents will be same for all tests
     if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
@@ -57,53 +66,56 @@ function loadGraphQLConfig(options = {}) {
             new graphqlConfig.GraphQLConfig({
                 config: configOptions,
                 filepath: 'virtual-config',
-            }, [addCodeFileLoaderExtension]);
+            }, [codeFileLoaderExtension((_a = options.extensions) === null || _a === void 0 ? void 0 : _a.pluckConfig)]);
     return graphQLConfig;
 }
-const addCodeFileLoaderExtension = api => {
-    api.loaders.schema.register(new codeFileLoader.CodeFileLoader());
-    api.loaders.documents.register(new codeFileLoader.CodeFileLoader());
+const codeFileLoaderExtension = (pluckConfig) => api => {
+    const { schema, documents } = api.loaders;
+    schema.register(new codeFileLoader.CodeFileLoader({ pluckConfig }));
+    documents.register(new codeFileLoader.CodeFileLoader({ pluckConfig }));
     return { name: 'graphql-eslint-loaders' };
 };
 
 const blocksMap = new Map();
 let onDiskConfig;
+let pluckConfig;
+let RELEVANT_KEYWORDS;
 const processor = {
     supportsAutofix: true,
     preprocess(code, filePath) {
-        var _a, _b, _c;
-        onDiskConfig || (onDiskConfig = loadOnDiskGraphQLConfig(filePath));
-        const graphQLTagPluckOptions = (_c = (_b = (_a = onDiskConfig === null || onDiskConfig === void 0 ? void 0 : onDiskConfig.getProjectForFile) === null || _a === void 0 ? void 0 : _a.call(onDiskConfig, filePath)) === null || _b === void 0 ? void 0 : _b.extensions) === null || _c === void 0 ? void 0 : _c.graphqlTagPluck;
-        const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = graphQLTagPluckOptions || {};
-        const RELEVANT_KEYWORDS = [
-            ...new Set([
-                ...modules.map(({ identifier }) => identifier),
-                ...utils.asArray(globalGqlIdentifierName),
+        if (!pluckConfig) {
+            onDiskConfig = loadOnDiskGraphQLConfig(filePath);
+            const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = (onDiskConfig === null || onDiskConfig === void 0 ? void 0 : onDiskConfig.getProjectForFile(filePath).extensions.pluckConfig) || {};
+            pluckConfig = {
+                skipIndent: true,
+                modules,
+                globalGqlIdentifierName,
                 gqlMagicComment,
-            ].filter(Boolean)),
-        ];
+            };
+            RELEVANT_KEYWORDS = [
+                ...new Set([
+                    ...modules.map(({ identifier }) => identifier),
+                    ...utils.asArray(globalGqlIdentifierName),
+                    gqlMagicComment,
+                ].filter(Boolean)),
+            ];
+        }
         if (RELEVANT_KEYWORDS.every(keyword => !code.includes(keyword))) {
             return [code];
         }
         try {
-            const extractedDocuments = graphqlTagPluck.parseCode({
-                code,
-                filePath,
-                options: {
-                    skipIndent: true,
-                    ...graphQLTagPluckOptions,
-                },
-            });
-            const blocks = extractedDocuments.map(item => ({
+            const sources = graphqlTagPluck.gqlPluckFromCodeStringSync(filePath, code, pluckConfig);
+            const blocks = sources.map(item => ({
                 filename: 'document.graphql',
-                text: item.content,
-                lineOffset: item.loc.start.line - 1,
-                offset: item.start + 1,
+                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 (_d) {
+        catch (_a) {
             // in case of parsing error return code as is
             return [code];
         }
@@ -776,14 +788,6 @@ const rule = {
                         description: 'Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.',
                         default: false,
                     },
-                    ignorePrefix: {
-                        type: 'array',
-                        default: [],
-                    },
-                    ignoreSuffix: {
-                        type: 'array',
-                        default: [],
-                    },
                 },
             },
         },
@@ -842,18 +846,6 @@ const rule = {
                 const prevName = ('alias' in prevNode && ((_c = prevNode.alias) === null || _c === void 0 ? void 0 : _c.value)) ||
                     ('name' in prevNode && ((_d = prevNode.name) === null || _d === void 0 ? void 0 : _d.value));
                 if (prevName) {
-                    if ((opts.ignorePrefix || []).length > 0) {
-                        const shouldSkipIgnorePrefix = opts.ignorePrefix.some(prefix => prefix === prevName || prefix === currName || prevName.startsWith(prefix) || currName.startsWith(prefix));
-                        if (shouldSkipIgnorePrefix) {
-                            continue;
-                        }
-                    }
-                    if ((opts.ignoreSuffix || []).length > 0) {
-                        const shouldSkipIgnoreSuffix = opts.ignoreSuffix.some(suffix => suffix === prevName || suffix === currName || prevName.endsWith(suffix) || currName.endsWith(suffix));
-                        if (shouldSkipIgnoreSuffix) {
-                            continue;
-                        }
-                    }
                     // Compare with lexicographic order
                     const compareResult = prevName.localeCompare(currName);
                     const shouldSort = compareResult === 1;
@@ -4461,10 +4453,10 @@ function getSiblingOperations(projectForFile) {
 
 const debug$3 = debugFactory('graphql-eslint:parser');
 debug$3('cwd %o', process.cwd());
-function parseForESLint(code, options = {}) {
+function parseForESLint(code, options) {
     try {
-        const filePath = options.filePath || '';
-        const realFilepath = filePath && getOnDiskFilepath(filePath);
+        const { filePath } = options;
+        const realFilepath = getOnDiskFilepath(filePath);
         const gqlConfig = loadGraphQLConfig(options);
         const projectForFile = realFilepath
             ? gqlConfig.getProjectForFile(realFilepath)

package/index.mjs

@@ -1,8 +1,8 @@
-import { parseCode } from '@graphql-tools/graphql-tag-pluck';
+import { gqlPluckFromCodeStringSync } from '@graphql-tools/graphql-tag-pluck';
 import { asArray, getDocumentNodeFromSchema, parseGraphQLSDL } from '@graphql-tools/utils';
 import { dirname, extname, basename, relative, resolve } from 'path';
 import debugFactory from 'debug';
-import { loadConfigSync, GraphQLConfig } from 'graphql-config';
+import { GraphQLConfig, loadConfigSync } from 'graphql-config';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { Kind, visit, validate, TokenKind, isScalarType, DirectiveLocation, isInterfaceType, TypeInfo, visitWithTypeInfo, isObjectType as isObjectType$1, Source, isNonNullType, isListType, GraphQLObjectType, GraphQLInterfaceType, GraphQLSchema, GraphQLError } from 'graphql';
 import { validateSDL } from 'graphql/validation/validate';
@@ -18,15 +18,24 @@ import { codeFrameColumns } from '@babel/code-frame';
 const debug = debugFactory('graphql-eslint:graphql-config');
 let graphQLConfig;
 function loadOnDiskGraphQLConfig(filePath) {
-    return loadConfigSync({
+    const rootDir = dirname(filePath);
+    const config = loadConfigSync({
         // load config relative to the file being linted
-        rootDir: filePath ? dirname(filePath) : undefined,
+        rootDir,
         throwOnEmpty: false,
         throwOnMissing: false,
-        extensions: [addCodeFileLoaderExtension],
+    });
+    if (!config) {
+        return null;
+    }
+    const project = config.getProjectForFile(filePath);
+    return loadConfigSync({
+        rootDir,
+        extensions: [codeFileLoaderExtension(project.extensions.pluckConfig)],
     });
 }
-function loadGraphQLConfig(options = {}) {
+function loadGraphQLConfig(options) {
+    var _a;
     // We don't want cache config on test environment
     // Otherwise schema and documents will be same for all tests
     if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
@@ -51,53 +60,56 @@ function loadGraphQLConfig(options = {}) {
             new GraphQLConfig({
                 config: configOptions,
                 filepath: 'virtual-config',
-            }, [addCodeFileLoaderExtension]);
+            }, [codeFileLoaderExtension((_a = options.extensions) === null || _a === void 0 ? void 0 : _a.pluckConfig)]);
     return graphQLConfig;
 }
-const addCodeFileLoaderExtension = api => {
-    api.loaders.schema.register(new CodeFileLoader());
-    api.loaders.documents.register(new CodeFileLoader());
+const codeFileLoaderExtension = (pluckConfig) => api => {
+    const { schema, documents } = api.loaders;
+    schema.register(new CodeFileLoader({ pluckConfig }));
+    documents.register(new CodeFileLoader({ pluckConfig }));
     return { name: 'graphql-eslint-loaders' };
 };
 
 const blocksMap = new Map();
 let onDiskConfig;
+let pluckConfig;
+let RELEVANT_KEYWORDS;
 const processor = {
     supportsAutofix: true,
     preprocess(code, filePath) {
-        var _a, _b, _c;
-        onDiskConfig || (onDiskConfig = loadOnDiskGraphQLConfig(filePath));
-        const graphQLTagPluckOptions = (_c = (_b = (_a = onDiskConfig === null || onDiskConfig === void 0 ? void 0 : onDiskConfig.getProjectForFile) === null || _a === void 0 ? void 0 : _a.call(onDiskConfig, filePath)) === null || _b === void 0 ? void 0 : _b.extensions) === null || _c === void 0 ? void 0 : _c.graphqlTagPluck;
-        const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = graphQLTagPluckOptions || {};
-        const RELEVANT_KEYWORDS = [
-            ...new Set([
-                ...modules.map(({ identifier }) => identifier),
-                ...asArray(globalGqlIdentifierName),
+        if (!pluckConfig) {
+            onDiskConfig = loadOnDiskGraphQLConfig(filePath);
+            const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = (onDiskConfig === null || onDiskConfig === void 0 ? void 0 : onDiskConfig.getProjectForFile(filePath).extensions.pluckConfig) || {};
+            pluckConfig = {
+                skipIndent: true,
+                modules,
+                globalGqlIdentifierName,
                 gqlMagicComment,
-            ].filter(Boolean)),
-        ];
+            };
+            RELEVANT_KEYWORDS = [
+                ...new Set([
+                    ...modules.map(({ identifier }) => identifier),
+                    ...asArray(globalGqlIdentifierName),
+                    gqlMagicComment,
+                ].filter(Boolean)),
+            ];
+        }
         if (RELEVANT_KEYWORDS.every(keyword => !code.includes(keyword))) {
             return [code];
         }
         try {
-            const extractedDocuments = parseCode({
-                code,
-                filePath,
-                options: {
-                    skipIndent: true,
-                    ...graphQLTagPluckOptions,
-                },
-            });
-            const blocks = extractedDocuments.map(item => ({
+            const sources = gqlPluckFromCodeStringSync(filePath, code, pluckConfig);
+            const blocks = sources.map(item => ({
                 filename: 'document.graphql',
-                text: item.content,
-                lineOffset: item.loc.start.line - 1,
-                offset: item.start + 1,
+                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 (_d) {
+        catch (_a) {
             // in case of parsing error return code as is
             return [code];
         }
@@ -770,14 +782,6 @@ const rule = {
                         description: 'Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.',
                         default: false,
                     },
-                    ignorePrefix: {
-                        type: 'array',
-                        default: [],
-                    },
-                    ignoreSuffix: {
-                        type: 'array',
-                        default: [],
-                    },
                 },
             },
         },
@@ -836,18 +840,6 @@ const rule = {
                 const prevName = ('alias' in prevNode && ((_c = prevNode.alias) === null || _c === void 0 ? void 0 : _c.value)) ||
                     ('name' in prevNode && ((_d = prevNode.name) === null || _d === void 0 ? void 0 : _d.value));
                 if (prevName) {
-                    if ((opts.ignorePrefix || []).length > 0) {
-                        const shouldSkipIgnorePrefix = opts.ignorePrefix.some(prefix => prefix === prevName || prefix === currName || prevName.startsWith(prefix) || currName.startsWith(prefix));
-                        if (shouldSkipIgnorePrefix) {
-                            continue;
-                        }
-                    }
-                    if ((opts.ignoreSuffix || []).length > 0) {
-                        const shouldSkipIgnoreSuffix = opts.ignoreSuffix.some(suffix => suffix === prevName || suffix === currName || prevName.endsWith(suffix) || currName.endsWith(suffix));
-                        if (shouldSkipIgnoreSuffix) {
-                            continue;
-                        }
-                    }
                     // Compare with lexicographic order
                     const compareResult = prevName.localeCompare(currName);
                     const shouldSort = compareResult === 1;
@@ -4455,10 +4447,10 @@ function getSiblingOperations(projectForFile) {
 
 const debug$3 = debugFactory('graphql-eslint:parser');
 debug$3('cwd %o', process.cwd());
-function parseForESLint(code, options = {}) {
+function parseForESLint(code, options) {
     try {
-        const filePath = options.filePath || '';
-        const realFilepath = filePath && getOnDiskFilepath(filePath);
+        const { filePath } = options;
+        const realFilepath = getOnDiskFilepath(filePath);
         const gqlConfig = loadGraphQLConfig(options);
         const projectForFile = realFilepath
             ? gqlConfig.getProjectForFile(realFilepath)

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.12.0-alpha-20220929104135-4ef9ac0",
+  "version": "3.12.0-alpha-20221008232037-33da317",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@babel/code-frame": "^7.16.7",
-    "@graphql-tools/code-file-loader": "^7.2.14",
-    "@graphql-tools/graphql-tag-pluck": "^7.2.6",
-    "@graphql-tools/utils": "^8.6.9",
+    "@babel/code-frame": "^7.18.6",
+    "@graphql-tools/code-file-loader": "^7.3.6",
+    "@graphql-tools/graphql-tag-pluck": "^7.3.6",
+    "@graphql-tools/utils": "^8.12.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
-    "fast-glob": "^3.2.11",
-    "graphql-config": "^4.3.0",
+    "fast-glob": "^3.2.12",
+    "graphql-config": "^4.3.5",
     "graphql-depth-limit": "^1.1.0",
     "lodash.lowercase": "^4.3.0"
   },

package/parser.d.ts

@@ -1,2 +1,2 @@
 import { GraphQLESLintParseResult, ParserOptions } from './types';
-export declare function parseForESLint(code: string, options?: ParserOptions): GraphQLESLintParseResult;
+export declare function parseForESLint(code: string, options: ParserOptions): GraphQLESLintParseResult;

package/rules/alphabetize.d.ts

@@ -11,8 +11,6 @@ export declare type AlphabetizeConfig = {
     variables?: typeof variablesEnum;
     arguments?: typeof argumentsEnum;
     definitions?: boolean;
-    ignorePrefix?: string[];
-    ignoreSuffix?: string[];
 };
 declare const rule: GraphQLESLintRule<[AlphabetizeConfig]>;
 export default rule;

package/schema.d.ts

@@ -1,3 +1,3 @@
 import { GraphQLProjectConfig } from 'graphql-config';
 import type { ParserOptions, Schema } from './types';
-export declare function getSchema(projectForFile: GraphQLProjectConfig, options?: ParserOptions): Schema;
+export declare function getSchema(projectForFile: GraphQLProjectConfig, options?: Omit<ParserOptions, 'filePath'>): Schema;

package/testkit.d.ts

@@ -16,9 +16,9 @@ export declare type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
 export declare class GraphQLRuleTester extends RuleTester {
     config: {
         parser: string;
-        parserOptions: ParserOptions;
+        parserOptions: Omit<ParserOptions, 'filePath'>;
     };
-    constructor(parserOptions?: ParserOptions);
+    constructor(parserOptions?: Omit<ParserOptions, 'filePath'>);
     fromMockFile(path: string): string;
     runGraphQLTests<Options, WithTypeInfo extends boolean = false>(ruleId: string, rule: GraphQLESLintRule<Options, WithTypeInfo>, tests: {
         valid: (string | GraphQLValidTestCase<Options>)[];

package/types.d.ts

@@ -22,7 +22,7 @@ export interface ParserOptions {
     };
     graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
     skipGraphQLConfig?: boolean;
-    filePath?: string;
+    filePath: string;
 }
 export declare type ParserServices = {
     schema: Schema;