fix error report for description-style rule (#741)

Dimitri POSTOLOV · web-flow · commit 46f03f7cf5fc · 2021-10-31T17:45:34.000+02:00
diff --git a/.changeset/rich-cougars-sort.md b/.changeset/rich-cougars-sort.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix error report for `description-style` rule
diff --git a/packages/plugin/src/rules/description-style.ts b/packages/plugin/src/rules/description-style.ts
@@ -1,4 +1,5 @@
 import { GraphQLESLintRule } from '../types';
+import { getLocation } from '../utils';
 
 type DescriptionStyleRuleConfig = [
   {
@@ -58,7 +59,7 @@ const rule: GraphQLESLintRule<DescriptionStyleRuleConfig> = {
       '[description.type="StringValue"]': node => {
         if (node.description.block !== (style === 'block')) {
           context.report({
-            node: node.description,
+            loc: getLocation(node.description.loc),
             message: `Unexpected ${wrongDescriptionType} description`,
           });
         }
diff --git a/packages/plugin/tests/__snapshots__/description-style.spec.ts.snap b/packages/plugin/tests/__snapshots__/description-style.spec.ts.snap
@@ -4,7 +4,7 @@ exports[` 1`] = `
    1 |
    2 |   enum EnumUserLanguagesSkill {
 >  3 |     """
-     |      ^ Unexpected block description
+     |     ^ Unexpected block description
    4 |     basic
    5 |     """
    6 |     basic
@@ -28,7 +28,7 @@ exports[` 2`] = `
    5 |     """
    6 |     basic
 >  7 |     """
-     |      ^ Unexpected block description
+     |     ^ Unexpected block description
    8 |     fluent
    9 |     """
   10 |     fluent
@@ -52,7 +52,7 @@ exports[` 3`] = `
    9 |     """
   10 |     fluent
 > 11 |     """
-     |      ^ Unexpected block description
+     |     ^ Unexpected block description
   12 |     native
   13 |     """
   14 |     native
@@ -63,7 +63,7 @@ exports[` 3`] = `
 exports[` 4`] = `
    1 |
 >  2 |   " Test "
-     |    ^ Unexpected inline description
+     |   ^ Unexpected inline description
    3 |   type CreateOneUserPayload {
    4 |     "Created document ID"
    5 |     recordId: MongoID
@@ -79,7 +79,7 @@ exports[` 5`] = `
    2 |   " Test "
    3 |   type CreateOneUserPayload {
 >  4 |     "Created document ID"
-     |      ^ Unexpected inline description
+     |     ^ Unexpected inline description
    5 |     recordId: MongoID
    6 |
    7 |     "Created document"
@@ -96,7 +96,7 @@ exports[` 6`] = `
    5 |     recordId: MongoID
    6 |
 >  7 |     "Created document"
-     |      ^ Unexpected inline description
+     |     ^ Unexpected inline description
    8 |     record: User
    9 |   }
   10 |

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': patch
 +---
++
 +fix error report for `description-style` rule
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import { GraphQLESLintRule } from '../types';`
	`2`	`+import { getLocation } from '../utils';`
`2`	`3`
`3`	`4`	`type DescriptionStyleRuleConfig = [`
`4`	`5`	`{`
`@@ -58,7 +59,7 @@ const rule: GraphQLESLintRule<DescriptionStyleRuleConfig> = {`
`58`	`59`	`'[description.type="StringValue"]': node => {`
`59`	`60`	`if (node.description.block !== (style === 'block')) {`
`60`	`61`	`context.report({`
`61`		`- node: node.description,`
	`62`	`+ loc: getLocation(node.description.loc),`
`62`	`63`	message: `Unexpected ${wrongDescriptionType} description`,
`63`	`64`	`});`
`64`	`65`	`}`