@graphql-eslint/eslint-plugin 3.3.0-alpha-b07557f.0 → 3.3.0-alpha-d23e9e2.0

package/docs/rules/possible-type-extension.md

@@ -2,7 +2,7 @@
 
 - Category: `Schema`
 - Rule name: `@graphql-eslint/possible-type-extension`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A type extension is only valid if the type is defined and has the same kind.

package/graphql-config.d.ts

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

package/index.js

@@ -10,10 +10,10 @@ const fs = require('fs');
 const path = require('path');
 const utils = require('@graphql-tools/utils');
 const lowerCase = _interopDefault(require('lodash.lowercase'));
-const graphqlConfig = require('graphql-config');
-const codeFileLoader = require('@graphql-tools/code-file-loader');
 const depthLimit = _interopDefault(require('graphql-depth-limit'));
 const graphqlTagPluck = require('@graphql-tools/graphql-tag-pluck');
+const graphqlConfig = require('graphql-config');
+const codeFileLoader = require('@graphql-tools/code-file-loader');
 const eslint = require('eslint');
 const codeFrame = require('@babel/code-frame');
 
@@ -174,47 +174,6 @@ const configs = {
     'operations-all': operationsAllConfig,
 };
 
-let graphQLConfig;
-function loadCachedGraphQLConfig(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;
-    }
-    graphQLConfig = loadGraphQLConfig(options);
-    return graphQLConfig;
-}
-function loadGraphQLConfig(options) {
-    const onDiskConfig = options.skipGraphQLConfig
-        ? null
-        : graphqlConfig.loadConfigSync({
-            throwOnEmpty: false,
-            throwOnMissing: false,
-            extensions: [addCodeFileLoaderExtension],
-        });
-    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' };
-};
-
 function requireSiblingsOperations(ruleName, context) {
     if (!context.parserServices) {
         throw new Error(`Rule '${ruleName}' requires 'parserOptions.operations' to be set and loaded. See http://bit.ly/graphql-eslint-operations for more info`);
@@ -233,32 +192,6 @@ function requireGraphQLSchemaFromContext(ruleName, context) {
     }
     return context.parserServices.schema;
 }
-const schemaToExtendCache = new Map();
-function getGraphQLSchemaToExtend(context) {
-    // If parserOptions.schema not set or not loaded, there is no reason to make partial schema aka schemaToExtend
-    if (!context.parserServices.hasTypeInfo) {
-        return null;
-    }
-    const filename = context.getPhysicalFilename();
-    if (!schemaToExtendCache.has(filename)) {
-        const { schema, schemaOptions } = context.parserOptions;
-        const gqlConfig = loadGraphQLConfig({ schema });
-        const projectForFile = gqlConfig.getProjectForFile(filename);
-        let schemaToExtend;
-        try {
-            schemaToExtend = projectForFile.loadSchemaSync(projectForFile.schema, 'GraphQLSchema', {
-                ...schemaOptions,
-                ignore: filename,
-            });
-        }
-        catch (_a) {
-            // If error throws just ignore it because maybe schema is located in 1 file
-            schemaToExtend = null;
-        }
-        schemaToExtendCache.set(filename, schemaToExtend);
-    }
-    return schemaToExtendCache.get(filename);
-}
 function requireReachableTypesFromContext(ruleName, context) {
     const schema = requireGraphQLSchemaFromContext(ruleName, context);
     return context.parserServices.reachableTypes(schema);
@@ -393,7 +326,7 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(sourceNode, context, schema = null, documentNode, rule, isSchemaToExtend = false) {
+function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
     if (documentNode.definitions.length === 0) {
         return;
     }
@@ -425,7 +358,8 @@ function validateDocument(sourceNode, context, schema = null, documentNode, rule
     }
     catch (e) {
         context.report({
-            node: sourceNode,
+            // Report on first character
+            loc: { column: 0, line: 1 },
             message: e.message,
         });
     }
@@ -512,19 +446,13 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                     console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
                     return {};
                 }
-                let schema;
-                if (docs.requiresSchemaToExtend) {
-                    schema = getGraphQLSchemaToExtend(context);
-                }
-                if (docs.requiresSchema) {
-                    schema = requireGraphQLSchemaFromContext(ruleId, context);
-                }
+                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(node, context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
+                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
                     },
                 };
             },
@@ -675,6 +603,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
     recommended: false,
