@graphql-eslint/eslint-plugin 3.3.0-alpha-db2c2cb.0 → 3.3.0-alpha-1c01242.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,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.js

@@ -12,7 +12,7 @@ const utils = require('@graphql-tools/utils');
 const lowerCase = _interopDefault(require('lodash.lowercase'));
 const depthLimit = _interopDefault(require('graphql-depth-limit'));
 const graphqlTagPluck = require('@graphql-tools/graphql-tag-pluck');
-const graphqlConfig$1 = require('graphql-config');
+const graphqlConfig = require('graphql-config');
 const codeFileLoader = require('@graphql-tools/code-file-loader');
 const eslint = require('eslint');
 const codeFrame = require('@babel/code-frame');
@@ -326,14 +326,14 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(sourceNode, context, schema, documentNode, rule) {
+function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
     if (documentNode.definitions.length === 0) {
         return;
     }
     try {
-        const validationErrors = schema
+        const validationErrors = schema && !isSchemaToExtend
             ? graphql.validate(schema, documentNode, [rule])
-            : validate.validateSDL(documentNode, null, [rule]);
+            : validate.validateSDL(documentNode, schema, [rule]);
         for (const error of validationErrors) {
             /*
              * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
@@ -358,7 +358,8 @@ function validateDocument(sourceNode, context, schema, documentNode, rule) {
     }
     catch (e) {
         context.report({
-            node: sourceNode,
+            // Report on first character
+            loc: { column: 0, line: 1 },
             message: e.message,
         });
     }
@@ -440,18 +441,18 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                 },
             },
             create(context) {
+                if (!ruleFn) {
+                    // eslint-disable-next-line no-console
+                    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 {};
+                }
+                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
-                        if (!ruleFn) {
-                            // eslint-disable-next-line no-console
-                            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;
-                        }
-                        const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(node, context, schema, documentNode, ruleFn);
+                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
                     },
                 };
             },
@@ -601,7 +602,9 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('possible-type-extension', 'PossibleTypeExtensions', {
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
-    recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
+    recommended: false,
+    requiresSchema: true,
+    requiresSchemaToExtend: true,
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
     description: `A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.`,
@@ -3701,35 +3704,36 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
-let graphqlConfig;
-function loadGraphqlConfig(options) {
+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;
+    if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
+        return graphQLConfig;
     }
     const onDiskConfig = options.skipGraphQLConfig
         ? null
-        : graphqlConfig$1.loadConfigSync({
+        : graphqlConfig.loadConfigSync({
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],
         });
-    graphqlConfig =
+    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$1.GraphQLConfig({
-                config: options.projects
-                    ? { projects: options.projects }
-                    : {
-                        schema: (options.schema || ''),
-                        documents: options.documents || options.operations,
-                        extensions: options.extensions,
-                        include: options.include,
-                        exclude: options.exclude,
-                    },
+            new graphqlConfig.GraphQLConfig({
+                config: configOptions,
                 filepath: 'virtual-config',
             }, [addCodeFileLoaderExtension]);
-    return graphqlConfig;
+    return graphQLConfig;
 }
 const addCodeFileLoaderExtension = api => {
     api.loaders.schema.register(new codeFileLoader.CodeFileLoader());
@@ -3819,10 +3823,18 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadGraphqlConfig(options);
-    const schema = getSchema(options, gqlConfig);
+    const gqlConfig = loadGraphQLConfig(options);
+    let schema;
+    try {
+        schema = getSchema(options, gqlConfig);
+    }
+    catch (e) {
+        e.message = `[graphql-eslint] Error while loading schema: ${e.message}`;
+        // eslint-disable-next-line no-console
+        console.error(e);
+    }
     const parserServices = {
-        hasTypeInfo: schema !== null,
+        hasTypeInfo: Boolean(schema),
         schema,
         siblingOperations: getSiblingOperations(options, gqlConfig),
         reachableTypes: getReachableTypes,
@@ -3851,6 +3863,7 @@ function parseForESLint(code, options = {}) {
         };
     }
     catch (e) {
+        e.message = `[graphql-eslint] ${e.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 (e instanceof graphql.GraphQLError) {
@@ -3858,11 +3871,10 @@ function parseForESLint(code, options = {}) {
                 index: e.positions[0],
                 lineNumber: e.locations[0].line,
                 column: e.locations[0].column,
-                message: `[graphql-eslint]: ${e.message}`,
+                message: e.message,
             };
             throw eslintError;
         }
-        e.message = `[graphql-eslint]: ${e.message}`;
         throw e;
     }
 }

package/index.mjs

@@ -320,14 +320,14 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function validateDocument(sourceNode, context, schema, documentNode, rule) {
+function validateDocument(context, schema = null, documentNode, rule, isSchemaToExtend = false) {
     if (documentNode.definitions.length === 0) {
         return;
     }
     try {
-        const validationErrors = schema
+        const validationErrors = schema && !isSchemaToExtend
             ? validate(schema, documentNode, [rule])
-            : validateSDL(documentNode, null, [rule]);
+            : validateSDL(documentNode, schema, [rule]);
         for (const error of validationErrors) {
             /*
              * TODO: Fix ESTree-AST converter because currently it's incorrectly convert loc.end
@@ -352,7 +352,8 @@ function validateDocument(sourceNode, context, schema, documentNode, rule) {
     }
     catch (e) {
         context.report({
-            node: sourceNode,
+            // Report on first character
+            loc: { column: 0, line: 1 },
             message: e.message,
         });
     }
@@ -434,18 +435,18 @@ const validationToRule = (ruleId, ruleName, docs, getDocumentNode) => {
                 },
             },
             create(context) {
+                if (!ruleFn) {
+                    // eslint-disable-next-line no-console
+                    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 {};
+                }
+                const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                 return {
                     Document(node) {
-                        if (!ruleFn) {
-                            // eslint-disable-next-line no-console
-                            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;
-                        }
-                        const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
                         const documentNode = getDocumentNode
                             ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
                             : node.rawNode();
-                        validateDocument(node, context, schema, documentNode, ruleFn);
+                        validateDocument(context, schema, documentNode, ruleFn, docs.requiresSchemaToExtend);
                     },
                 };
             },
@@ -595,7 +596,9 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('possible-type-extension', 'PossibleTypeExtensions', {
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
-    recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
+    recommended: false,
+    requiresSchema: true,
+    requiresSchemaToExtend: true,
 }), validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],
     description: `A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.`,
@@ -3695,12 +3698,12 @@ function getSiblingOperations(options, gqlConfig) {
     return siblingOperations;
 }
 
-let graphqlConfig;
-function loadGraphqlConfig(options) {
+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;
+    if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
+        return graphQLConfig;
     }
     const onDiskConfig = options.skipGraphQLConfig
         ? null
@@ -3709,21 +3712,22 @@ function loadGraphqlConfig(options) {
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],
         });
-    graphqlConfig =
+    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: options.projects
-                    ? { projects: options.projects }
-                    : {
-                        schema: (options.schema || ''),
-                        documents: options.documents || options.operations,
-                        extensions: options.extensions,
-                        include: options.include,
-                        exclude: options.exclude,
-                    },
+                config: configOptions,
                 filepath: 'virtual-config',
             }, [addCodeFileLoaderExtension]);
-    return graphqlConfig;
+    return graphQLConfig;
 }
 const addCodeFileLoaderExtension = api => {
     api.loaders.schema.register(new CodeFileLoader());
@@ -3813,10 +3817,18 @@ function parse(code, options) {
     return parseForESLint(code, options).ast;
 }
 function parseForESLint(code, options = {}) {
-    const gqlConfig = loadGraphqlConfig(options);
-    const schema = getSchema(options, gqlConfig);
+    const gqlConfig = loadGraphQLConfig(options);
+    let schema;
+    try {
+        schema = getSchema(options, gqlConfig);
+    }
+    catch (e) {
+        e.message = `[graphql-eslint] Error while loading schema: ${e.message}`;
+        // eslint-disable-next-line no-console
+        console.error(e);
+    }
     const parserServices = {
-        hasTypeInfo: schema !== null,
+        hasTypeInfo: Boolean(schema),
         schema,
         siblingOperations: getSiblingOperations(options, gqlConfig),
         reachableTypes: getReachableTypes,
@@ -3845,6 +3857,7 @@ function parseForESLint(code, options = {}) {
         };
     }
     catch (e) {
+        e.message = `[graphql-eslint] ${e.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 (e instanceof GraphQLError) {
@@ -3852,11 +3865,10 @@ function parseForESLint(code, options = {}) {
                 index: e.positions[0],
                 lineNumber: e.locations[0].line,
                 column: e.locations[0].column,
-                message: `[graphql-eslint]: ${e.message}`,
+                message: e.message,
             };
             throw eslintError;
         }
-        e.message = `[graphql-eslint]: ${e.message}`;
         throw e;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.3.0-alpha-db2c2cb.0",
+  "version": "3.3.0-alpha-1c01242.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
@@ -10,7 +10,7 @@
     "@babel/code-frame": "7.16.0",
     "@graphql-tools/code-file-loader": "7.2.3",
     "@graphql-tools/graphql-tag-pluck": "7.1.4",
-    "@graphql-tools/utils": "8.5.4",
+    "@graphql-tools/utils": "8.5.5",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",
     "lodash.lowercase": "4.3.0"
@@ -31,6 +31,7 @@
     "definition": "index.d.ts"
   },
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "require": "./index.js",
       "import": "./index.mjs"

package/types.d.ts

@@ -51,6 +51,7 @@ export declare type RuleDocsInfo<T> = {
         category: CategoryType | CategoryType[];
         requiresSchema?: true;
         requiresSiblings?: true;
+        requiresSchemaToExtend?: true;
         examples?: {
             title: string;
             code: string;