return code as-is in preprocess in case of parsing error, sort eslint/graphql-eslint errors in postprocess by line/column (#1168)

Author: dimaMachina

.changeset/little-hounds-kick.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+return code as-is in `preprocess` in case of parsing error, sort eslint/graphql-eslint errors in `postprocess` by line/column

packages/plugin/src/processor.ts

@@ -39,24 +39,30 @@ export const processor: Linter.Processor<Block | string> = {
     if (RELEVANT_KEYWORDS.every(keyword => !code.includes(keyword))) {
       return [code];
     }
-    const extractedDocuments = parseCode({
-      code,
-      filePath,
-      options: {
-        skipIndent: true,
-        ...graphQLTagPluckOptions,
-      },
-    });
 
-    const blocks: Block[] = extractedDocuments.map(item => ({
-      filename: 'document.graphql',
-      text: item.content,
-      lineOffset: item.loc.start.line - 1,
-      offset: item.start + 1,
-    }));
-    blocksMap.set(filePath, blocks);
+    try {
+      const extractedDocuments = parseCode({
+        code,
+        filePath,
+        options: {
+          skipIndent: true,
+          ...graphQLTagPluckOptions,
+        },
+      });
 
-    return [...blocks, code /* source code must be provided and be last */];
+      const blocks: Block[] = extractedDocuments.map(item => ({
+        filename: 'document.graphql',
+        text: item.content,
+        lineOffset: item.loc.start.line - 1,
+        offset: item.start + 1,
+      }));
+      blocksMap.set(filePath, blocks);
+
+      return [...blocks, code /* source code must be provided and be last */];
+    } catch {
+      // in case of parsing error return code as is
+      return [code];
+    }
   },
   postprocess(messages, filePath) {
     const blocks = blocksMap.get(filePath) || [];
@@ -80,6 +86,8 @@ export const processor: Linter.Processor<Block | string> = {
       }
     }
 
-    return messages.flat();
+    const result = messages.flat();
+    // sort eslint/graphql-eslint messages by line/column
+    return result.sort((a, b) => a.line - b.line || a.column - b.column);
   },
 };

packages/plugin/tests/__snapshots__/examples.spec.md

@@ -32,16 +32,6 @@ exports[`Examples should work in monorepo 1`] = `
   {
     filePath: examples/monorepo/client/pages/index.tsx,
     messages: [
-      {
-        column: 9,
-        endColumn: 18,
-        endLine: 9,
-        line: 9,
-        message: Cannot query field "firstname" on type "User". Did you mean "firstName" or "lastName"?,
-        nodeType: null,
-        ruleId: @graphql-eslint/fields-on-correct-type,
-        severity: 2,
-      },
       {
         column: 7,
         endColumn: 16,
@@ -53,6 +43,16 @@ exports[`Examples should work in monorepo 1`] = `
         ruleId: no-unused-vars,
         severity: 2,
       },
+      {
+        column: 9,
+        endColumn: 18,
+        endLine: 9,
+        line: 9,
+        message: Cannot query field "firstname" on type "User". Did you mean "firstName" or "lastName"?,
+        nodeType: null,
+        ruleId: @graphql-eslint/fields-on-correct-type,
+        severity: 2,
+      },
     ],
   },
   {
@@ -805,6 +805,28 @@ exports[`Examples should work with \`graphql-config\` on \`.js\` files 1`] = `
   {
     filePath: examples/graphql-config-code-file/query.js,
     messages: [
+      {
+        column: 13,
+        endColumn: 20,
+        endLine: 1,
+        line: 1,
+        message: 'require' is not defined.,
+        messageId: undef,
+        nodeType: Identifier,
+        ruleId: no-undef,
+        severity: 2,
+      },
+      {
+        column: 7,
+        endColumn: 15,
+        endLine: 3,
+        line: 3,
+        message: 'GET_USER' is assigned a value but never used.,
+        messageId: unusedVar,
+        nodeType: Identifier,
+        ruleId: no-unused-vars,
+        severity: 2,
+      },
       {
         column: 3,
         endColumn: 8,
@@ -850,28 +872,6 @@ Include it in your selection set.,
           },
         ],
       },
-      {
-        column: 13,
-        endColumn: 20,
-        endLine: 1,
-        line: 1,
-        message: 'require' is not defined.,
-        messageId: undef,
-        nodeType: Identifier,
-        ruleId: no-undef,
-        severity: 2,
-      },
-      {
-        column: 7,
-        endColumn: 15,
-        endLine: 3,
-        line: 3,
-        message: 'GET_USER' is assigned a value but never used.,
-        messageId: unusedVar,
-        nodeType: Identifier,
-        ruleId: no-unused-vars,
-        severity: 2,
-      },
     ],
   },
 ]