@graphql-eslint/eslint-plugin 3.7.0 → 3.8.0-alpha-a8fcc7b.0

package/docs/README.md

@@ -44,7 +44,7 @@ Name            &nbs
 [provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|![recommended][]|🔮
 [require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|![all][]|🚀
 [require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|![recommended][]|🚀
-[require-description](rules/require-description.md)|Enforce descriptions in your type definitions.|![recommended][]|🚀
+[require-description](rules/require-description.md)|Enforce descriptions in type definitions and operations.|![recommended][]|🚀
 [require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|🚀
 [require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|🚀
 [scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|🔮

package/docs/rules/alphabetize.md

@@ -1,5 +1,7 @@
 # `alphabetize`
 
+🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#--fix) can automatically fix some of the problems reported by this rule.
+
 - Category: `Schema & Operations`
 - Rule name: `@graphql-eslint/alphabetize`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
@@ -7,6 +9,8 @@
 
 Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.
 
+> Note: autofix will work only for fields without comments (between or around)
+
 ## Usage Examples
 
 ### Incorrect

package/docs/rules/require-description.md

@@ -7,7 +7,7 @@
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-Enforce descriptions in your type definitions.
+Enforce descriptions in type definitions and operations.
 
 ## Usage Examples
 
@@ -37,6 +37,17 @@ type someTypeName {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
+
+# Create a new user
+mutation createUser {
+  # ...
+}
+```
+
 ## Config Schema
 
 The schema defines the following properties:
@@ -84,6 +95,12 @@ Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ObjectTypeDefinition).
 
+### `OperationDefinition` (boolean)
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
+
+> You must use only comment syntax `#` and not description syntax `"""` or `"`.
+
 ### `ScalarTypeDefinition` (boolean)
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).

package/index.js

@@ -17,6 +17,7 @@ const graphqlConfig = require('graphql-config');
 const codeFileLoader = require('@graphql-tools/code-file-loader');
 const eslint = require('eslint');
 const codeFrame = require('@babel/code-frame');
+const dedent = _interopDefault(require('dedent'));
 
 const base = {
     parser: '@graphql-eslint/eslint-plugin',
@@ -688,9 +689,13 @@ const argumentsEnum = [
 const rule = {
     meta: {
         type: 'suggestion',
+        fixable: 'code',
         docs: {
             category: ['Schema', 'Operations'],
-            description: 'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
+            description: [
+                'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
+                '> Note: autofix will work only for fields without comments (between or around)',
+            ].join('\n\n'),
             url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/alphabetize.md',
             examples: [
                 {
@@ -848,14 +853,20 @@ const rule = {
     },
     create(context) {
         var _a, _b, _c, _d, _e;
+        function isOnSameLineNodeAndComment(beforeNode, afterNode) {
+            return beforeNode.loc.end.line === afterNode.loc.start.line;
+        }
         function checkNodes(nodes) {
-            let prevName = null;
-            for (const node of nodes) {
-                const currName = node.name.value;
-                if (prevName && prevName > currName) {
-                    const isVariableNode = node.kind === graphql.Kind.VARIABLE;
+            // Starts from 1, ignore nodes.length <= 1
+            for (let i = 1; i < nodes.length; i += 1) {
+                const prevNode = nodes[i - 1];
+                const currNode = nodes[i];
+                const prevName = prevNode.name.value;
+                const currName = currNode.name.value;
+                if (prevName.localeCompare(currName) === 1) {
+                    const isVariableNode = currNode.kind === graphql.Kind.VARIABLE;
                     context.report({
-                        loc: getLocation(node.loc, node.name.value, { offsetEnd: isVariableNode ? 0 : 1 }),
+                        loc: getLocation(currNode.loc, currName, { offsetEnd: isVariableNode ? 0 : 1 }),
                         messageId: ALPHABETIZE,
                         data: isVariableNode
                             ? {
@@ -863,9 +874,28 @@ const rule = {
                                 prevName: `$${prevName}`,
                             }
                             : { currName, prevName },
+                        *fix(fixer) {
+                            const prev = prevNode;
+                            const curr = currNode;
+                            const sourceCode = context.getSourceCode();
+                            const beforeComments = sourceCode.getCommentsBefore(prev);
+                            if (beforeComments.length > 0) {
+                                const tokenBefore = sourceCode.getTokenBefore(prev);
+                                const lastBeforeComment = beforeComments.at(-1);
+                                if (!tokenBefore || !isOnSameLineNodeAndComment(tokenBefore, lastBeforeComment))
+                                    return;
+                            }
+                            const betweenComments = sourceCode.getCommentsBefore(curr);
+                            if (betweenComments.length > 0)
+                                return;
+                            const [firstAfterComment] = sourceCode.getCommentsAfter(curr);
+                            if (firstAfterComment && isOnSameLineNodeAndComment(curr, firstAfterComment))
+                                return;
+                            yield fixer.replaceText(prev, sourceCode.getText(curr));
+                            yield fixer.replaceText(curr, sourceCode.getText(prev));
+                        },
                     });
                 }
-                prevName = currName;
             }
         }
         const opts = context.options[0];
@@ -2625,20 +2655,21 @@ const rule$g = {
     },
 };
 
-const REQUIRE_DESCRIPTION_ERROR = 'REQUIRE_DESCRIPTION_ERROR';
+const RULE_ID$2 = 'require-description';
 const ALLOWED_KINDS$1 = [
     ...TYPES_KINDS,
     graphql.Kind.FIELD_DEFINITION,
     graphql.Kind.INPUT_VALUE_DEFINITION,
     graphql.Kind.ENUM_VALUE_DEFINITION,
     graphql.Kind.DIRECTIVE_DEFINITION,
+    graphql.Kind.OPERATION_DEFINITION,
 ];
 const rule$h = {
     meta: {
         docs: {
             category: 'Schema',
-            description: 'Enforce descriptions in your type definitions.',
-            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-description.md',
+            description: 'Enforce descriptions in type definitions and operations.',
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             examples: [
                 {
                     title: 'Incorrect',
@@ -2662,6 +2693,16 @@ const rule$h = {
               """
               name: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ OperationDefinition: true }],
+                    code: /* GraphQL */ `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
           `,
                 },
             ],
@@ -2675,7 +2716,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [REQUIRE_DESCRIPTION_ERROR]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
         },
         schema: {
             type: 'array',
@@ -2690,19 +2731,19 @@ const rule$h = {
                         type: 'boolean',
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => [
-                        kind,
-                        {
-                            type: 'boolean',
-                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
-                        },
-                    ])),
+                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => {
+                        let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+                        if (kind === graphql.Kind.OPERATION_DEFINITION) {
+                            description += '\n\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+                        }
+                        return [kind, { type: 'boolean', description }];
+                    })),
                 },
             },
         },
     },
     create(context) {
-        const { types, ...restOptions } = context.options[0];
+        const { types, ...restOptions } = context.options[0] || {};
         const kinds = new Set(types ? TYPES_KINDS : []);
         for (const [kind, isEnabled] of Object.entries(restOptions)) {
             if (isEnabled) {
@@ -2716,11 +2757,26 @@ const rule$h = {
         return {
             [selector](node) {
                 var _a;
-                const description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value) || '';
-                if (description.trim().length === 0) {
+                let description = '';
+                const isOperation = node.kind === graphql.Kind.OPERATION_DEFINITION;
+                if (isOperation) {
+                    const rawNode = node.rawNode();
+                    const { prev, line } = rawNode.loc.startToken;
+                    if (prev.kind === graphql.TokenKind.COMMENT) {
+                        const value = prev.value.trim();
+                        const linesBefore = line - prev.line;
+                        if (!value.startsWith('eslint') && linesBefore === 1) {
+                            description = value;
+                        }
+                    }
+                }
+                else {
+                    description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value.trim()) || '';
+                }
+                if (description.length === 0) {
                     context.report({
-                        loc: getLocation(node.name.loc, node.name.value),
-                        messageId: REQUIRE_DESCRIPTION_ERROR,
+                        loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
+                        messageId: RULE_ID$2,
                         data: {
                             nodeType: node.kind,
                         },
@@ -2896,7 +2952,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$2 = 'require-id-when-available';
+const RULE_ID$3 = 'require-id-when-available';
 const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
@@ -2905,7 +2961,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2979,8 +3035,8 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$2, context);
-        const siblings = requireSiblingsOperations(RULE_ID$2, context);
+        requireGraphQLSchemaFromContext(RULE_ID$3, context);
+        const siblings = requireSiblingsOperations(RULE_ID$3, context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
         const idNames = utils.asArray(fieldName);
         const isFound = (s) => s.kind === graphql.Kind.FIELD && idNames.includes(s.name.value);
@@ -3042,13 +3098,13 @@ const rule$j = {
     },
 };
 
-const RULE_ID$3 = 'selection-set-depth';
+const RULE_ID$4 = 'selection-set-depth';
 const rule$k = {
     meta: {
         docs: {
             category: 'Operations',
             description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3122,10 +3178,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$3, context);
+            siblings = requireSiblingsOperations(RULE_ID$4, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$3}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$4}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
         const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
@@ -3150,14 +3206,14 @@ const rule$k = {
                     });
                 }
                 catch (e) {
-                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
+                    logger.warn(`Rule "${RULE_ID$4}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };
     },
 };
 
-const RULE_ID$4 = 'strict-id-in-types';
+const RULE_ID$5 = 'strict-id-in-types';
 const rule$l = {
     meta: {
         type: 'suggestion',
@@ -3165,7 +3221,7 @@ const rule$l = {
             description: `Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.`,
             category: 'Schema',
             recommended: true,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$5}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -3279,7 +3335,7 @@ const rule$l = {
             },
         },
         messages: {
-            [RULE_ID$4]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
+            [RULE_ID$5]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
         },
     },
     create(context) {
@@ -3289,7 +3345,7 @@ const rule$l = {
             exceptions: {},
             ...context.options[0],
         };
-        const schema = requireGraphQLSchemaFromContext(RULE_ID$4, context);
+        const schema = requireGraphQLSchemaFromContext(RULE_ID$5, context);
         const rootTypeNames = [schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
             .filter(Boolean)
             .map(type => type.name);
@@ -3319,7 +3375,7 @@ const rule$l = {
                 if (validIds.length !== 1) {
                     context.report({
                         loc: getLocation(node.name.loc, typeName),
-                        messageId: RULE_ID$4,
+                        messageId: RULE_ID$5,
                         data: {
                             typeName,
                             acceptedNamesString: options.acceptedIdNames.join(', '),
@@ -3949,19 +4005,30 @@ class GraphQLRuleTester extends eslint.RuleTester {
         }
         const linter = new eslint.Linter();
         linter.defineRule(name, rule);
+        const hasOnlyTest = tests.invalid.some(t => t.only);
         for (const testCase of tests.invalid) {
+            const { only, code, filename } = testCase;
+            if (hasOnlyTest && !only) {
+                continue;
+            }
             const verifyConfig = getVerifyConfig(name, this.config, testCase);
             defineParser(linter, verifyConfig.parser);
-            const { code, filename } = testCase;
             const messages = linter.verify(code, verifyConfig, { filename });
-            for (const message of messages) {
+            const messageForSnapshot = [];
+            for (const [index, message] of messages.entries()) {
                 if (message.fatal) {
                     throw new Error(message.message);
                 }
-                const messageForSnapshot = visualizeEslintMessage(code, message);
-                // eslint-disable-next-line no-undef
-                expect(messageForSnapshot).toMatchSnapshot();
+                messageForSnapshot.push(`Error ${index + 1}/${messages.length}`, visualizeEslintMessage(code, message));
+            }
+            if (rule.meta.fixable) {
+                const { fixed, output } = linter.verifyAndFix(code, verifyConfig, { filename });
+                if (fixed) {
+                    messageForSnapshot.push('Autofix output', dedent(output));
+                }
             }
+            // eslint-disable-next-line no-undef
+            expect(messageForSnapshot.join('\n\n')).toMatchSnapshot();
         }
     }
 }

package/index.mjs

@@ -11,6 +11,7 @@ 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';
+import dedent from 'dedent';
 
 const base = {
     parser: '@graphql-eslint/eslint-plugin',
@@ -682,9 +683,13 @@ const argumentsEnum = [
 const rule = {
     meta: {
         type: 'suggestion',
+        fixable: 'code',
         docs: {
             category: ['Schema', 'Operations'],
-            description: 'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
+            description: [
+                'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
+                '> Note: autofix will work only for fields without comments (between or around)',
+            ].join('\n\n'),
             url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/alphabetize.md',
             examples: [
                 {
@@ -842,14 +847,20 @@ const rule = {
     },
     create(context) {
         var _a, _b, _c, _d, _e;
+        function isOnSameLineNodeAndComment(beforeNode, afterNode) {
+            return beforeNode.loc.end.line === afterNode.loc.start.line;
+        }
         function checkNodes(nodes) {
-            let prevName = null;
-            for (const node of nodes) {
-                const currName = node.name.value;
-                if (prevName && prevName > currName) {
-                    const isVariableNode = node.kind === Kind.VARIABLE;
+            // Starts from 1, ignore nodes.length <= 1
+            for (let i = 1; i < nodes.length; i += 1) {
+                const prevNode = nodes[i - 1];
+                const currNode = nodes[i];
+                const prevName = prevNode.name.value;
+                const currName = currNode.name.value;
+                if (prevName.localeCompare(currName) === 1) {
+                    const isVariableNode = currNode.kind === Kind.VARIABLE;
                     context.report({
-                        loc: getLocation(node.loc, node.name.value, { offsetEnd: isVariableNode ? 0 : 1 }),
+                        loc: getLocation(currNode.loc, currName, { offsetEnd: isVariableNode ? 0 : 1 }),
                         messageId: ALPHABETIZE,
                         data: isVariableNode
                             ? {
@@ -857,9 +868,28 @@ const rule = {
                                 prevName: `$${prevName}`,
                             }
                             : { currName, prevName },
+                        *fix(fixer) {
+                            const prev = prevNode;
+                            const curr = currNode;
+                            const sourceCode = context.getSourceCode();
+                            const beforeComments = sourceCode.getCommentsBefore(prev);
+                            if (beforeComments.length > 0) {
+                                const tokenBefore = sourceCode.getTokenBefore(prev);
+                                const lastBeforeComment = beforeComments.at(-1);
+                                if (!tokenBefore || !isOnSameLineNodeAndComment(tokenBefore, lastBeforeComment))
+                                    return;
+                            }
+                            const betweenComments = sourceCode.getCommentsBefore(curr);
+                            if (betweenComments.length > 0)
+                                return;
+                            const [firstAfterComment] = sourceCode.getCommentsAfter(curr);
+                            if (firstAfterComment && isOnSameLineNodeAndComment(curr, firstAfterComment))
+                                return;
+                            yield fixer.replaceText(prev, sourceCode.getText(curr));
+                            yield fixer.replaceText(curr, sourceCode.getText(prev));
+                        },
                     });
                 }
-                prevName = currName;
             }
         }
         const opts = context.options[0];
@@ -2619,20 +2649,21 @@ const rule$g = {
     },
 };
 
-const REQUIRE_DESCRIPTION_ERROR = 'REQUIRE_DESCRIPTION_ERROR';
+const RULE_ID$2 = 'require-description';
 const ALLOWED_KINDS$1 = [
     ...TYPES_KINDS,
     Kind.FIELD_DEFINITION,
     Kind.INPUT_VALUE_DEFINITION,
     Kind.ENUM_VALUE_DEFINITION,
     Kind.DIRECTIVE_DEFINITION,
+    Kind.OPERATION_DEFINITION,
 ];
 const rule$h = {
     meta: {
         docs: {
             category: 'Schema',
-            description: 'Enforce descriptions in your type definitions.',
-            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-description.md',
+            description: 'Enforce descriptions in type definitions and operations.',
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             examples: [
                 {
                     title: 'Incorrect',
@@ -2656,6 +2687,16 @@ const rule$h = {
               """
               name: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ OperationDefinition: true }],
+                    code: /* GraphQL */ `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
           `,
                 },
             ],
@@ -2669,7 +2710,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [REQUIRE_DESCRIPTION_ERROR]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
         },
         schema: {
             type: 'array',
@@ -2684,19 +2725,19 @@ const rule$h = {
                         type: 'boolean',
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => [
-                        kind,
-                        {
-                            type: 'boolean',
-                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
-                        },
-                    ])),
+                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => {
+                        let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+                        if (kind === Kind.OPERATION_DEFINITION) {
+                            description += '\n\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+                        }
+                        return [kind, { type: 'boolean', description }];
+                    })),
                 },
             },
         },
     },
     create(context) {
-        const { types, ...restOptions } = context.options[0];
+        const { types, ...restOptions } = context.options[0] || {};
         const kinds = new Set(types ? TYPES_KINDS : []);
         for (const [kind, isEnabled] of Object.entries(restOptions)) {
             if (isEnabled) {
@@ -2710,11 +2751,26 @@ const rule$h = {
         return {
             [selector](node) {
                 var _a;
-                const description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value) || '';
-                if (description.trim().length === 0) {
+                let description = '';
+                const isOperation = node.kind === Kind.OPERATION_DEFINITION;
+                if (isOperation) {
+                    const rawNode = node.rawNode();
+                    const { prev, line } = rawNode.loc.startToken;
+                    if (prev.kind === TokenKind.COMMENT) {
+                        const value = prev.value.trim();
+                        const linesBefore = line - prev.line;
+                        if (!value.startsWith('eslint') && linesBefore === 1) {
+                            description = value;
+                        }
+                    }
+                }
+                else {
+                    description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value.trim()) || '';
+                }
+                if (description.length === 0) {
                     context.report({
-                        loc: getLocation(node.name.loc, node.name.value),
-                        messageId: REQUIRE_DESCRIPTION_ERROR,
+                        loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
+                        messageId: RULE_ID$2,
                         data: {
                             nodeType: node.kind,
                         },
@@ -2890,7 +2946,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$2 = 'require-id-when-available';
+const RULE_ID$3 = 'require-id-when-available';
 const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
@@ -2899,7 +2955,7 @@ const rule$j = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2973,8 +3029,8 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$2, context);
-        const siblings = requireSiblingsOperations(RULE_ID$2, context);
+        requireGraphQLSchemaFromContext(RULE_ID$3, context);
+        const siblings = requireSiblingsOperations(RULE_ID$3, context);
         const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
         const idNames = asArray(fieldName);
         const isFound = (s) => s.kind === Kind.FIELD && idNames.includes(s.name.value);
@@ -3036,13 +3092,13 @@ const rule$j = {
     },
 };
 
-const RULE_ID$3 = 'selection-set-depth';
+const RULE_ID$4 = 'selection-set-depth';
 const rule$k = {
     meta: {
         docs: {
             category: 'Operations',
             description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3116,10 +3172,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$3, context);
+            siblings = requireSiblingsOperations(RULE_ID$4, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$3}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$4}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
         }
         const { maxDepth } = context.options[0];
         const ignore = context.options[0].ignore || [];
@@ -3144,14 +3200,14 @@ const rule$k = {
                     });
                 }
                 catch (e) {
-                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
+                    logger.warn(`Rule "${RULE_ID$4}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };
     },
 };
 
-const RULE_ID$4 = 'strict-id-in-types';
+const RULE_ID$5 = 'strict-id-in-types';
 const rule$l = {
     meta: {
         type: 'suggestion',
@@ -3159,7 +3215,7 @@ const rule$l = {
             description: `Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.`,
             category: 'Schema',
             recommended: true,
-            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$5}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -3273,7 +3329,7 @@ const rule$l = {
             },
         },
         messages: {
-            [RULE_ID$4]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
+            [RULE_ID$5]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
         },
     },
     create(context) {
@@ -3283,7 +3339,7 @@ const rule$l = {
             exceptions: {},
             ...context.options[0],
         };
-        const schema = requireGraphQLSchemaFromContext(RULE_ID$4, context);
+        const schema = requireGraphQLSchemaFromContext(RULE_ID$5, context);
         const rootTypeNames = [schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
             .filter(Boolean)
             .map(type => type.name);
@@ -3313,7 +3369,7 @@ const rule$l = {
                 if (validIds.length !== 1) {
                     context.report({
                         loc: getLocation(node.name.loc, typeName),
-                        messageId: RULE_ID$4,
+                        messageId: RULE_ID$5,
                         data: {
                             typeName,
                             acceptedNamesString: options.acceptedIdNames.join(', '),
@@ -3943,19 +3999,30 @@ class GraphQLRuleTester extends RuleTester {
         }
         const linter = new Linter();
         linter.defineRule(name, rule);
+        const hasOnlyTest = tests.invalid.some(t => t.only);
         for (const testCase of tests.invalid) {
+            const { only, code, filename } = testCase;
+            if (hasOnlyTest && !only) {
+                continue;
+            }
             const verifyConfig = getVerifyConfig(name, this.config, testCase);
             defineParser(linter, verifyConfig.parser);
-            const { code, filename } = testCase;
             const messages = linter.verify(code, verifyConfig, { filename });
-            for (const message of messages) {
+            const messageForSnapshot = [];
+            for (const [index, message] of messages.entries()) {
                 if (message.fatal) {
                     throw new Error(message.message);
                 }
-                const messageForSnapshot = visualizeEslintMessage(code, message);
-                // eslint-disable-next-line no-undef
-                expect(messageForSnapshot).toMatchSnapshot();
+                messageForSnapshot.push(`Error ${index + 1}/${messages.length}`, visualizeEslintMessage(code, message));
+            }
+            if (rule.meta.fixable) {
+                const { fixed, output } = linter.verifyAndFix(code, verifyConfig, { filename });
+                if (fixed) {
+                    messageForSnapshot.push('Autofix output', dedent(output));
+                }
             }
+            // eslint-disable-next-line no-undef
+            expect(messageForSnapshot.join('\n\n')).toMatchSnapshot();
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.7.0",
+  "version": "3.8.0-alpha-a8fcc7b.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
@@ -12,6 +12,7 @@
     "@graphql-tools/graphql-tag-pluck": "7.1.5",
     "@graphql-tools/utils": "8.6.1",
     "chalk": "4.1.2",
+    "dedent": "0.7.0",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",
     "lodash.lowercase": "4.3.0"

package/rules/alphabetize.d.ts

@@ -4,7 +4,7 @@ declare const valuesEnum: ['EnumTypeDefinition'];
 declare const selectionsEnum: ('OperationDefinition' | 'FragmentDefinition')[];
 declare const variablesEnum: ['OperationDefinition'];
 declare const argumentsEnum: ('FieldDefinition' | 'Field' | 'DirectiveDefinition' | 'Directive')[];
-declare type AlphabetizeConfig = {
+export declare type AlphabetizeConfig = {
     fields?: typeof fieldsEnum;
     values?: typeof valuesEnum;
     selections?: typeof selectionsEnum;

package/rules/index.d.ts

@@ -1,11 +1,5 @@
 export declare const rules: {
-    alphabetize: import("..").GraphQLESLintRule<[{
-        fields?: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[];
-        values?: ["EnumTypeDefinition"];
-        selections?: ("OperationDefinition" | "FragmentDefinition")[];
-        variables?: ["OperationDefinition"];
-        arguments?: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[];
-    }], false>;
+    alphabetize: import("..").GraphQLESLintRule<[import("./alphabetize").AlphabetizeConfig], false>;
     'description-style': import("..").GraphQLESLintRule<[{
         style: "block" | "inline";
     }], false>;
@@ -33,20 +27,7 @@ export declare const rules: {
         argumentName?: string;
     }], false>;
     'require-deprecation-reason': import("..").GraphQLESLintRule<any[], false>;
-    'require-description': import("..").GraphQLESLintRule<[{
-        types?: boolean;
-    } & {
-        ScalarTypeDefinition?: boolean;
-        ObjectTypeDefinition?: boolean;
-        FieldDefinition?: boolean;
-        InputValueDefinition?: boolean;
-        InterfaceTypeDefinition?: boolean;
-        UnionTypeDefinition?: boolean;
-        EnumTypeDefinition?: boolean;
-        EnumValueDefinition?: boolean;
-        InputObjectTypeDefinition?: boolean;
-        DirectiveDefinition?: boolean;
-    }], false>;
+    'require-description': import("..").GraphQLESLintRule<[import("./require-description").RequireDescriptionRuleConfig], false>;
     'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
     'require-id-when-available': import("..").GraphQLESLintRule<[import("./require-id-when-available").RequireIdWhenAvailableRuleConfig], true>;
     'selection-set-depth': import("..").GraphQLESLintRule<[{

package/rules/require-description.d.ts

@@ -1,8 +1,8 @@
 import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../types';
-declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.DIRECTIVE_DEFINITION];
+declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.OPERATION_DEFINITION];
 declare type AllowedKind = typeof ALLOWED_KINDS[number];
-declare type RequireDescriptionRuleConfig = {
+export declare type RequireDescriptionRuleConfig = {
     types?: boolean;
 } & {
     [key in AllowedKind]?: boolean;

package/testkit.d.ts

@@ -6,7 +6,6 @@ export declare type GraphQLESLintRuleListener<WithTypeInfo extends boolean = fal
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 } & Record<string, any>;
 export declare type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
-    name?: string;
     options?: Options;
     parserOptions?: ParserOptions;
 };