@graphql-eslint/eslint-plugin 3.7.0-alpha-a9b0ecf.0 → 3.7.0

package/docs/rules/require-description.md

@@ -37,17 +37,6 @@ type someTypeName {
 }
 ```
 
-### Correct
-
-```graphql
-# eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
-
-# Enforce description on operations
-query {
-  foo
-}
-```
-
 ## Config Schema
 
 The schema defines the following properties:
@@ -95,10 +84,6 @@ 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).
-
 ### `ScalarTypeDefinition` (boolean)
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).

package/index.js

@@ -2625,21 +2625,20 @@ const rule$g = {
     },
 };
 
-const RULE_ID$2 = 'require-description';
+const REQUIRE_DESCRIPTION_ERROR = 'REQUIRE_DESCRIPTION_ERROR';
 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/${RULE_ID$2}.md`,
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-description.md',
             examples: [
                 {
                     title: 'Incorrect',
@@ -2663,16 +2662,6 @@ const rule$h = {
               """
               name: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ OperationDefinition: true }],
-                    code: /* GraphQL */ `
-            # Enforce description on operations
-            query {
-              foo
-            }
           `,
                 },
             ],
@@ -2686,7 +2675,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [REQUIRE_DESCRIPTION_ERROR]: 'Description is required for nodes of type "{{ nodeType }}"',
         },
         schema: {
             type: 'array',
@@ -2713,7 +2702,7 @@ const rule$h = {
         },
     },
     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) {
@@ -2727,26 +2716,11 @@ const rule$h = {
         return {
             [selector](node) {
                 var _a;
-                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) {
+                const description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value) || '';
+                if (description.trim().length === 0) {
                     context.report({
-                        loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
-                        messageId: RULE_ID$2,
+                        loc: getLocation(node.name.loc, node.name.value),
+                        messageId: REQUIRE_DESCRIPTION_ERROR,
                         data: {
                             nodeType: node.kind,
                         },
@@ -2922,7 +2896,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$3 = 'require-id-when-available';
+const RULE_ID$2 = 'require-id-when-available';
 const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
@@ -2931,7 +2905,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$3}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -3005,8 +2979,8 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$3, context);
-        const siblings = requireSiblingsOperations(RULE_ID$3, context);
+        requireGraphQLSchemaFromContext(RULE_ID$2, context);
+        const siblings = requireSiblingsOperations(RULE_ID$2, 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);
@@ -3068,13 +3042,13 @@ const rule$j = {
     },
 };
 
-const RULE_ID$4 = 'selection-set-depth';
+const RULE_ID$3 = '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$4}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3148,10 +3122,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$4, context);
+            siblings = requireSiblingsOperations(RULE_ID$3, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$4}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$3}" 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 || [];
@@ -3176,14 +3150,14 @@ const rule$k = {
                     });
                 }
                 catch (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);
+                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };
     },
 };
 
-const RULE_ID$5 = 'strict-id-in-types';
+const RULE_ID$4 = 'strict-id-in-types';
 const rule$l = {
     meta: {
         type: 'suggestion',
@@ -3191,7 +3165,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$5}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -3305,7 +3279,7 @@ const rule$l = {
             },
         },
         messages: {
-            [RULE_ID$5]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
+            [RULE_ID$4]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
         },
     },
     create(context) {
@@ -3315,7 +3289,7 @@ const rule$l = {
             exceptions: {},
             ...context.options[0],
         };
-        const schema = requireGraphQLSchemaFromContext(RULE_ID$5, context);
+        const schema = requireGraphQLSchemaFromContext(RULE_ID$4, context);
         const rootTypeNames = [schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
             .filter(Boolean)
             .map(type => type.name);
@@ -3345,7 +3319,7 @@ const rule$l = {
                 if (validIds.length !== 1) {
                     context.report({
                         loc: getLocation(node.name.loc, typeName),
-                        messageId: RULE_ID$5,
+                        messageId: RULE_ID$4,
                         data: {
                             typeName,
                             acceptedNamesString: options.acceptedIdNames.join(', '),
@@ -3775,6 +3749,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,21 +2619,20 @@ const rule$g = {
     },
 };
 
-const RULE_ID$2 = 'require-description';
+const REQUIRE_DESCRIPTION_ERROR = 'REQUIRE_DESCRIPTION_ERROR';
 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/${RULE_ID$2}.md`,
+            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-description.md',
             examples: [
                 {
                     title: 'Incorrect',
@@ -2657,16 +2656,6 @@ const rule$h = {
               """
               name: String
             }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ OperationDefinition: true }],
-                    code: /* GraphQL */ `
-            # Enforce description on operations
-            query {
-              foo
-            }
           `,
                 },
             ],
