@graphql-eslint/eslint-plugin 3.6.0 → 3.8.0-alpha-c1d1797.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/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

@@ -2625,20 +2625,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 +2663,16 @@ const rule$h = {
               """
               name: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ OperationDefinition: true }],
+                    code: /* GraphQL */ `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
           `,
                 },
             ],
@@ -2675,7 +2686,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 +2701,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 +2727,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 +2922,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 +2931,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 +3005,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 +3068,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 +3148,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 +3176,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 +3191,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 +3305,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 +3315,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 +3345,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(', '),
@@ -3749,6 +3775,8 @@ function loadGraphQLConfig(options) {
     const onDiskConfig = options.skipGraphQLConfig
         ? null
         : graphqlConfig.loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? path.dirname(options.filePath) : undefined,
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],

package/index.mjs

@@ -2619,20 +2619,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 +2657,16 @@ const rule$h = {
               """
               name: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ OperationDefinition: true }],
+                    code: /* GraphQL */ `
+            # Create a new user
+            mutation createUser {
+              # ...
+            }
           `,
                 },
             ],
@@ -2669,7 +2680,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 +2695,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 +2721,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 +2916,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 +2925,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 +2999,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 +3062,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 +3142,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 +3170,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 +3185,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 +3299,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 +3309,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 +3339,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(', '),
@@ -3743,6 +3769,8 @@ function loadGraphQLConfig(options) {
     const onDiskConfig = options.skipGraphQLConfig
         ? null
         : loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? dirname(options.filePath) : undefined,
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.6.0",
+  "version": "3.8.0-alpha-c1d1797.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {
@@ -9,8 +9,8 @@
   "dependencies": {
     "@babel/code-frame": "7.16.7",
     "@graphql-tools/code-file-loader": "7.2.3",
-    "@graphql-tools/graphql-tag-pluck": "7.1.4",
-    "@graphql-tools/utils": "8.5.5",
+    "@graphql-tools/graphql-tag-pluck": "7.1.5",
+    "@graphql-tools/utils": "8.6.1",
     "chalk": "4.1.2",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",

package/rules/index.d.ts

@@ -33,20 +33,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;