@graphql-eslint/eslint-plugin 3.15.0 → 3.16.0-alpha-20230209004557-0da21db

package/cjs/rules/index.js

@@ -31,6 +31,7 @@ const require_deprecation_reason_js_1 = require("./require-deprecation-reason.js
 const require_description_js_1 = require("./require-description.js");
 const require_field_of_type_query_in_mutation_result_js_1 = require("./require-field-of-type-query-in-mutation-result.js");
 const require_id_when_available_js_1 = require("./require-id-when-available.js");
+const require_import_fragment_js_1 = require("./require-import-fragment.js");
 const require_nullable_fields_with_oneof_js_1 = require("./require-nullable-fields-with-oneof.js");
 const require_type_pattern_with_oneof_js_1 = require("./require-type-pattern-with-oneof.js");
 const selection_set_depth_js_1 = require("./selection-set-depth.js");
@@ -65,6 +66,7 @@ exports.rules = {
     'require-description': require_description_js_1.rule,
     'require-field-of-type-query-in-mutation-result': require_field_of_type_query_in_mutation_result_js_1.rule,
     'require-id-when-available': require_id_when_available_js_1.rule,
+    'require-import-fragment': require_import_fragment_js_1.rule,
     'require-nullable-fields-with-oneof': require_nullable_fields_with_oneof_js_1.rule,
     'require-type-pattern-with-oneof': require_type_pattern_with_oneof_js_1.rule,
     'selection-set-depth': selection_set_depth_js_1.rule,

package/cjs/rules/lone-executable-definition.js

@@ -68,7 +68,7 @@ exports.rule = {
                     definitions.push({ type, node });
                 }
             },
-            'Program:exit'() {
+            'Document:exit'() {
                 var _a, _b;
                 for (const { node, type } of definitions.slice(1) /* ignore first definition */) {
                     let name = (0, utils_js_1.pascalCase)(type);

package/cjs/rules/require-import-fragment.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const utils_js_1 = require("../utils.js");
+const RULE_ID = 'require-import-fragment';
+const SUGGESTION_ID = 'add-import-expression';
+exports.rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Operations',
+            description: 'Require fragments to be imported via an import expression.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            # import 'post-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            # import UserFields from 'post-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            # import UserFields from 'user-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+            ],
+            requiresSiblings: true,
+            isDisabledForAllConfig: true,
+        },
+        hasSuggestions: true,
+        messages: {
+            [RULE_ID]: 'Expected "{{fragmentName}}" fragment to be imported.',
+            [SUGGESTION_ID]: 'Add import expression for "{{fragmentName}}".',
+        },
+        schema: [],
+    },
+    create(context) {
+        const comments = context.getSourceCode().getAllComments();
+        const siblings = (0, utils_js_1.requireSiblingsOperations)(RULE_ID, context);
+        const filePath = context.getFilename();
+        return {
+            'FragmentSpread > .name'(node) {
+                var _a;
+                const fragmentName = node.value;
+                const fragmentsFromSiblings = siblings.getFragment(fragmentName);
+                for (const comment of comments) {
+                    if (comment.type !== 'Line')
+                        continue;
+                    // 1. could start with extra whitespace
+                    // 2. match both named/default import
+                    const isPossibleImported = new RegExp(`^\\s*import\\s+(${fragmentName}\\s+from\\s+)?['"]`).test(comment.value);
+                    if (!isPossibleImported)
+                        continue;
+                    const extractedImportPath = (_a = comment.value.match(/(["'])((?:\1|.)*?)\1/)) === null || _a === void 0 ? void 0 : _a[2];
+                    if (!extractedImportPath)
+                        continue;
+                    const importPath = path_1.default.join(path_1.default.dirname(filePath), extractedImportPath);
+                    const hasInSiblings = fragmentsFromSiblings.some(source => source.filePath === importPath);
+                    if (hasInSiblings)
+                        return;
+                }
+                const fragmentInSameFile = fragmentsFromSiblings.some(source => source.filePath === filePath);
+                if (fragmentInSameFile)
+                    return;
+                const suggestedFilePaths = fragmentsFromSiblings.length
+                    ? fragmentsFromSiblings.map(o => path_1.default.relative(path_1.default.dirname(filePath), o.filePath))
+                    : ['CHANGE_ME.graphql'];
+                context.report({
+                    node,
+                    messageId: RULE_ID,
+                    data: { fragmentName },
+                    suggest: suggestedFilePaths.map(suggestedPath => ({
+                        messageId: SUGGESTION_ID,
+                        data: { fragmentName },
+                        fix: fixer => fixer.insertTextBeforeRange([0, 0], `# import ${fragmentName} from '${suggestedPath}'\n`),
+                    })),
+                });
+            },
+        };
+    },
+};

package/cjs/testkit.js

@@ -29,25 +29,7 @@ class GraphQLRuleTester extends eslint_1.RuleTester {
         return (0, fs_1.readFileSync)((0, path_1.resolve)(__dirname, `../tests/mocks/${path}`), 'utf-8');
     }
     runGraphQLTests(ruleId, rule, tests) {
-        const ruleTests = eslint_1.Linter.version.startsWith('8')
-            ? tests
-            : {
-                valid: tests.valid.map(test => {
-                    if (typeof test === 'string') {
-                        return test;
-                    }
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                    const { name, ...testCaseOptions } = test;
-                    return testCaseOptions;
-                }),
-                invalid: tests.invalid.map(test => {
-                    // ESLint 7 throws an error on CI - Unexpected top-level property "name"
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                    const { name, ...testCaseOptions } = test;
-                    return testCaseOptions;
-                }),
-            };
-        super.run(ruleId, rule, ruleTests);
+        super.run(ruleId, rule, tests);
         const linter = new eslint_1.Linter();
         linter.defineRule(ruleId, rule);
         const hasOnlyTest = [...tests.valid, ...tests.invalid].some(t => typeof t !== 'string' && t.only);

package/esm/rules/index.js

@@ -28,6 +28,7 @@ import { rule as requireDeprecationReason } from './require-deprecation-reason.j
 import { rule as requireDescription } from './require-description.js';
 import { rule as requireFieldOfTypeQueryInMutationResult } from './require-field-of-type-query-in-mutation-result.js';
 import { rule as requireIdWhenAvailable } from './require-id-when-available.js';
+import { rule as requireImportFragment } from './require-import-fragment.js';
 import { rule as requireNullableFieldsWithOneof } from './require-nullable-fields-with-oneof.js';
 import { rule as requireTypePatternWithOneof } from './require-type-pattern-with-oneof.js';
 import { rule as selectionSetDepth } from './selection-set-depth.js';
@@ -62,6 +63,7 @@ export const rules = {
     'require-description': requireDescription,
     'require-field-of-type-query-in-mutation-result': requireFieldOfTypeQueryInMutationResult,
     'require-id-when-available': requireIdWhenAvailable,
+    'require-import-fragment': requireImportFragment,
     'require-nullable-fields-with-oneof': requireNullableFieldsWithOneof,
     'require-type-pattern-with-oneof': requireTypePatternWithOneof,
     'selection-set-depth': selectionSetDepth,

package/esm/rules/lone-executable-definition.js

@@ -65,7 +65,7 @@ export const rule = {
                     definitions.push({ type, node });
                 }
             },
-            'Program:exit'() {
+            'Document:exit'() {
                 var _a, _b;
                 for (const { node, type } of definitions.slice(1) /* ignore first definition */) {
                     let name = pascalCase(type);

package/esm/rules/require-import-fragment.js

@@ -0,0 +1,111 @@
+import path from 'path';
+import { requireSiblingsOperations } from '../utils.js';
+const RULE_ID = 'require-import-fragment';
+const SUGGESTION_ID = 'add-import-expression';
+export const rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            category: 'Operations',
+            description: 'Require fragments to be imported via an import expression.',
+            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            # import 'post-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+            # import UserFields from 'post-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+            # import UserFields from 'user-fields.fragment.graphql'
+            query {
+              user {
+                ...UserFields
+              }
+            }
+          `,
+                },
+            ],
+            requiresSiblings: true,
+            isDisabledForAllConfig: true,
+        },
+        hasSuggestions: true,
+        messages: {
+            [RULE_ID]: 'Expected "{{fragmentName}}" fragment to be imported.',
+            [SUGGESTION_ID]: 'Add import expression for "{{fragmentName}}".',
+        },
+        schema: [],
+    },
+    create(context) {
+        const comments = context.getSourceCode().getAllComments();
+        const siblings = requireSiblingsOperations(RULE_ID, context);
+        const filePath = context.getFilename();
+        return {
+            'FragmentSpread > .name'(node) {
+                var _a;
+                const fragmentName = node.value;
+                const fragmentsFromSiblings = siblings.getFragment(fragmentName);
+                for (const comment of comments) {
+                    if (comment.type !== 'Line')
+                        continue;
+                    // 1. could start with extra whitespace
+                    // 2. match both named/default import
+                    const isPossibleImported = new RegExp(`^\\s*import\\s+(${fragmentName}\\s+from\\s+)?['"]`).test(comment.value);
+                    if (!isPossibleImported)
+                        continue;
+                    const extractedImportPath = (_a = comment.value.match(/(["'])((?:\1|.)*?)\1/)) === null || _a === void 0 ? void 0 : _a[2];
+                    if (!extractedImportPath)
+                        continue;
+                    const importPath = path.join(path.dirname(filePath), extractedImportPath);
+                    const hasInSiblings = fragmentsFromSiblings.some(source => source.filePath === importPath);
+                    if (hasInSiblings)
+                        return;
+                }
+                const fragmentInSameFile = fragmentsFromSiblings.some(source => source.filePath === filePath);
+                if (fragmentInSameFile)
+                    return;
+                const suggestedFilePaths = fragmentsFromSiblings.length
+                    ? fragmentsFromSiblings.map(o => path.relative(path.dirname(filePath), o.filePath))
+                    : ['CHANGE_ME.graphql'];
+                context.report({
+                    node,
+                    messageId: RULE_ID,
+                    data: { fragmentName },
+                    suggest: suggestedFilePaths.map(suggestedPath => ({
+                        messageId: SUGGESTION_ID,
+                        data: { fragmentName },
+                        fix: fixer => fixer.insertTextBeforeRange([0, 0], `# import ${fragmentName} from '${suggestedPath}'\n`),
+                    })),
+                });
+            },
+        };
+    },
+};

package/esm/testkit.js

@@ -28,25 +28,7 @@ export class GraphQLRuleTester extends RuleTester {
         return readFileSync(resolve(__dirname, `../tests/mocks/${path}`), 'utf-8');
     }
     runGraphQLTests(ruleId, rule, tests) {
-        const ruleTests = Linter.version.startsWith('8')
-            ? tests
-            : {
-                valid: tests.valid.map(test => {
-                    if (typeof test === 'string') {
-                        return test;
-                    }
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                    const { name, ...testCaseOptions } = test;
-                    return testCaseOptions;
-                }),
-                invalid: tests.invalid.map(test => {
-                    // ESLint 7 throws an error on CI - Unexpected top-level property "name"
-                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-                    const { name, ...testCaseOptions } = test;
-                    return testCaseOptions;
-                }),
-            };
-        super.run(ruleId, rule, ruleTests);
+        super.run(ruleId, rule, tests);
         const linter = new Linter();
         linter.defineRule(ruleId, rule);
         const hasOnlyTest = [...tests.valid, ...tests.invalid].some(t => typeof t !== 'string' && t.only);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.15.0",
+  "version": "3.16.0-alpha-20230209004557-0da21db",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/typings/rules/index.d.cts

@@ -88,6 +88,7 @@ export declare const rules: {
     'require-id-when-available': import("../types.js").GraphQLESLintRule<{
         fieldName?: string | string[] | undefined;
     }[], true>;
+    'require-import-fragment': import("../types.js").GraphQLESLintRule<[], false>;
     'require-nullable-fields-with-oneof': import("../types.js").GraphQLESLintRule<[], false>;
     'require-type-pattern-with-oneof': import("../types.js").GraphQLESLintRule<[], false>;
     'selection-set-depth': import("../types.js").GraphQLESLintRule<{

package/typings/rules/index.d.ts

@@ -88,6 +88,7 @@ export declare const rules: {
     'require-id-when-available': import("../types.js").GraphQLESLintRule<{
         fieldName?: string | string[] | undefined;
     }[], true>;
+    'require-import-fragment': import("../types.js").GraphQLESLintRule<[], false>;
     'require-nullable-fields-with-oneof': import("../types.js").GraphQLESLintRule<[], false>;
     'require-type-pattern-with-oneof': import("../types.js").GraphQLESLintRule<[], false>;
     'selection-set-depth': import("../types.js").GraphQLESLintRule<{

package/typings/rules/require-import-fragment.d.cts

@@ -0,0 +1,2 @@
+import { GraphQLESLintRule } from '../types.cjs';
+export declare const rule: GraphQLESLintRule;

package/typings/rules/require-import-fragment.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLESLintRule } from '../types.js';
+export declare const rule: GraphQLESLintRule;

package/typings/testkit.d.cts

@@ -5,11 +5,11 @@ import { GraphQLESLintRule, ParserOptions } from './types.cjs';
 export type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 };
-export type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
+export type GraphQLValidTestCase<Options = []> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
     options?: Options;
     parserOptions?: Omit<ParserOptions, 'filePath'>;
 };
-export type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
+export type GraphQLInvalidTestCase<T = []> = GraphQLValidTestCase<T> & {
     errors: (RuleTester.TestCaseError | string)[] | number;
     output?: string | null;
 };

package/typings/testkit.d.ts

@@ -5,11 +5,11 @@ import { GraphQLESLintRule, ParserOptions } from './types.js';
 export type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 };
-export type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
+export type GraphQLValidTestCase<Options = []> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
     options?: Options;
     parserOptions?: Omit<ParserOptions, 'filePath'>;
 };
-export type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
+export type GraphQLInvalidTestCase<T = []> = GraphQLValidTestCase<T> & {
     errors: (RuleTester.TestCaseError | string)[] | number;
     output?: string | null;
 };