Fix broken report highlighting when processor is used (#1040)

dimaMachina · web-flow · commit 8a3b5843f2aa · 2022-04-23T19:52:39.000+02:00
* fix processor report on code files

* remove tests on eslint 7

* apply fix

* more errors

* fix `message.endLine`

* fix parser error column location

* add changeset
diff --git a/.changeset/dry-zoos-whisper.md b/.changeset/dry-zoos-whisper.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix broken report highlighting when processor is used
diff --git a/.github/workflows/canary.yml b/.github/workflows/canary.yml
@@ -50,18 +50,18 @@ jobs:
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-16-8-16-node-modules-
+            ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-16-16-node-modules-
 
       - name: Install Dependencies
         run: yarn
 
       - name: Release Canary
         id: canary
         uses: kamilkisiela/release-canary@master
-        if: github.repository == 'B2o5T/graphql-eslint'
+        if: github.repository == B2o5T/graphql-eslint
         with:
           npm-token: ${{secrets.NODE_AUTH_TOKEN}}
           npm-script: 'yarn release:canary'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,8 +1,8 @@
 name: Release
 on:
   push:
-    branches:
-      - master
+    branches: [master]
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -40,10 +40,10 @@ jobs:
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-16-8-16-node-modules-
+            ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-16-16-node-modules-
 
       - name: Install Dependencies
         run: yarn
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -25,10 +25,10 @@ jobs:
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-8-16-node-modules-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-16-8-16-node-modules-
+            ${{runner.os}}-16-16-node-modules-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-16-16-node-modules-
 
       - name: Install Dependencies
         run: yarn
@@ -58,10 +58,10 @@ jobs:
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-16-8-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-16-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-16-8-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-16-8-${{matrix.graphql_version}}-node-modules-
+            ${{runner.os}}-16-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-16-${{matrix.graphql_version}}-node-modules-
 
       - name: Use GraphQL v${{matrix.graphql_version}}
         run: node ./scripts/match-graphql.mjs ${{matrix.graphql_version}}
@@ -79,14 +79,13 @@ jobs:
           path: packages/plugin/dist
 
   test:
-    name: Testing on Node ${{matrix.node_version}} with ESLint v${{matrix.eslint_version}} and GraphQL v${{matrix.graphql_version}}
+    name: Testing on Node ${{matrix.node_version}} with GraphQL v${{matrix.graphql_version}} and ESLint v8
     timeout-minutes: 60
     runs-on: ubuntu-latest
     needs: [typecheck]
     strategy:
       matrix:
         node_version: [12, 16]
-        eslint_version: [7.32.0, 8]
         graphql_version: [15, 16]
 
     steps:
@@ -104,28 +103,25 @@ jobs:
         uses: actions/cache@v3
         with:
           path: '**/node_modules'
-          key: ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-${{matrix.node_version}}-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-${{matrix.graphql_version}}-node-modules-
+            ${{runner.os}}-${{matrix.node_version}}-${{matrix.graphql_version}}-node-modules-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-${{matrix.node_version}}-${{matrix.graphql_version}}-node-modules-
 
       - name: Use GraphQL v${{matrix.graphql_version}}
         run: node scripts/match-graphql.mjs ${{matrix.graphql_version}}
 
-      - name: Use ESLint v${{matrix.eslint_version}}
-        run: node scripts/match-eslint.mjs ${{matrix.eslint_version}}
-
       - name: Install Dependencies
         run: yarn
 
       - name: Cache Jest
         uses: actions/cache@v3
         with:
           path: .cache/jest
-          key: ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-jest-${{hashFiles('yarn.lock')}}
+          key: ${{runner.os}}-${{matrix.node_version}}-jest-${{hashFiles('yarn.lock')}}
           restore-keys: |
-            ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-jest-${{hashFiles('yarn.lock')}}
-            ${{runner.os}}-${{matrix.node_version}}-${{matrix.eslint_version}}-jest-
+            ${{runner.os}}-${{matrix.node_version}}-jest-${{hashFiles('yarn.lock')}}
+            ${{runner.os}}-${{matrix.node_version}}-jest-
 
       # We need build for examples.spec.ts test
       # Otherwise we'll get error - Cannot find module 'node_modules/@graphql-eslint/eslint-plugin/dist/index.js'
diff --git a/examples/basic/.eslintrc.cjs b/examples/basic/.eslintrc.cjs
@@ -4,9 +4,6 @@ module.exports = {
     {
       files: ['*.js'],
       extends: ['eslint:recommended'],
-      env: {
-        node: true,
-      },
     },
     {
       files: ['*.graphql'],
diff --git a/examples/code-file/.eslintrc.cjs b/examples/code-file/.eslintrc.cjs
@@ -6,7 +6,6 @@ module.exports = {
       processor: '@graphql-eslint/graphql',
       extends: ['eslint:recommended'],
       env: {
-        node: true,
         es6: true,
       },
       rules: {
diff --git a/examples/graphql-config-code-file/.eslintrc.cjs b/examples/graphql-config-code-file/.eslintrc.cjs
@@ -6,7 +6,6 @@ module.exports = {
       processor: '@graphql-eslint/graphql',
       extends: ['eslint:recommended'],
       env: {
-        node: true,
         es6: true,
       },
     },
diff --git a/examples/graphql-config-code-file/query.js b/examples/graphql-config-code-file/query.js
@@ -1,6 +1,5 @@
 const gql = require('graphql-tag');
 
-// eslint-disable-next-line no-unused-vars
 const GET_USER = gql`
   query {
     user {
diff --git a/examples/graphql-config/.eslintrc.cjs b/examples/graphql-config/.eslintrc.cjs
@@ -4,9 +4,6 @@ module.exports = {
     {
       files: ['*.js'],
       extends: ['eslint:recommended'],
-      env: {
-        node: true,
-      },
     },
     {
       files: ['*.graphql'],
diff --git a/examples/prettier/.eslintrc.cjs b/examples/prettier/.eslintrc.cjs
@@ -6,7 +6,6 @@ module.exports = {
       processor: '@graphql-eslint/graphql',
       extends: ['eslint:recommended', 'plugin:prettier/recommended'],
       env: {
-        node: true,
         es6: true,
       },
     },
diff --git a/packages/plugin/src/parser.ts b/packages/plugin/src/parser.ts
@@ -55,7 +55,7 @@ export function parseForESLint(code: string, options: ParserOptions = {}): Graph
       const eslintError = {
         index: error.positions[0],
         lineNumber: error.locations[0].line,
-        column: error.locations[0].column,
+        column: error.locations[0].column - 1,
         message: error.message,
       };
       throw eslintError;
diff --git a/packages/plugin/src/processor.ts b/packages/plugin/src/processor.ts
@@ -6,7 +6,7 @@ type Block = Linter.ProcessorFile & {
   offset: number;
 };
 
-const RELEVANT_KEYWORDS = ['gql`', 'graphql`', '/* GraphQL */'] as const;
+const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'] as const;
 const blocksMap = new Map<string, Block[]>();
 
 export const processor: Linter.Processor<Block | string> = {
@@ -32,7 +32,7 @@ export const processor: Linter.Processor<Block | string> = {
     }));
     blocksMap.set(filePath, blocks);
 
-    return [code, ...blocks];
+    return [...blocks, code /* source code must be provided and be last */];
   },
   postprocess(messages, filePath) {
     const blocks = blocksMap.get(filePath) || [];
@@ -41,7 +41,10 @@ export const processor: Linter.Processor<Block | string> = {
 
       for (const message of messages[i]) {
         message.line += lineOffset;
-        message.endLine += lineOffset;
+        // endLine can not exist if only `loc: { start, column }` was provided to context.report
+        if (typeof message.endLine === 'number') {
+          message.endLine += lineOffset;
+        }
         if (message.fix) {
           message.fix.range[0] += offset;
           message.fix.range[1] += offset;
diff --git a/packages/plugin/tests/__snapshots__/examples.spec.md b/packages/plugin/tests/__snapshots__/examples.spec.md
diff --git a/packages/plugin/tests/examples.spec.ts b/packages/plugin/tests/examples.spec.ts
diff --git a/patches/eslint+8.14.0.patch b/patches/eslint+8.14.0.patch
diff --git a/scripts/match-eslint.mjs b/scripts/match-eslint.mjs

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': patch
 +---
++
 +fix broken report highlighting when processor is used
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@ module.exports = {`
`4`	`4`	`{`
`5`	`5`	`files: ['*.js'],`
`6`	`6`	`extends: ['eslint:recommended'],`
`7`		`- env: {`
`8`		`- node: true,`
`9`		`- },`
`10`	`7`	`},`
`11`	`8`	`{`
`12`	`9`	`files: ['*.graphql'],`