fix: adjust report location for require-description rule (#722)

dimaMachina · Oct 27, 2021 · eb4a851 · eb4a851
1 parent a5c430a
commit eb4a851
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 11 deletions.
diff --git a/.changeset/twelve-grapes-provide.md b/.changeset/twelve-grapes-provide.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix: adjust report location for `require-description` rule
diff --git a/packages/plugin/src/rules/avoid-operation-name-prefix.ts b/packages/plugin/src/rules/avoid-operation-name-prefix.ts
@@ -78,15 +78,16 @@ const rule: GraphQLESLintRule<AvoidOperationNamePrefixConfig> = {
             const testName = caseSensitive ? node.name.value : node.name.value.toLowerCase();
 
             if (testName.startsWith(testKeyword)) {
+              const { start } = node.name.loc;
               context.report({
                 loc: {
                   start: {
-                    line: node.name.loc.start.line,
-                    column: node.name.loc.start.column - 1,
+                    line: start.line,
+                    column: start.column - 1,
                   },
                   end: {
-                    line: node.name.loc.start.line,
-                    column: node.name.loc.start.column + testKeyword.length - 1,
+                    line: start.line,
+                    column: start.column - 1 + testKeyword.length,
                   },
                 },
                 data: {

diff --git a/packages/plugin/src/rules/require-description.ts b/packages/plugin/src/rules/require-description.ts
@@ -1,6 +1,6 @@
-import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext, ValueOf } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser/estree-ast';
-import { ASTNode, Kind, StringValueNode } from 'graphql';
+import { ASTKindToNode, Kind, StringValueNode } from 'graphql';
 
 const REQUIRE_DESCRIPTION_ERROR = 'REQUIRE_DESCRIPTION_ERROR';
 const DESCRIBABLE_NODES = [
@@ -17,23 +17,30 @@ const DESCRIBABLE_NODES = [
 ];
 type RequireDescriptionRuleConfig = [{ on: typeof DESCRIBABLE_NODES }];
 
+type AllowedKind = typeof DESCRIBABLE_NODES[number];
+type AllowedKindToNode = Pick<ASTKindToNode, AllowedKind>;
+
 function verifyRule(
   context: GraphQLESLintRuleContext<RequireDescriptionRuleConfig>,
-  node: GraphQLESTreeNode<ASTNode> & {
+  node: GraphQLESTreeNode<ValueOf<AllowedKindToNode>> & {
     readonly description?: GraphQLESTreeNode<StringValueNode>;
   }
 ) {
   if (node) {
     if (!node.description || !node.description.value || node.description.value.trim().length === 0) {
+      const { start, end } = ('name' in node ? node.name : node).loc;
+
       context.report({
         loc: {
           start: {
-            line: node.loc.start.line,
-            column: node.loc.start.column - 1,
+            line: start.line,
+            column: start.column - 1,
           },
           end: {
-            line: node.loc.end.line,
-            column: node.loc.end.column,
+            line: end.line,
+            column:
+              // node.name don't exist on SchemaDefinition
+              'name' in node ? end.column - 1 + node.name.value.length : end.column,
           },
         },
         messageId: REQUIRE_DESCRIPTION_ERROR,

diff --git a/packages/plugin/src/types.ts b/packages/plugin/src/types.ts
@@ -66,3 +66,5 @@ export type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = fa
   create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
   meta: Rule.RuleMetaData & RuleDocsInfo<Options>;
 };
+
+export type ValueOf<T> = T[keyof T];