@graphql-eslint/eslint-plugin 3.11.0-alpha-20220923194422-95bf79f → 3.11.0

package/graphql-config.d.ts

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

package/index.d.ts

@@ -4,10 +4,7 @@ export * from './testkit';
 export * from './types';
 export { requireGraphQLSchemaFromContext, requireSiblingsOperations } from './utils';
 export declare const processors: {
-    graphql: import("eslint").Linter.Processor<string | (import("eslint").Linter.ProcessorFile & {
-        lineOffset: number;
-        offset: number;
-    })>;
+    graphql: import("eslint").Linter.Processor<string | import("./processor").Block>;
 };
 export declare const configs: {
     [k: string]: {

package/index.js

@@ -5,23 +5,76 @@ Object.defineProperty(exports, '__esModule', { value: true });
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
 const graphqlTagPluck = require('@graphql-tools/graphql-tag-pluck');
+const utils = require('@graphql-tools/utils');
+const path = require('path');
+const debugFactory = _interopDefault(require('debug'));
+const graphqlConfig = require('graphql-config');
+const codeFileLoader = require('@graphql-tools/code-file-loader');
 const graphql = require('graphql');
 const validate = require('graphql/validation/validate');
 const fs = require('fs');
-const path = require('path');
 const lowerCase = _interopDefault(require('lodash.lowercase'));
 const chalk = _interopDefault(require('chalk'));
-const utils = require('@graphql-tools/utils');
 const valueFromASTUntyped = require('graphql/utilities/valueFromASTUntyped');
 const depthLimit = _interopDefault(require('graphql-depth-limit'));
-const debugFactory = _interopDefault(require('debug'));
 const fastGlob = _interopDefault(require('fast-glob'));
-const graphqlConfig = require('graphql-config');
-const codeFileLoader = require('@graphql-tools/code-file-loader');
 const eslint = require('eslint');
 const codeFrame = require('@babel/code-frame');
 
-const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];
+const debug = debugFactory('graphql-eslint:graphql-config');
+let graphQLConfig;
+function loadGraphQLConfig(options = {}) {
+    // 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) {
+        return graphQLConfig;
+    }
+    const onDiskConfig = options.skipGraphQLConfig
+        ? null
+        : graphqlConfig.loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? path.dirname(options.filePath) : undefined,
+            throwOnEmpty: false,
+            throwOnMissing: false,
+            extensions: [addCodeFileLoaderExtension],
+        });
+    debug('options.skipGraphQLConfig: %o', options.skipGraphQLConfig);
+    if (onDiskConfig) {
+        debug('Graphql-config path %o', onDiskConfig.filepath);
+    }
+    const configOptions = options.projects
+        ? { projects: options.projects }
+        : {
+            schema: (options.schema || ''),
+            documents: options.documents || options.operations,
+            extensions: options.extensions,
+            include: options.include,
+            exclude: options.exclude,
+        };
+    graphQLConfig =
+        onDiskConfig ||
+            new graphqlConfig.GraphQLConfig({
+                config: configOptions,
+                filepath: 'virtual-config',
+            }, [addCodeFileLoaderExtension]);
+    return graphQLConfig;
+}
+const addCodeFileLoaderExtension = api => {
+    api.loaders.schema.register(new codeFileLoader.CodeFileLoader());
+    api.loaders.documents.register(new codeFileLoader.CodeFileLoader());
+    return { name: 'graphql-eslint-loaders' };
+};
+
+var _a, _b;
+const graphQLTagPluckOptions = (_b = (_a = loadGraphQLConfig().getDefault()) === null || _a === void 0 ? void 0 : _a.extensions) === null || _b === void 0 ? void 0 : _b.graphqlTagPluck;
+const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = graphQLTagPluckOptions || {};
+const RELEVANT_KEYWORDS = [
+    ...new Set([
+        ...modules.map(({ identifier }) => identifier),
+        ...utils.asArray(globalGqlIdentifierName),
+        gqlMagicComment,
+    ].filter(Boolean)),
+];
 const blocksMap = new Map();
 const processor = {
     supportsAutofix: true,
@@ -33,8 +86,8 @@ const processor = {
             code,
             filePath,
             options: {
-                globalGqlIdentifierName: ['gql', 'graphql'],
                 skipIndent: true,
+                ...graphQLTagPluckOptions,
             },
         });
         const blocks = extractedDocuments.map(item => ({
@@ -4206,7 +4259,7 @@ const rules = {
 };
 
 const schemaCache = new Map();
-const debug = debugFactory('graphql-eslint:schema');
+const debug$1 = debugFactory('graphql-eslint:schema');
 function getSchema(projectForFile, options = {}) {
     const schemaKey = utils.asArray(projectForFile.schema).sort().join(',');
     if (!schemaKey) {
@@ -4217,14 +4270,14 @@ function getSchema(projectForFile, options = {}) {
     }
     let schema;
     try {
-        debug('Loading schema from %o', projectForFile.schema);
+        debug$1('Loading schema from %o', projectForFile.schema);
         schema = projectForFile.loadSchemaSync(projectForFile.schema, 'GraphQLSchema', options.schemaOptions);
-        if (debug.enabled) {
-            debug('Schema loaded: %o', schema instanceof graphql.GraphQLSchema);
+        if (debug$1.enabled) {
+            debug$1('Schema loaded: %o', schema instanceof graphql.GraphQLSchema);
             const schemaPaths = fastGlob.sync(projectForFile.schema, {
                 absolute: true,
             });
-            debug('Schema pointers %O', schemaPaths);
+            debug$1('Schema pointers %O', schemaPaths);
         }
     }
     catch (error) {
@@ -4235,7 +4288,7 @@ function getSchema(projectForFile, options = {}) {
     return schema;
 }
 
-const debug$1 = debugFactory('graphql-eslint:operations');
+const debug$2 = debugFactory('graphql-eslint:operations');
 const handleVirtualPath = (documents) => {
     const filepathMap = Object.create(null);
     return documents.map(source => {
@@ -4261,16 +4314,16 @@ const getSiblings = (projectForFile) => {
     }
     let siblings = operationsCache.get(documentsKey);
     if (!siblings) {
-        debug$1('Loading operations from %o', projectForFile.documents);
+        debug$2('Loading operations from %o', projectForFile.documents);
         const documents = projectForFile.loadDocumentsSync(projectForFile.documents, {
             skipGraphQLImport: true,
         });
-        if (debug$1.enabled) {
-            debug$1('Loaded %d operations', documents.length);
+        if (debug$2.enabled) {
+            debug$2('Loaded %d operations', documents.length);
             const operationsPaths = fastGlob.sync(projectForFile.documents, {
                 absolute: true,
             });
-            debug$1('Operations pointers %O', operationsPaths);
+            debug$2('Operations pointers %O', operationsPaths);
         }
         siblings = handleVirtualPath(documents);
         operationsCache.set(documentsKey, siblings);
@@ -4375,50 +4428,6 @@ function getSiblingOperations(projectForFile) {
     return siblingOperations;
 }
 
-const debug$2 = debugFactory('graphql-eslint:graphql-config');
-let graphQLConfig;
-function loadGraphQLConfig(options) {
-    // 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) {
-        return graphQLConfig;
-    }
-    const onDiskConfig = options.skipGraphQLConfig
-        ? null
-        : graphqlConfig.loadConfigSync({
-            // load config relative to the file being linted
-            rootDir: options.filePath ? path.dirname(options.filePath) : undefined,
-            throwOnEmpty: false,
-            throwOnMissing: false,
-            extensions: [addCodeFileLoaderExtension],
-        });
-    debug$2('options.skipGraphQLConfig: %o', options.skipGraphQLConfig);
-    if (onDiskConfig) {
-        debug$2('Graphql-config path %o', onDiskConfig.filepath);
-    }
-    const configOptions = options.projects
-        ? { projects: options.projects }
-        : {
-            schema: (options.schema || ''),
-            documents: options.documents || options.operations,
-            extensions: options.extensions,
-            include: options.include,
-            exclude: options.exclude,
-        };
-    graphQLConfig =
-        onDiskConfig ||
-            new graphqlConfig.GraphQLConfig({
-                config: configOptions,
-                filepath: 'virtual-config',
-            }, [addCodeFileLoaderExtension]);
-    return graphQLConfig;
-}
-const addCodeFileLoaderExtension = api => {
-    api.loaders.schema.register(new codeFileLoader.CodeFileLoader());
-    api.loaders.documents.register(new codeFileLoader.CodeFileLoader());
-    return { name: 'graphql-eslint-loaders' };
-};
-
 const debug$3 = debugFactory('graphql-eslint:parser');
 debug$3('cwd %o', process.cwd());
 function parseForESLint(code, options = {}) {

package/index.mjs

@@ -1,21 +1,74 @@
 import { parseCode } 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 { 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';
 import { statSync, existsSync, readFileSync } from 'fs';
-import { dirname, extname, basename, relative, resolve } from 'path';
 import lowerCase from 'lodash.lowercase';
 import chalk from 'chalk';
-import { getDocumentNodeFromSchema, asArray, parseGraphQLSDL } from '@graphql-tools/utils';
 import { valueFromASTUntyped } from 'graphql/utilities/valueFromASTUntyped';
 import depthLimit from 'graphql-depth-limit';
-import debugFactory from 'debug';
 import fastGlob from 'fast-glob';
-import { loadConfigSync, GraphQLConfig } from 'graphql-config';
-import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { RuleTester, Linter } from 'eslint';
 import { codeFrameColumns } from '@babel/code-frame';
 
-const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];
+const debug = debugFactory('graphql-eslint:graphql-config');
+let graphQLConfig;
+function loadGraphQLConfig(options = {}) {
+    // 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) {
+        return graphQLConfig;
+    }
+    const onDiskConfig = options.skipGraphQLConfig
+        ? null
+        : loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? dirname(options.filePath) : undefined,
+            throwOnEmpty: false,
+            throwOnMissing: false,
+            extensions: [addCodeFileLoaderExtension],
+        });
+    debug('options.skipGraphQLConfig: %o', options.skipGraphQLConfig);
+    if (onDiskConfig) {
+        debug('Graphql-config path %o', onDiskConfig.filepath);
+    }
+    const configOptions = options.projects
+        ? { projects: options.projects }
+        : {
+            schema: (options.schema || ''),
+            documents: options.documents || options.operations,
+            extensions: options.extensions,
+            include: options.include,
+            exclude: options.exclude,
+        };
+    graphQLConfig =
+        onDiskConfig ||
+            new GraphQLConfig({
+                config: configOptions,
+                filepath: 'virtual-config',
+            }, [addCodeFileLoaderExtension]);
+    return graphQLConfig;
+}
+const addCodeFileLoaderExtension = api => {
+    api.loaders.schema.register(new CodeFileLoader());
+    api.loaders.documents.register(new CodeFileLoader());
+    return { name: 'graphql-eslint-loaders' };
+};
+
+var _a, _b;
+const graphQLTagPluckOptions = (_b = (_a = loadGraphQLConfig().getDefault()) === null || _a === void 0 ? void 0 : _a.extensions) === null || _b === void 0 ? void 0 : _b.graphqlTagPluck;
+const { modules = [], globalGqlIdentifierName = ['gql', 'graphql'], gqlMagicComment = 'GraphQL', } = graphQLTagPluckOptions || {};
+const RELEVANT_KEYWORDS = [
+    ...new Set([
+        ...modules.map(({ identifier }) => identifier),
+        ...asArray(globalGqlIdentifierName),
+        gqlMagicComment,
+    ].filter(Boolean)),
+];
 const blocksMap = new Map();
 const processor = {
     supportsAutofix: true,
@@ -27,8 +80,8 @@ const processor = {
             code,
             filePath,
             options: {
-                globalGqlIdentifierName: ['gql', 'graphql'],
                 skipIndent: true,
+                ...graphQLTagPluckOptions,
             },
         });
         const blocks = extractedDocuments.map(item => ({
@@ -4200,7 +4253,7 @@ const rules = {
 };
 
 const schemaCache = new Map();
-const debug = debugFactory('graphql-eslint:schema');
+const debug$1 = debugFactory('graphql-eslint:schema');
 function getSchema(projectForFile, options = {}) {
     const schemaKey = asArray(projectForFile.schema).sort().join(',');
     if (!schemaKey) {
@@ -4211,14 +4264,14 @@ function getSchema(projectForFile, options = {}) {
     }
     let schema;
     try {
-        debug('Loading schema from %o', projectForFile.schema);
+        debug$1('Loading schema from %o', projectForFile.schema);
         schema = projectForFile.loadSchemaSync(projectForFile.schema, 'GraphQLSchema', options.schemaOptions);
-        if (debug.enabled) {
-            debug('Schema loaded: %o', schema instanceof GraphQLSchema);
+        if (debug$1.enabled) {
+            debug$1('Schema loaded: %o', schema instanceof GraphQLSchema);
             const schemaPaths = fastGlob.sync(projectForFile.schema, {
                 absolute: true,
             });
-            debug('Schema pointers %O', schemaPaths);
+            debug$1('Schema pointers %O', schemaPaths);
         }
     }
     catch (error) {
@@ -4229,7 +4282,7 @@ function getSchema(projectForFile, options = {}) {
     return schema;
 }
 
-const debug$1 = debugFactory('graphql-eslint:operations');
+const debug$2 = debugFactory('graphql-eslint:operations');
 const handleVirtualPath = (documents) => {
     const filepathMap = Object.create(null);
     return documents.map(source => {
@@ -4255,16 +4308,16 @@ const getSiblings = (projectForFile) => {
     }
     let siblings = operationsCache.get(documentsKey);
     if (!siblings) {
-        debug$1('Loading operations from %o', projectForFile.documents);
+        debug$2('Loading operations from %o', projectForFile.documents);
         const documents = projectForFile.loadDocumentsSync(projectForFile.documents, {
             skipGraphQLImport: true,
         });
-        if (debug$1.enabled) {
-            debug$1('Loaded %d operations', documents.length);
+        if (debug$2.enabled) {
+            debug$2('Loaded %d operations', documents.length);
             const operationsPaths = fastGlob.sync(projectForFile.documents, {
                 absolute: true,
             });
-            debug$1('Operations pointers %O', operationsPaths);
+            debug$2('Operations pointers %O', operationsPaths);
         }
         siblings = handleVirtualPath(documents);
         operationsCache.set(documentsKey, siblings);
@@ -4369,50 +4422,6 @@ function getSiblingOperations(projectForFile) {
     return siblingOperations;
 }
 
-const debug$2 = debugFactory('graphql-eslint:graphql-config');
-let graphQLConfig;
-function loadGraphQLConfig(options) {
-    // 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) {
-        return graphQLConfig;
-    }
-    const onDiskConfig = options.skipGraphQLConfig
-        ? null
-        : loadConfigSync({
-            // load config relative to the file being linted
-            rootDir: options.filePath ? dirname(options.filePath) : undefined,
-            throwOnEmpty: false,
-            throwOnMissing: false,
-            extensions: [addCodeFileLoaderExtension],
-        });
-    debug$2('options.skipGraphQLConfig: %o', options.skipGraphQLConfig);
-    if (onDiskConfig) {
-        debug$2('Graphql-config path %o', onDiskConfig.filepath);
-    }
-    const configOptions = options.projects
-        ? { projects: options.projects }
-        : {
-            schema: (options.schema || ''),
-            documents: options.documents || options.operations,
-            extensions: options.extensions,
-            include: options.include,
-            exclude: options.exclude,
-        };
-    graphQLConfig =
-        onDiskConfig ||
-            new GraphQLConfig({
-                config: configOptions,
-                filepath: 'virtual-config',
-            }, [addCodeFileLoaderExtension]);
-    return graphQLConfig;
-}
-const addCodeFileLoaderExtension = api => {
-    api.loaders.schema.register(new CodeFileLoader());
-    api.loaders.documents.register(new CodeFileLoader());
-    return { name: 'graphql-eslint-loaders' };
-};
-
 const debug$3 = debugFactory('graphql-eslint:parser');
 debug$3('cwd %o', process.cwd());
 function parseForESLint(code, options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.11.0-alpha-20220923194422-95bf79f",
+  "version": "3.11.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/processor.d.ts

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