+    requiresSchema: true,
     requiresSchemaToExtend: true,
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
@@ -3775,6 +3704,43 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
+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({
+            throwOnEmpty: false,
+            throwOnMissing: false,
+            extensions: [addCodeFileLoaderExtension],
+        });
+    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' };
+};
+
 let reachableTypesCache;
 function getReachableTypes(schema) {
     // We don't want cache reachableTypes on test environment
@@ -3857,7 +3823,7 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadCachedGraphQLConfig(options);
+    const gqlConfig = loadGraphQLConfig(options);
     const schema = getSchema(options, gqlConfig);
     const parserServices = {
         hasTypeInfo: schema !== null,

package/index.mjs

@@ -4,10 +4,10 @@ import { statSync, existsSync, readFileSync } from 'fs';
 import { dirname, extname, basename, relative, resolve } from 'path';
 import { asArray, parseGraphQLSDL } from '@graphql-tools/utils';
 import lowerCase from 'lodash.lowercase';
-import { loadConfigSync, GraphQLConfig } from 'graphql-config';
-import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import depthLimit from 'graphql-depth-limit';
 import { parseCode } from '@graphql-tools/graphql-tag-pluck';
+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';
 
@@ -168,47 +168,6 @@ const configs = {
     'operations-all': operationsAllConfig,
 };
 
-let graphQLConfig;
-function loadCachedGraphQLConfig(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;
-    }
-    graphQLConfig = loadGraphQLConfig(options);
-    return graphQLConfig;
-}
-function loadGraphQLConfig(options) {
-    const onDiskConfig = options.skipGraphQLConfig
-        ? null
-        : loadConfigSync({
-            throwOnEmpty: false,
-            throwOnMissing: false,
-            extensions: [addCodeFileLoaderExtension],
-        });
-    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' };
-};
-
 function requireSiblingsOperations(ruleName, context) {
     if (!context.parserServices) {
         throw new Error(`Rule '${ruleName}' requires 'parserOptions.operations' to be set and loaded. See http://bit.ly/graphql-eslint-operations for more info`);
@@ -227,32 +186,6 @@ function requireGraphQLSchemaFromContext(ruleName, context) {
     }
     return context.parserServices.schema;
 }
-const schemaToExtendCache = new Map();
-function getGraphQLSchemaToExtend(context) {
-    // If parserOptions.schema not set or not loaded, there is no reason to make partial schema aka schemaToExtend
-    if (!context.parserServices.hasTypeInfo) {
-        return null;
-    }
-    const filename = context.getPhysicalFilename();
-    if (!schemaToExtendCache.has(filename)) {
-        const { schema, schemaOptions } = context.parserOptions;
-        const gqlConfig = loadGraphQLConfig({ schema });
-        const projectForFile = gqlConfig.getProjectForFile(filename);
-        let schemaToExtend;
-        try {
-            schemaToExtend = projectForFile.loadSchemaSync(projectForFile.schema, 'GraphQLSchema', {
-                ...schemaOptions,
-                ignore: filename,
-            });
-        }
-        catch (_a) {
-            // If error throws just ignore it because maybe schema is located in 1 file
-            schemaToExtend = null;
-        }
-        schemaToExtendCache.set(filename, schemaToExtend);
-    }
-    return schemaToExtendCache.get(filename);
-}
 function requireReachableTypesFromContext(ruleName, context) {
     const schema = requireGraphQLSchemaFromContext(ruleName, context);
     return context.parserServices.reachableTypes(schema);
@@ -387,7 +320,7 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(sourceNode, context, schema = null, documentNode, rule, isSchemaToExtend = false) {
+function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
     if (documentNode.definitions.length === 0) {
         return;
     }
@@ -419,7 +352,8 @@ function validateDocument(sourceNode, context, schema = null, documentNode, rule
     }
     catch (e) {
         context.report({
-            node: sourceNode,
+            // Report on first character
+            loc: { column: 0, line: 1 },
             message: e.message,
         });
     }
@@ -506,19 +440,13 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                     console.warn(`You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
                     return {};
                 }
-                let schema;
-                if (docs.requiresSchemaToExtend) {
-                    schema = getGraphQLSchemaToExtend(context);
-                }
-                if (docs.requiresSchema) {
-                    schema = requireGraphQLSchemaFromContext(ruleId, context);
-                }
+                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(node, context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
+                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
                     },
                 };
             },
@@ -669,6 +597,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
     recommended: false,
+    requiresSchema: true,
     requiresSchemaToExtend: true,
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
@@ -3769,6 +3698,43 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
+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({
+            throwOnEmpty: false,
+            throwOnMissing: false,
+            extensions: [addCodeFileLoaderExtension],
+        });
+    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' };
+};
+
 let reachableTypesCache;
 function getReachableTypes(schema) {
     // We don't want cache reachableTypes on test environment
@@ -3851,7 +3817,7 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadCachedGraphQLConfig(options);
+    const gqlConfig = loadGraphQLConfig(options);
     const schema = getSchema(options, gqlConfig);
     const parserServices = {
         hasTypeInfo: schema !== null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.3.0-alpha-b07557f.0",
+  "version": "3.3.0-alpha-d23e9e2.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/utils.d.ts

@@ -6,7 +6,6 @@ import { SiblingOperations } from './sibling-operations';
 import { UsedFields, ReachableTypes } from './graphql-ast';
 export declare function requireSiblingsOperations(ruleName: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
 export declare function requireGraphQLSchemaFromContext(ruleName: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
-export declare function getGraphQLSchemaToExtend(context: GraphQLESLintRuleContext): GraphQLSchema | null;
 export declare function requireReachableTypesFromContext(ruleName: string, context: GraphQLESLintRuleContext): ReachableTypes | never;
 export declare function requireUsedFieldsFromContext(ruleName: string, context: GraphQLESLintRuleContext): UsedFields | never;
 export declare function extractTokens(source: Source): AST.Token[];