no-hashtag-description allow eslint directives (#318)

Author: gilgardosh

.changeset/brave-geckos-tickle.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+no-hashtag-description allows eslint directives

packages/plugin/src/rules/no-hashtag-description.ts

@@ -1,5 +1,6 @@
 import { GraphQLESLintRule } from '../types';
 import { TokenKind } from 'graphql';
+import { checkForEslint } from '../utils';
 
 const HASHTAG_COMMENT = 'HASHTAG_COMMENT';
 
@@ -85,6 +86,7 @@ const rule: GraphQLESLintRule = {
                   });
                 } else if (
                   token.next.kind !== TokenKind.COMMENT &&
+                  !checkForEslint(token, rawNode) &&
                   token.next.kind !== TokenKind.EOF &&
                   token.next.line - token.line < 2 &&
                   token.prev.line !== token.line

packages/plugin/src/utils.ts

@@ -1,4 +1,4 @@
-import { Source, Lexer, GraphQLSchema } from 'graphql';
+import { Source, Lexer, GraphQLSchema, Token, DocumentNode } from 'graphql';
 import { GraphQLESlintRuleContext } from './types';
 import { AST } from 'eslint';
 import { SiblingOperations } from './sibling-operations';
@@ -99,3 +99,14 @@ export function extractTokens(source: string): AST.Token[] {
 
   return tokens;
 }
+
+export function checkForEslint(token: Token, rawNode: DocumentNode): boolean {
+  if (token.kind !== 'Comment') {
+    return false;
+  }
+  const string = rawNode.loc?.source.body.substring(token.start+1, token.start+8);
+  if (string.toLocaleLowerCase().includes('eslint')) {
+    return true;
+  }
+  return false;
+}

packages/plugin/tests/no-hashtag-description.spec.ts

@@ -75,6 +75,14 @@ ruleTester.runGraphQLTests('no-hashtag-description', rule, {
         # Test
       `,
     },
+    {
+      code: /* GraphQL */ `
+        # eslint
+        type Query {
+          foo: String
+        }
+      `,
+    },
   ],
   invalid: [
     {