fix: processor should always return code string in preprocess method (#1023)

Author: dimaMachina

.changeset/seven-dogs-press.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix: processor should always return code string in preprocess method

docs/custom-rules.md

@@ -118,7 +118,7 @@ export const rule = {
 }
 ```
 
-The structure of the return value of `.typeInfo()` is [defined here](https://github.com/B2o5T/graphql-eslint/blob/master/packages/plugin/src/estree-parser/converter.ts#L32-L40). So based on the `node` you are using, you'll get a different values on `.typeInfo()` result.
+The structure of the return value of `.typeInfo()` is [defined here](https://github.com/B2o5T/graphql-eslint/blob/master/packages/plugin/src/estree-converter/converter.ts#L32-L40). So based on the `node` you are using, you'll get a different values on `.typeInfo()` result.
 
 ## Testing your rules
 

docs/rules/relay-page-info.md

@@ -21,8 +21,8 @@ Set of rules to follow Relay specification for `PageInfo` object.
 type PageInfo {
   hasPreviousPage: Boolean!
   hasNextPage: Boolean!
-  startCursor: String!
-  endCursor: String!
+  startCursor: String
+  endCursor: String
 }
 ```
 

examples/code-file/.eslintrc.js

@@ -9,6 +9,9 @@ module.exports = {
         node: true,
         es6: true,
       },
+      rules: {
+        'no-console': 'error',
+      },
     },
     {
       files: ['*.graphql'],

examples/code-file/not-query.js

@@ -0,0 +1 @@
+console.log('should report `no-console` error')

packages/plugin/package.json

@@ -41,7 +41,7 @@
     "chalk": "4.1.2",
     "debug": "4.3.4",
     "fast-glob": "3.2.11",
-    "graphql-config": "^4.2.0",
+    "graphql-config": "^4.3.0",
     "graphql-depth-limit": "1.1.0",
     "lodash.lowercase": "4.3.0"
   },

packages/plugin/src/processor.ts

@@ -13,7 +13,7 @@ export const processor: Linter.Processor<Block | string> = {
   supportsAutofix: true,
   preprocess(code, filePath) {
     if (RELEVANT_KEYWORDS.every(keyword => !code.includes(keyword))) {
-      return [];
+      return [code];
     }
     const extractedDocuments = parseCode({
       code,
@@ -32,11 +32,11 @@ export const processor: Linter.Processor<Block | string> = {
     }));
     blocksMap.set(filePath, blocks);
 
-    return [...blocks, code /* For eslint-plugin-prettier */];
+    return [code, ...blocks];
   },
   postprocess(messages, filePath) {
-    const blocks = blocksMap.get(filePath);
-    for (let i = 0; i < blocks?.length; i += 1) {
+    const blocks = blocksMap.get(filePath) || [];
+    for (let i = 0; i < blocks.length; i += 1) {
       const { lineOffset, offset } = blocks[i];
 
       for (const message of messages[i]) {

packages/plugin/src/rules/relay-page-info.ts

@@ -31,8 +31,8 @@ const rule: GraphQLESLintRule = {
             type PageInfo {
               hasPreviousPage: Boolean!
               hasNextPage: Boolean!
-              startCursor: String!
-              endCursor: String!
+              startCursor: String
+              endCursor: String
             }
           `,
         },

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

@@ -53,6 +53,15 @@ Array [
 
 exports[`Examples should work on \`.js\` files 1`] = `
 Array [
+  Object {
+    filePath: examples/code-file/not-query.js,
+    messages: Array [
+      Object {
+        message: Unexpected console statement.,
+        ruleId: no-console,
+      },
+    ],
+  },
   Object {
     filePath: examples/code-file/query.js,
     messages: Array [

packages/plugin/tests/examples.spec.ts

@@ -48,7 +48,7 @@ describe('Examples', () => {
   it('should work on `.js` files', () => {
     const cwd = join(process.cwd(), 'examples/code-file');
     const results = getEslintOutput(cwd);
-    expect(countErrors(results)).toBe(2);
+    expect(countErrors(results)).toBe(3);
     testSnapshot(results);
   });