@graphql-eslint/eslint-plugin 3.0.1 → 3.2.0-alpha-2e742a6.0

package/index.js

@@ -6,7 +6,6 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau
 
 const graphql = require('graphql');
 const validate = require('graphql/validation/validate');
-const _import = require('@graphql-tools/import');
 const fs = require('fs');
 const path = require('path');
 const utils = require('@graphql-tools/utils');
@@ -335,34 +334,75 @@ function getLocation(loc, fieldName = '', offset) {
     };
 }
 
-function extractRuleName(stack) {
-    const match = (stack || '').match(/validation[/\\]rules[/\\](.*?)\.js:/) || [];
-    return match[1] || null;
-}
-function validateDoc(sourceNode, context, schema, documentNode, rules, ruleName = null) {
-    var _a;
-    if (((_a = documentNode === null || documentNode === void 0 ? void 0 : documentNode.definitions) === null || _a === void 0 ? void 0 : _a.length) > 0) {
-        try {
-            const validationErrors = schema ? graphql.validate(schema, documentNode, rules) : validate.validateSDL(documentNode, null, rules);
-            for (const error of validationErrors) {
-                const validateRuleName = ruleName || `[${extractRuleName(error.stack)}]`;
-                context.report({
-                    loc: getLocation({ start: error.locations[0] }),
-                    message: ruleName ? error.message : `${validateRuleName} ${error.message}`,
-                });
-            }
-        }
-        catch (e) {
+function validateDoc(sourceNode, context, schema, documentNode, rule) {
+    if (documentNode.definitions.length === 0) {
+        return;
+    }
+    try {
+        const validationErrors = schema
+            ? graphql.validate(schema, documentNode, [rule])
+            : validate.validateSDL(documentNode, null, [rule]);
+        for (const error of validationErrors) {
             context.report({
-                node: sourceNode,
-                message: e.message,
+                loc: getLocation({ start: error.locations[0] }),
+                message: error.message,
             });
         }
     }
+    catch (e) {
+        context.report({
+            node: sourceNode,
+            message: e.message,
+        });
+    }
 }
-const isGraphQLImportFile = rawSDL => {
-    const trimmedRawSDL = rawSDL.trimLeft();
-    return trimmedRawSDL.startsWith('# import') || trimmedRawSDL.startsWith('#import');
+const getFragmentDefsAndFragmentSpreads = (schema, node) => {
+    const typeInfo = new graphql.TypeInfo(schema);
+    const fragmentDefs = new Set();
+    const fragmentSpreads = new Set();
+    const visitor = graphql.visitWithTypeInfo(typeInfo, {
+        FragmentDefinition(node) {
+            fragmentDefs.add(`${node.name.value}:${node.typeCondition.name.value}`);
+        },
+        FragmentSpread(node) {
+            const fieldDef = typeInfo.getFieldDef();
+            if (fieldDef) {
+                fragmentSpreads.add(`${node.name.value}:${typeInfo.getParentType().name}`);
+            }
+        },
+    });
+    graphql.visit(node, visitor);
+    return { fragmentDefs, fragmentSpreads };
+};
+const getMissingFragments = (schema, node) => {
+    const { fragmentDefs, fragmentSpreads } = getFragmentDefsAndFragmentSpreads(schema, node);
+    return [...fragmentSpreads].filter(name => !fragmentDefs.has(name));
+};
+const handleMissingFragments = ({ schema, node, ruleId, context }) => {
+    const missingFragments = getMissingFragments(schema, node);
+    if (missingFragments.length > 0) {
+        const siblings = requireSiblingsOperations(ruleId, context);
+        const fragmentsToAdd = [];
+        for (const missingFragment of missingFragments) {
+            const [fragmentName, fragmentTypeName] = missingFragment.split(':');
+            const fragments = siblings
+                .getFragment(fragmentName)
+                .map(source => source.document)
+                .filter(fragment => fragment.typeCondition.name.value === fragmentTypeName);
+            if (fragments.length > 1) {
+                // eslint-disable-next-line no-console
+                console.warn(`You have ${fragments.length} fragments that have same name ${fragmentName} and same type ${fragmentTypeName}. That can provoke unexpected result for "${ruleId}" rule.`);
+            }
+            fragmentsToAdd.push(fragments[0]);
+        }
+        if (fragmentsToAdd.length > 0) {
+            return {
+                kind: graphql.Kind.DOCUMENT,
+                definitions: [...node.definitions, ...fragmentsToAdd],
+            };
+        }
+    }
+    return node;
 };
 const validationToRule = (name, ruleName, docs, getDocumentNode) => {
     var _a;
@@ -370,11 +410,11 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
     try {
         ruleFn = require(`graphql/validation/rules/${ruleName}Rule`)[`${ruleName}Rule`];
     }
-    catch (e) {
+    catch (_b) {
         try {
             ruleFn = require(`graphql/validation/rules/${ruleName}`)[`${ruleName}Rule`];
         }
-        catch (e) {
+        catch (_c) {
             ruleFn = require('graphql/validation')[`${ruleName}Rule`];
         }
     }
@@ -396,30 +436,25 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
                     Document(node) {
                         if (!ruleFn) {
                             // eslint-disable-next-line no-console
-                            console.warn(`You rule "${name}" depends on a GraphQL validation rule ("${ruleName}") but it's not available in the "graphql-js" version you are using. Skipping...`);
+                            console.warn(`You rule "${name}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`);
                             return;
                         }
                         const schema = requiresSchema ? requireGraphQLSchemaFromContext(name, context) : null;
-                        let documentNode;
-                        const isRealFile = fs.existsSync(context.getFilename());
-                        if (isRealFile && getDocumentNode) {
-                            documentNode = getDocumentNode(context);
-                        }
-                        validateDoc(node, context, schema, documentNode || node.rawNode(), [ruleFn], ruleName);
+                        const documentNode = node.rawNode();
+                        validateDoc(node, context, schema, getDocumentNode
+                            ? getDocumentNode({
+                                schema,
+                                node: documentNode,
+                                ruleId: name,
+                                context,
+                            })
+                            : documentNode, ruleFn);
                     },
                 };
             },
         },
     };
 };
-const importFiles = (context) => {
-    const code = context.getSourceCode().text;
-    if (!isGraphQLImportFile(code)) {
-        return null;
-    }
-    // Import documents because file contains '#import' comments
-    return _import.processImport(context.getFilename());
-};
 const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-definitions', 'ExecutableDefinitions', {
     category: 'Operations',
     description: `A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.`,
@@ -438,14 +473,15 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('known-fragment-names', 'KnownFragmentNames', {
     category: 'Operations',
     description: `A GraphQL document is only valid if all \`...Fragment\` fragment spreads refer to fragments defined in the same document.`,
+    requiresSiblings: true,
     examples: [
         {
-            title: 'Incorrect (fragment not defined in the document)',
+            title: 'Incorrect',
             code: /* GraphQL */ `
             query {
               user {
                 id
-                ...UserFields
+                ...UserFields # fragment not defined in the document
               }
             }
           `,
@@ -467,42 +503,24 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
           `,
         },
         {
-            title: 'Correct (existing import to UserFields fragment)',
+            title: 'Correct (`UserFields` fragment located in a separate file)',
             code: /* GraphQL */ `
-            #import '../UserFields.gql'
-
+            # user.gql
             query {
               user {
                 id
                 ...UserFields
               }
             }
-          `,
-        },
-        {
-            title: "False positive case\n\nFor extracting documents from code under the hood we use [graphql-tag-pluck](https://graphql-tools.com/docs/graphql-tag-pluck) that [don't support string interpolation](https://stackoverflow.com/questions/62749847/graphql-codegen-dynamic-fields-with-interpolation/62751311#62751311) for this moment.",
-            code: `
-            const USER_FIELDS = gql\`
-              fragment UserFields on User {
-                id
-              }
-            \`
-            
-            const GET_USER = /* GraphQL */ \`
-              # eslint @graphql-eslint/known-fragment-names: 'error'
-
-              query User {
-                user {
-                  ...UserFields
-                }
-              }
 
-              # Will give false positive error 'Unknown fragment "UserFields"'
-              \${USER_FIELDS}
-            \``,
+            # user-fields.gql
+            fragment UserFields on User {
+              id
+            }
+          `,
         },
     ],
-}, importFiles), validationToRule('known-type-names', 'KnownTypeNames', {
+}, handleMissingFragments), validationToRule('known-type-names', 'KnownTypeNames', {
     category: ['Schema', 'Operations'],
     description: `A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.`,
 }), validationToRule('lone-anonymous-operation', 'LoneAnonymousOperation', {
@@ -518,40 +536,47 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
 }), validationToRule('no-undefined-variables', 'NoUndefinedVariables', {
     category: 'Operations',
     description: `A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.`,
-}, importFiles), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
+    requiresSiblings: true,
+}, handleMissingFragments), validationToRule('no-unused-fragments', 'NoUnusedFragments', {
     category: 'Operations',
     description: `A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.`,
     requiresSiblings: true,
-}, context => {
-    const siblings = requireSiblingsOperations('no-unused-fragments', context);
-    const documents = [...siblings.getOperations(), ...siblings.getFragments()]
-        .filter(({ document }) => isGraphQLImportFile(document.loc.source.body))
-        .map(({ filePath, document }) => ({
-        filePath,
-        code: document.loc.source.body,
-    }));
-    const getParentNode = (filePath) => {
-        for (const { filePath: docFilePath, code } of documents) {
-            const isFileImported = code
-                .split('\n')
-                .filter(isGraphQLImportFile)
-                .map(line => _import.parseImportLine(line.replace('#', '')))
-                .some(o => filePath === path.join(path.dirname(docFilePath), o.from));
-            if (!isFileImported) {
-                continue;
-            }
-            // Import first file that import this file
-            const document = _import.processImport(docFilePath);
-            // Import most top file that import this file
-            return getParentNode(docFilePath) || document;
+}, ({ context, node, schema, ruleId }) => {
+    const siblings = requireSiblingsOperations(ruleId, context);
+    const filePathForDocumentsMap = [...siblings.getOperations(), ...siblings.getFragments()].reduce((map, { filePath, document }) => {
+        var _a;
+        (_a = map[filePath]) !== null && _a !== void 0 ? _a : (map[filePath] = []);
+        map[filePath].push(document);
+        return map;
+    }, Object.create(null));
+    const getParentNode = (currentFilePath, node) => {
+        const { fragmentDefs } = getFragmentDefsAndFragmentSpreads(schema, node);
+        if (fragmentDefs.size === 0) {
+            return node;
         }
-        return null;
+        // skip iteration over documents for current filepath
+        delete filePathForDocumentsMap[currentFilePath];
+        for (const [filePath, documents] of Object.entries(filePathForDocumentsMap)) {
+            const missingFragments = getMissingFragments(schema, {
+                kind: graphql.Kind.DOCUMENT,
+                definitions: documents,
+            });
+            const isCurrentFileImportFragment = missingFragments.some(fragment => fragmentDefs.has(fragment));
+            if (isCurrentFileImportFragment) {
+                return getParentNode(filePath, {
+                    kind: graphql.Kind.DOCUMENT,
+                    definitions: [...node.definitions, ...documents],
+                });
+            }
+        }
+        return node;
     };
-    return getParentNode(context.getFilename());
+    return getParentNode(context.getFilename(), node);
 }), validationToRule('no-unused-variables', 'NoUnusedVariables', {
     category: 'Operations',
     description: `A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.`,
-}, importFiles), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
+    requiresSiblings: true,
+}, handleMissingFragments), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
     category: 'Operations',
     description: `A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.`,
 }), validationToRule('possible-fragment-spread', 'PossibleFragmentSpreads', {
@@ -1845,7 +1870,7 @@ const HASHTAG_COMMENT = 'HASHTAG_COMMENT';
 const rule$9 = {
     meta: {
         messages: {
-            [HASHTAG_COMMENT]: 'Using hashtag (#) for adding GraphQL descriptions is not allowed. Prefer using """ for multiline, or " for a single line description.',
+            [HASHTAG_COMMENT]: `Using hashtag (#) for adding GraphQL descriptions is not allowed. Prefer using """ for multiline, or " for a single line description.`,
         },
         docs: {
             description: 'Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.\nAllows to use hashtag for comments, as long as it\'s not attached to an AST definition.',
@@ -1892,14 +1917,15 @@ const rule$9 = {
         schema: [],
     },
     create(context) {
+        const selector = `${graphql.Kind.DOCUMENT}[definitions.0.kind!=/^(${graphql.Kind.OPERATION_DEFINITION}|${graphql.Kind.FRAGMENT_DEFINITION})$/]`;
         return {
-            Document(node) {
+            [selector](node) {
                 const rawNode = node.rawNode();
                 let token = rawNode.loc.startToken;
                 while (token !== null) {
                     const { kind, prev, next, value, line, column } = token;
                     if (kind === graphql.TokenKind.COMMENT && prev && next) {
-                        const isEslintComment = value.trimLeft().startsWith('eslint');
+                        const isEslintComment = value.trimStart().startsWith('eslint');
                         const linesAfter = next.line - line;
                         if (!isEslintComment && line !== prev.line && next.kind === graphql.TokenKind.NAME && linesAfter < 2) {
                             context.report({
@@ -2106,7 +2132,22 @@ const rule$c = {
 };
 
 const UNREACHABLE_TYPE = 'UNREACHABLE_TYPE';
-const RULE_NAME = 'no-unreachable-types';
+const RULE_ID = 'no-unreachable-types';
+const KINDS = [
+    graphql.Kind.DIRECTIVE_DEFINITION,
+    graphql.Kind.OBJECT_TYPE_DEFINITION,
+    graphql.Kind.OBJECT_TYPE_EXTENSION,
+    graphql.Kind.INTERFACE_TYPE_DEFINITION,
+    graphql.Kind.INTERFACE_TYPE_EXTENSION,
+    graphql.Kind.SCALAR_TYPE_DEFINITION,
+    graphql.Kind.SCALAR_TYPE_EXTENSION,
+    graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION,
+    graphql.Kind.INPUT_OBJECT_TYPE_EXTENSION,
+    graphql.Kind.UNION_TYPE_DEFINITION,
+    graphql.Kind.UNION_TYPE_EXTENSION,
+    graphql.Kind.ENUM_TYPE_DEFINITION,
+    graphql.Kind.ENUM_TYPE_EXTENSION,
+];
 const rule$d = {
     meta: {
         messages: {
@@ -2115,7 +2156,7 @@ const rule$d = {
         docs: {
             description: `Requires all types to be reachable at some level by root level fields.`,
             category: 'Schema',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -2147,43 +2188,36 @@ const rule$d = {
             ],
             recommended: true,
         },
-        fixable: 'code',
         type: 'suggestion',
         schema: [],
+        hasSuggestions: true,
     },
     create(context) {
-        const reachableTypes = requireReachableTypesFromContext(RULE_NAME, context);
-        function ensureReachability(node) {
-            const typeName = node.name.value;
-            if (!reachableTypes.has(typeName)) {
-                context.report({
-                    loc: getLocation(node.name.loc, typeName, { offsetStart: node.kind === graphql.Kind.DIRECTIVE_DEFINITION ? 2 : 1 }),
-                    messageId: UNREACHABLE_TYPE,
-                    data: { typeName },
-                    fix: fixer => fixer.remove(node),
-                });
-            }
-        }
+        const reachableTypes = requireReachableTypesFromContext(RULE_ID, context);
+        const selector = KINDS.join(',');
         return {
-            DirectiveDefinition: ensureReachability,
-            ObjectTypeDefinition: ensureReachability,
-            ObjectTypeExtension: ensureReachability,
-            InterfaceTypeDefinition: ensureReachability,
-            InterfaceTypeExtension: ensureReachability,
-            ScalarTypeDefinition: ensureReachability,
-            ScalarTypeExtension: ensureReachability,
-            InputObjectTypeDefinition: ensureReachability,
-            InputObjectTypeExtension: ensureReachability,
-            UnionTypeDefinition: ensureReachability,
-            UnionTypeExtension: ensureReachability,
-            EnumTypeDefinition: ensureReachability,
-            EnumTypeExtension: ensureReachability,
+            [selector](node) {
+                const typeName = node.name.value;
+                if (!reachableTypes.has(typeName)) {
+                    context.report({
+                        loc: getLocation(node.name.loc, typeName, { offsetStart: node.kind === graphql.Kind.DIRECTIVE_DEFINITION ? 2 : 1 }),
+                        messageId: UNREACHABLE_TYPE,
+                        data: { typeName },
+                        suggest: [
+                            {
+                                desc: `Remove ${typeName}`,
+                                fix: fixer => fixer.remove(node),
+                            },
+                        ],
+                    });
+                }
+            },
         };
     },
 };
 
 const UNUSED_FIELD = 'UNUSED_FIELD';
-const RULE_NAME$1 = 'no-unused-fields';
+const RULE_ID$1 = 'no-unused-fields';
 const rule$e = {
     meta: {
         messages: {
@@ -2192,7 +2226,7 @@ const rule$e = {
         docs: {
             description: `Requires all fields to be used at some level by siblings operations.`,
             category: 'Schema',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$1}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$1}.md`,
             requiresSiblings: true,
             requiresSchema: true,
             examples: [
@@ -2239,12 +2273,12 @@ const rule$e = {
                 },
             ],
         },
-        fixable: 'code',
         type: 'suggestion',
         schema: [],
+        hasSuggestions: true,
     },
     create(context) {
-        const usedFields = requireUsedFieldsFromContext(RULE_NAME$1, context);
+        const usedFields = requireUsedFieldsFromContext(RULE_ID$1, context);
         return {
             FieldDefinition(node) {
                 var _a;
@@ -2258,22 +2292,18 @@ const rule$e = {
                     loc: getLocation(node.loc, fieldName),
                     messageId: UNUSED_FIELD,
                     data: { fieldName },
-                    fix(fixer) {
-                        const sourceCode = context.getSourceCode();
-                        const tokenBefore = sourceCode.getTokenBefore(node);
-                        const tokenAfter = sourceCode.getTokenAfter(node);
-                        const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
-                        if (isEmptyType) {
-                            // Remove type
-                            const { parent } = node;
-                            const parentBeforeToken = sourceCode.getTokenBefore(parent);
-                            return parentBeforeToken
-                                ? fixer.removeRange([parentBeforeToken.range[1], parent.range[1]])
-                                : fixer.remove(parent);
-                        }
-                        // Remove whitespace before token
-                        return fixer.removeRange([tokenBefore.range[1], node.range[1]]);
-                    },
+                    suggest: [
+                        {
+                            desc: `Remove "${fieldName}" field`,
+                            fix(fixer) {
+                                const sourceCode = context.getSourceCode();
+                                const tokenBefore = sourceCode.getTokenBefore(node);
+                                const tokenAfter = sourceCode.getTokenAfter(node);
+                                const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
+                                return isEmptyType ? fixer.remove(node.parent) : fixer.remove(node);
+                            },
+                        },
+                    ],
                 });
             },
         };
@@ -2636,14 +2666,14 @@ const rule$h = {
     },
 };
 
-const RULE_NAME$2 = 'require-field-of-type-query-in-mutation-result';
+const RULE_NAME = 'require-field-of-type-query-in-mutation-result';
 const rule$i = {
     meta: {
         type: 'suggestion',
         docs: {
             category: 'Schema',
             description: 'Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.\n> Currently, no errors are reported for result type `union`, `interface` and `scalar`.',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$2}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -2678,7 +2708,7 @@ const rule$i = {
         schema: [],
     },
     create(context) {
-        const schema = requireGraphQLSchemaFromContext(RULE_NAME$2, context);
+        const schema = requireGraphQLSchemaFromContext(RULE_NAME, context);
         const mutationType = schema.getMutationType();
         const queryType = schema.getQueryType();
         if (!mutationType || !queryType) {
@@ -3221,7 +3251,7 @@ const rule$l = {
     },
 };
 
-const RULE_NAME$3 = 'unique-fragment-name';
+const RULE_NAME$1 = 'unique-fragment-name';
 const UNIQUE_FRAGMENT_NAME = 'UNIQUE_FRAGMENT_NAME';
 const checkNode = (context, node, ruleName, messageId) => {
     const documentName = node.name.value;
@@ -3253,7 +3283,7 @@ const rule$m = {
         docs: {
             category: 'Operations',
             description: `Enforce unique fragment names across your project.`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$3}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$1}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3298,13 +3328,13 @@ const rule$m = {
     create(context) {
         return {
             FragmentDefinition(node) {
-                checkNode(context, node, RULE_NAME$3, UNIQUE_FRAGMENT_NAME);
+                checkNode(context, node, RULE_NAME$1, UNIQUE_FRAGMENT_NAME);
             },
         };
     },
 };
 
-const RULE_NAME$4 = 'unique-operation-name';
+const RULE_NAME$2 = 'unique-operation-name';
 const UNIQUE_OPERATION_NAME = 'UNIQUE_OPERATION_NAME';
 const rule$n = {
     meta: {
@@ -3312,7 +3342,7 @@ const rule$n = {
         docs: {
             category: 'Operations',
             description: `Enforce unique operation names across your project.`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$4}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME$2}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3361,7 +3391,7 @@ const rule$n = {
     create(context) {
         return {
             'OperationDefinition[name!=undefined]'(node) {
-                checkNode(context, node, RULE_NAME$4, UNIQUE_OPERATION_NAME);
+                checkNode(context, node, RULE_NAME$2, UNIQUE_OPERATION_NAME);
             },
         };
     },