@@ -2680,7 +2669,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [REQUIRE_DESCRIPTION_ERROR]: 'Description is required for nodes of type "{{ nodeType }}"',
         },
         schema: {
             type: 'array',
@@ -2707,7 +2696,7 @@ const rule$h = {
         },
     },
     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) {
@@ -2721,26 +2710,11 @@ const rule$h = {
         return {
             [selector](node) {
                 var _a;
-                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) {
+                const description = ((_a = node.description) === null || _a === void 0 ? void 0 : _a.value) || '';
+                if (description.trim().length === 0) {
                     context.report({
-                        loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
-                        messageId: RULE_ID$2,
+                        loc: getLocation(node.name.loc, node.name.value),
+                        messageId: REQUIRE_DESCRIPTION_ERROR,
                         data: {
                             nodeType: node.kind,
                         },
@@ -2916,7 +2890,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
     }
 };
 
-const RULE_ID$3 = 'require-id-when-available';
+const RULE_ID$2 = 'require-id-when-available';
 const MESSAGE_ID = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
 const rule$j = {
@@ -2925,7 +2899,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$3}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [
@@ -2999,8 +2973,8 @@ const rule$j = {
         },
     },
     create(context) {
-        requireGraphQLSchemaFromContext(RULE_ID$3, context);
-        const siblings = requireSiblingsOperations(RULE_ID$3, context);
+        requireGraphQLSchemaFromContext(RULE_ID$2, context);
+        const siblings = requireSiblingsOperations(RULE_ID$2, 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);
@@ -3062,13 +3036,13 @@ const rule$j = {
     },
 };
 
-const RULE_ID$4 = 'selection-set-depth';
+const RULE_ID$3 = '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$4}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$3}.md`,
             requiresSiblings: true,
             examples: [
                 {
@@ -3142,10 +3116,10 @@ const rule$k = {
     create(context) {
         let siblings = null;
         try {
-            siblings = requireSiblingsOperations(RULE_ID$4, context);
+            siblings = requireSiblingsOperations(RULE_ID$3, context);
         }
         catch (e) {
-            logger.warn(`Rule "${RULE_ID$4}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`);
+            logger.warn(`Rule "${RULE_ID$3}" 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 || [];
@@ -3170,14 +3144,14 @@ const rule$k = {
                     });
                 }
                 catch (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);
+                    logger.warn(`Rule "${RULE_ID$3}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`, e);
                 }
             },
         };
     },
 };
 
-const RULE_ID$5 = 'strict-id-in-types';
+const RULE_ID$4 = 'strict-id-in-types';
 const rule$l = {
     meta: {
         type: 'suggestion',
@@ -3185,7 +3159,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$5}.md`,
+            url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$4}.md`,
             requiresSchema: true,
             examples: [
                 {
@@ -3299,7 +3273,7 @@ const rule$l = {
             },
         },
         messages: {
-            [RULE_ID$5]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
+            [RULE_ID$4]: `{{ typeName }} must have exactly one non-nullable unique identifier. Accepted name(s): {{ acceptedNamesString }}; Accepted type(s): {{ acceptedTypesString }}.`,
         },
     },
     create(context) {
@@ -3309,7 +3283,7 @@ const rule$l = {
             exceptions: {},
             ...context.options[0],
         };
-        const schema = requireGraphQLSchemaFromContext(RULE_ID$5, context);
+        const schema = requireGraphQLSchemaFromContext(RULE_ID$4, context);
         const rootTypeNames = [schema.getQueryType(), schema.getMutationType(), schema.getSubscriptionType()]
             .filter(Boolean)
             .map(type => type.name);
@@ -3339,7 +3313,7 @@ const rule$l = {
                 if (validIds.length !== 1) {
                     context.report({
                         loc: getLocation(node.name.loc, typeName),
-                        messageId: RULE_ID$5,
+                        messageId: RULE_ID$4,
                         data: {
                             typeName,
                             acceptedNamesString: options.acceptedIdNames.join(', '),
@@ -3769,6 +3743,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.7.0-alpha-a9b0ecf.0",
+  "version": "3.7.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/rules/index.d.ts

@@ -33,7 +33,20 @@ export declare const rules: {
         argumentName?: string;
     }], false>;
     'require-deprecation-reason': import("..").GraphQLESLintRule<any[], false>;
-    'require-description': import("..").GraphQLESLintRule<[import("./require-description").RequireDescriptionRuleConfig], 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-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, Kind.OPERATION_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];
 declare type AllowedKind = typeof ALLOWED_KINDS[number];
-export declare type RequireDescriptionRuleConfig = {
+declare type RequireDescriptionRuleConfig = {
     types?: boolean;
 } & {
     [key in AllowedKind]?: boolean;