allow to run on code files

Author: dotansimha

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "eslint.enable": true
+}

example/.eslintrc.json

@@ -1,25 +1,42 @@
 {
-  "parser": "@graphql-eslint/parser",
-  "parserOptions": {
-    "schemaPath": "./**/schema.graphql"
-  },
   "plugins": ["@graphql-eslint"],
+  "processor": "@graphql-eslint/graphql",
   "rules": {
-    "@graphql-eslint/require-id-when-available": ["error", {
-      "fieldName": "_id" 
-    }],
-    "@graphql-eslint/validate-against-schema": "error",
-    "@graphql-eslint/no-anonymous-operations": "warn",
-    "@graphql-eslint/no-operation-name-suffix": "error",
-    "@graphql-eslint/deprecation-must-have-reason": "error",
-    "@graphql-eslint/avoid-operation-name-prefix": ["error", {
-      "keywords": ["get"]
-    }],
-    "@graphql-eslint/no-case-insensitive-enum-values-duplicates": [
-      "error"
-    ],
-    "@graphql-eslint/require-description": ["warn", {
-      "on": ["SchemaDefinition", "FieldDefinition"]
-    }]
-  }
-}
+    "@graphql-eslint/no-anonymous-operations": "warn"
+  },
+  "overrides": [
+    {
+      "files": ["./**/*.graphql"],
+      "parser": "@graphql-eslint/parser",
+      "parserOptions": {
+        "schemaPath": "./**/schema.graphql"
+      },
+      "plugins": ["@graphql-eslint"],
+      "rules": {
+        "@graphql-eslint/require-id-when-available": [
+          "error",
+          {
+            "fieldName": "_id"
+          }
+        ],
+        "@graphql-eslint/validate-against-schema": "error",
+        "@graphql-eslint/no-anonymous-operations": "warn",
+        "@graphql-eslint/no-operation-name-suffix": "error",
+        "@graphql-eslint/deprecation-must-have-reason": "error",
+        "@graphql-eslint/avoid-operation-name-prefix": [
+          "error",
+          {
+            "keywords": ["get"]
+          }
+        ],
+        "@graphql-eslint/no-case-insensitive-enum-values-duplicates": ["error"],
+        "@graphql-eslint/require-description": [
+          "warn",
+          {
+            "on": ["SchemaDefinition", "FieldDefinition"]
+          }
+        ]
+      }
+    }
+  ]
+}

example/package.json

@@ -6,13 +6,13 @@
   "author": "Dotan Simha <[email protected]>",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint --ext graphql ."
+    "lint": "eslint --ext graphql,js ."
   },
   "dependencies": {
     "eslint": "7.8.1",
     "@graphql-eslint/parser": "0.0.1",
-    "@graphql-eslint/eslint-plugin": "0.0.1", 
+    "@graphql-eslint/eslint-plugin": "0.0.1",
     "graphql": "15.3.0",
     "typescript": "4.0.2"
   }
-}
+}

example/query.graphql

@@ -1,4 +1,4 @@
-query test {
+query {
   user {
     id
     name

example/query.js

@@ -0,0 +1,19 @@
+const myQuery = gql`
+  query {
+    user {
+      id
+      name
+      ... on User {
+        name
+      }
+    }
+  }
+`;
+
+const myOtherQuery = gql`
+  query a {
+    user {
+      name
+    }
+  }
+`;

packages/plugin/package.json

@@ -16,7 +16,8 @@
     "prepack": "bob prepack"
   },
   "dependencies": {
-    "@graphql-eslint/types": "0.0.1"
+    "@graphql-eslint/types": "0.0.1",
+    "@graphql-tools/graphql-tag-pluck": "6.2.5"
   },
   "devDependencies": {
     "@types/eslint": "7.2.2",
@@ -33,4 +34,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

packages/plugin/src/index.ts

@@ -1 +1,2 @@
 export { rules } from "./rules";
+export { processors } from "./processors";

packages/plugin/src/processors/code-files.ts

@@ -0,0 +1,75 @@
+import { extname } from "path";
+import { parseCode } from "@graphql-tools/graphql-tag-pluck";
+
+const EXTRACTABLE_FILES_EXTENSIONS = [".js", ".jsx", ".ts", ".tsx"];
+const RELEVANT_KEYWORDS = ["gql", "graphql", "/* GraphQL */"];
+
+type Block = {
+  text: string;
+  filename: string;
+  lineOffset?: number;
+};
+
+export const createGraphqlProcessor = () => {
+  const blocksMap = new Map<string, Block[]>();
+
+  return {
+    preprocess: (
+      text: string,
+      filename: string
+    ): Array<{ text: string; filename: string }> => {
+      const blocks: Block[] = [];
+      blocksMap.set(filename, blocks);
+
+      if (
+        filename &&
+        text &&
+        EXTRACTABLE_FILES_EXTENSIONS.includes(extname(filename)) &&
+        RELEVANT_KEYWORDS.some((keyword) => text.includes(keyword))
+      ) {
+        const extractedDocuments = parseCode({
+          code: text,
+          filePath: filename,
+          options: {
+            globalGqlIdentifierName: ["gql", "graphql"],
+            skipIndent: true,
+          },
+        });
+
+        if (extractedDocuments && extractedDocuments.length > 0) {
+          for (const item of extractedDocuments) {
+            blocks.push({
+              filename: `document.graphql`,
+              text: item.content,
+              lineOffset: item.loc.start.line - 1,
+            });
+          }
+
+          return blocks;
+        }
+      }
+
+      return [{ text, filename }];
+    },
+    postprocess: (messageLists: any[], filename: string): any[] => {
+      const blocks = blocksMap.get(filename);
+
+      if (blocks && blocks.length > 0) {
+        for (let i = 0; i < messageLists.length; ++i) {
+          const messages = messageLists[i];
+          const { lineOffset } = blocks[i];
+
+          for (const message of messages) {
+            message.line += lineOffset;
+
+            if (message.endLine != null) {
+              message.endLine += lineOffset;
+            }
+          }
+        }
+      }
+
+      return [].concat(...messageLists);
+    },
+  };
+};

packages/plugin/src/processors/index.ts

@@ -0,0 +1,5 @@
+import { createGraphqlProcessor } from "./code-files";
+
+export const processors = {
+  graphql: createGraphqlProcessor(),
+};

packages/plugin/src/rules/require-description.ts

@@ -40,7 +40,7 @@ function verifyRule(
           },
           end: {
             line: node.loc.end.line,
-            column: node.loc.end.column - 1,
+            column: node.loc.end.column,
           },
         },
         messageId: REQUIRE_DESCRIPTION_ERROR,