added support for real eslint comments, based on graphql comments (# sign)

Author: dotansimha

example/schema.graphql

@@ -1,3 +1,4 @@
 type Query {
+  // eslint-disable-next-line @graphql-eslint/require-description
   hello: String
 }

packages/graphql-estree/src/converter.ts

@@ -1,18 +1,25 @@
-import { convertDescription, GraphQLESTreeNode, SafeGraphQLType, convertLocation, convertRange } from "@graphql-eslint/types";
+import { extractCommentsFromAst, convertDescription, GraphQLESTreeNode, SafeGraphQLType, convertLocation, convertRange } from "@graphql-eslint/types";
 import {
   ASTNode,
   TypeNode,
   TypeInfo,
   visit,
   visitWithTypeInfo,
 } from "graphql";
+import { Comment } from "estree";
 
 export function convertToESTree<T extends ASTNode>(
   node: T,
   typeInfo?: TypeInfo
-): GraphQLESTreeNode<T> {
+): { rootTree: GraphQLESTreeNode<T>, comments: Comment[] } {
+  const comments: Comment[] = extractCommentsFromAst(node);
+  console.log(comments);
   const visitor = { leave: convertNode(typeInfo) };
-  return visit(node, typeInfo ? visitWithTypeInfo(typeInfo, visitor) : visitor);
+  
+  return {
+    rootTree: visit(node, typeInfo ? visitWithTypeInfo(typeInfo, visitor) : visitor),
+    comments,
+  };
 }
 
 function hasTypeField<T extends ASTNode>(

packages/parser/src/parser.ts

@@ -73,21 +73,20 @@ export function parseForESLint(
     const graphqlAst = parseGraphQLSDL(config.filePath || '', code, {
       ...config,
       noLocation: false,
-      commentDescriptions: true,
     });
 
-    const estreeAst = convertToESTree(graphqlAst.document, schema ? new TypeInfo(schema) : null);
+    const { rootTree, comments } = convertToESTree(graphqlAst.document, schema ? new TypeInfo(schema) : null);
 
     return {
       services: parserServices,
       parserServices,
       ast: {
         type: "Program",
-        body: [estreeAst as any],
+        body: [rootTree as any],
         sourceType: "script",
-        comments: [],
-        loc: estreeAst.loc,
-        range: estreeAst.range,
+        comments,
+        loc: rootTree.loc,
+        range: rootTree.range,
         tokens: [],
       },
     };

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

@@ -22,8 +22,7 @@ type RequireDescriptionRuleConfig = { on: typeof DESCRIBABLE_NODES };
 
 function verifyRule(
   context: GraphQLESlintRuleContext<RequireDescriptionRuleConfig>,
-  node: {
-    kind: string;
+  node: GraphQLESTreeNode<ASTNode> & {
     readonly description?: GraphQLESTreeNode<StringValueNode>;
   }
 ) {
@@ -34,7 +33,16 @@ function verifyRule(
       node.description.value.trim().length === 0
     ) {
       context.report({
-        node: node as GraphQLESTreeNode<ASTNode>,
+        loc: {
+          start: {
+            line: node.loc.start.line,
+            column: node.loc.start.column - 1,
+          },
+          end: {
+            line: node.loc.end.line,
+            column: node.loc.end.column - 1,
+          }
+        },
         messageId: REQUIRE_DESCRIPTION_ERROR,
         data: {
           nodeType: node.kind,

packages/types/src/utils.ts

@@ -1,7 +1,8 @@
 import { GraphQLESlintRuleContext } from "./rule";
-import { Kind, GraphQLSchema, Location, ValueNode, StringValueNode, ASTNode, IntValueNode, FloatValueNode, BooleanValueNode, ListValueNode, ObjectValueNode, VariableNode } from 'graphql';
+import { Kind, GraphQLSchema, Location, ValueNode, StringValueNode, ASTNode, IntValueNode, FloatValueNode, BooleanValueNode, ListValueNode, ObjectValueNode, VariableNode, TokenKind, Token } from 'graphql';
 import { SourceLocation, Comment } from "estree";
 import { GraphQLESTreeNode } from './estree-ast';
+import { dedentBlockStringValue } from 'graphql/language/blockString';
 
 export function requireGraphQLSchemaFromContext(
   context: GraphQLESlintRuleContext
@@ -62,6 +63,42 @@ export function convertRange(gqlLocation: Location): [number, number] {
   return [gqlLocation.start, gqlLocation.end];
 }
 
+export function extractCommentsFromAst(node: ASTNode): Comment[] {
+  const loc = node.loc;
+
+  if (!loc) {
+    return [];
+  }
+
+  const comments: Comment[] = [];
+  let token = loc.startToken;
+
+  while (token !== null) {
+    if (token.kind === TokenKind.COMMENT) {
+      const value = String(token.value);
+      comments.push({
+        type: "Block",
+        value: ' ' + value + ' ',
+        loc: {
+          start: {
+            line: token.line,
+            column: token.column,
+          },
+          end: {
+            line: token.line,
+            column: token.column,
+          }
+        },
+        range: [token.start, token.end],
+      });
+    }
+
+    token = token.next;
+  }
+
+  return comments;
+}
+
 export function convertLocation(gqlLocation: Location): SourceLocation {
   return {
     start: {