feat: update eslint, various improvements (#513)

Dimitri POSTOLOV · web-flow · commit 4348dccf1fca · 2021-07-02T17:23:53.000+03:00
diff --git a/.changeset/tough-windows-hang.md b/.changeset/tough-windows-hang.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+update eslint, various improvements
diff --git a/package.json b/package.json
@@ -28,29 +28,30 @@
     "@babel/core": "7.14.6",
     "@babel/preset-env": "7.14.7",
     "@babel/preset-typescript": "7.14.5",
-    "json-schema-to-markdown": "1.1.1",
-    "@types/dedent": "0.7.0",
-    "dedent": "0.7.0",
-    "ts-node": "10.0.0",
-    "patch-package": "6.4.7",
     "@changesets/cli": "2.16.0",
+    "@types/dedent": "0.7.0",
+    "@types/jest": "^26.0.23",
+    "@types/node": "14.17.4",
     "@typescript-eslint/eslint-plugin": "4.28.1",
     "@typescript-eslint/parser": "4.28.1",
-    "eslint": "7.28.0",
-    "husky": "6.0.0",
-    "lint-staged": "11.0.0",
-    "@types/node": "14.17.4",
     "bob-the-bundler": "1.2.1",
+    "dedent": "0.7.0",
+    "eslint": "7.29.0",
+    "eslint-config-prettier": "8.3.0",
     "eslint-config-standard": "16.0.3",
     "eslint-plugin-import": "2.23.4",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "5.1.0",
     "eslint-plugin-standard": "5.0.0",
-    "eslint-config-prettier": "8.3.0",
-    "ts-jest": "27.0.3",
+    "husky": "6.0.0",
+    "jest": "27.0.6",
+    "json-schema-to-markdown": "1.1.1",
+    "lint-staged": "11.0.0",
+    "patch-package": "6.4.7",
     "rimraf": "3.0.2",
-    "typescript": "4.3.5",
-    "jest": "27.0.6"
+    "ts-jest": "27.0.3",
+    "ts-node": "10.0.0",
+    "typescript": "4.3.5"
   },
   "resolutions": {
     "@changesets/git": "1.1.1"
diff --git a/packages/plugin/src/processors/code-files.ts b/packages/plugin/src/processors/code-files.ts
@@ -72,7 +72,7 @@ export function createGraphqlProcessor() {
             if (message.endLine != null) {
               message.endLine += lineOffset;
             }
-            if (message.fix && typeof offset !== 'undefined') {
+            if (message.fix && offset !== undefined) {
               message.fix.range[0] = offset + message.fix.range[0];
               message.fix.range[1] = offset + message.fix.range[1];
             }
diff --git a/packages/plugin/src/rules/avoid-operation-name-prefix.ts b/packages/plugin/src/rules/avoid-operation-name-prefix.ts
@@ -1,4 +1,4 @@
-import { GraphQLESLintRule, GraphQLESlintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser/estree-ast';
 import { OperationDefinitionNode, FragmentDefinitionNode } from 'graphql';
 
@@ -12,7 +12,7 @@ export type AvoidOperationNamePrefixConfig = [
 const AVOID_OPERATION_NAME_PREFIX = 'AVOID_OPERATION_NAME_PREFIX';
 
 function verifyRule(
-  context: GraphQLESlintRuleContext<AvoidOperationNamePrefixConfig>,
+  context: GraphQLESLintRuleContext<AvoidOperationNamePrefixConfig>,
   node: GraphQLESTreeNode<OperationDefinitionNode> | GraphQLESTreeNode<FragmentDefinitionNode>
 ) {
   const config = context.options[0] || { keywords: [], caseSensitive: false };
diff --git a/packages/plugin/src/rules/avoid-typename-prefix.ts b/packages/plugin/src/rules/avoid-typename-prefix.ts
@@ -1,11 +1,11 @@
 import { FieldDefinitionNode } from 'graphql';
 import { GraphQLESTreeNode } from '../estree-parser';
-import { GraphQLESLintRule, GraphQLESlintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 
 const AVOID_TYPENAME_PREFIX = 'AVOID_TYPENAME_PREFIX';
 
 function checkNode(
-  context: GraphQLESlintRuleContext<any>,
+  context: GraphQLESLintRuleContext<any>,
   typeName: string,
   fields: GraphQLESTreeNode<FieldDefinitionNode>[]
 ) {
diff --git a/packages/plugin/src/rules/graphql-js-validation.ts b/packages/plugin/src/rules/graphql-js-validation.ts
@@ -2,7 +2,7 @@ import { validate, GraphQLSchema, DocumentNode, ASTNode, ValidationRule } from '
 import { validateSDL } from 'graphql/validation/validate';
 import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
 import fs from 'fs';
-import { GraphQLESLintRule, GraphQLESlintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { requireGraphQLSchemaFromContext } from '../utils';
 import { GraphQLESTreeNode } from '../estree-parser';
 
@@ -18,7 +18,7 @@ function extractRuleName(stack: string | undefined): string | null {
 
 export function validateDoc(
   sourceNode: GraphQLESTreeNode<ASTNode>,
-  context: GraphQLESlintRuleContext,
+  context: GraphQLESLintRuleContext,
   schema: GraphQLSchema | null,
   documentNode: DocumentNode,
   rules: ReadonlyArray<ValidationRule>,
@@ -54,7 +54,7 @@ const validationToRule = (
   name: string,
   ruleName: string,
   docs: GraphQLESLintRule['meta']['docs'],
-  getDocumentNode?: (context: GraphQLESlintRuleContext) => DocumentNode | null
+  getDocumentNode?: (context: GraphQLESLintRuleContext) => DocumentNode | null
 ): Record<typeof name, GraphQLESLintRule<any, true>> => {
   let ruleFn: null | ValidationRule = null;
 
diff --git a/packages/plugin/src/rules/no-operation-name-suffix.ts b/packages/plugin/src/rules/no-operation-name-suffix.ts
@@ -1,11 +1,11 @@
-import { GraphQLESLintRule, GraphQLESlintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser/estree-ast';
 import { OperationDefinitionNode, FragmentDefinitionNode } from 'graphql';
 
 const NO_OPERATION_NAME_SUFFIX = 'NO_OPERATION_NAME_SUFFIX';
 
 function verifyRule(
-  context: GraphQLESlintRuleContext,
+  context: GraphQLESLintRuleContext,
   node: GraphQLESTreeNode<OperationDefinitionNode> | GraphQLESTreeNode<FragmentDefinitionNode>
 ) {
   if (node && node.name && node.name.value !== '') {
diff --git a/packages/plugin/src/rules/require-description.ts b/packages/plugin/src/rules/require-description.ts
@@ -1,4 +1,4 @@
-import { GraphQLESLintRule, GraphQLESlintRuleContext } from '../types';
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser/estree-ast';
 import { ASTNode, Kind, StringValueNode } from 'graphql';
 
@@ -18,7 +18,7 @@ const DESCRIBABLE_NODES = [
 type RequireDescriptionRuleConfig = [{ on: typeof DESCRIBABLE_NODES }];
 
 function verifyRule(
-  context: GraphQLESlintRuleContext<RequireDescriptionRuleConfig>,
+  context: GraphQLESLintRuleContext<RequireDescriptionRuleConfig>,
   node: GraphQLESTreeNode<ASTNode> & {
     readonly description?: GraphQLESTreeNode<StringValueNode>;
   }
diff --git a/packages/plugin/src/testkit.ts b/packages/plugin/src/testkit.ts
@@ -3,9 +3,9 @@ import { readFileSync } from 'fs';
 import { ASTKindToNode } from 'graphql';
 import { resolve } from 'path';
 import { GraphQLESTreeNode } from './estree-parser';
-import { ParserOptions } from './types';
+import { GraphQLESLintRule, ParserOptions } from './types';
 
-export type GraphQLESlintRuleListener<WithTypeInfo extends boolean> = {
+export type GraphQLESLintRuleListener<WithTypeInfo extends boolean> = {
   [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 } &
   Record<string, any>;
@@ -21,11 +21,11 @@ export type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
 };
 
 export class GraphQLRuleTester extends require('eslint').RuleTester {
-  constructor(parserOptions: ParserOptions = {}) {
+  constructor(parserOptions: ParserOptions) {
     super({
       parser: require.resolve('@graphql-eslint/eslint-plugin'),
       parserOptions: {
-        ...(parserOptions || {}),
+        ...parserOptions,
         skipGraphQLConfig: true,
       },
     });
@@ -37,12 +37,12 @@ export class GraphQLRuleTester extends require('eslint').RuleTester {
 
   runGraphQLTests<Config>(
     name: string,
-    rule: any, // Actually, it's GraphQLESLintRule, but TS has issues with that
+    rule: GraphQLESLintRule,
     tests: {
-      valid?: Array<string | GraphQLValidTestCase<Config>>;
-      invalid?: Array<string | GraphQLInvalidTestCase<Config>>;
+      valid?: GraphQLValidTestCase<Config>[];
+      invalid?: GraphQLInvalidTestCase<Config>[];
     }
   ): void {
-    super.run(name, rule as any, tests);
+    super.run(name, rule, tests);
   }
 }
diff --git a/packages/plugin/src/types.ts b/packages/plugin/src/types.ts
@@ -2,7 +2,7 @@ import { Rule, AST, Linter } from 'eslint';
 import { GraphQLESTreeNode } from './estree-parser';
 import { ASTNode, GraphQLSchema } from 'graphql';
 import { GraphQLParseOptions } from '@graphql-tools/utils';
-import { GraphQLESlintRuleListener } from './testkit';
+import { GraphQLESLintRuleListener } from './testkit';
 import { SiblingOperations } from './sibling-operations';
 import { FieldsCache } from './graphql-ast';
 
@@ -27,7 +27,7 @@ export type GraphQLESLintParseResult = Linter.ESLintParseResult & {
   services: ParserServices;
 };
 
-export type GraphQLESlintRuleContext<Options = any[]> = Omit<
+export type GraphQLESLintRuleContext<Options = any[]> = Omit<
   Rule.RuleContext,
   'parserServices' | 'report' | 'options'
 > & {
@@ -53,6 +53,6 @@ export type RuleDocsInfo<T> = {
 };
 
 export type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
-  create(context: GraphQLESlintRuleContext<Options>): GraphQLESlintRuleListener<WithTypeInfo>;
+  create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
   meta?: Rule.RuleMetaData & RuleDocsInfo<Options>;
 };
diff --git a/packages/plugin/src/utils.ts b/packages/plugin/src/utils.ts
@@ -1,10 +1,10 @@
 import { Source, Lexer, GraphQLSchema, Token, DocumentNode } from 'graphql';
-import { GraphQLESlintRuleContext } from './types';
+import { GraphQLESLintRuleContext } from './types';
 import { AST } from 'eslint';
 import { SiblingOperations } from './sibling-operations';
 import { FieldsCache } from './graphql-ast';
 
-export function requireSiblingsOperations(ruleName: string, context: GraphQLESlintRuleContext<any>): SiblingOperations {
+export function requireSiblingsOperations(ruleName: string, context: GraphQLESLintRuleContext<any>): SiblingOperations {
   if (!context || !context.parserServices) {
     throw new Error(
       `Rule '${ruleName}' requires 'parserOptions.operations' to be set and loaded. See http://bit.ly/graphql-eslint-operations for more info`
@@ -22,7 +22,7 @@ export function requireSiblingsOperations(ruleName: string, context: GraphQLESli
 
 export function requireGraphQLSchemaFromContext(
   ruleName: string,
-  context: GraphQLESlintRuleContext<any>
+  context: GraphQLESLintRuleContext<any>
 ): GraphQLSchema {
   if (!context || !context.parserServices) {
     throw new Error(
@@ -41,7 +41,7 @@ export function requireGraphQLSchemaFromContext(
 
 export function requireReachableTypesFromContext(
   ruleName: string,
-  context: GraphQLESlintRuleContext<any>
+  context: GraphQLESLintRuleContext<any>
 ): Set<string> {
   if (!context || !context.parserServices) {
     throw new Error(
@@ -60,7 +60,7 @@ export function requireReachableTypesFromContext(
 
 export function requireUsedFieldsFromContext(
   ruleName: string,
-  context: GraphQLESlintRuleContext<any>
+  context: GraphQLESLintRuleContext<any>
 ): FieldsCache {
   if (!context || !context.parserServices) {
     throw new Error(
diff --git a/patches/eslint+7.29.0.patch b/patches/eslint+7.29.0.patch
@@ -1,26 +1,23 @@
 diff --git a/node_modules/eslint/lib/rule-tester/rule-tester.js b/node_modules/eslint/lib/rule-tester/rule-tester.js
-index 905f341..6ba6ae7 100644
+index cac81bc..3a3dbbe 100644
 --- a/node_modules/eslint/lib/rule-tester/rule-tester.js
 +++ b/node_modules/eslint/lib/rule-tester/rule-tester.js
-@@ -851,9 +851,19 @@ class RuleTester {
+@@ -905,7 +905,17 @@ class RuleTester {
                          "Expected no autofixes to be suggested"
                      );
                  } else {
 -                    assert.strictEqual(result.output, item.output, "Output is incorrect.");
 +                    if (item.output.includes('# normalize graphql')) {
 +                        const graphql = require('graphql');
++  
 +                        function normalize(value) {
 +                            return graphql.print(graphql.parse(value.replace('# normalize graphql', '')));
 +                        }
-+
-+                        assert.strictEqual(normalize(result.output), normalize(item.output), "Output is incorrect.");
++  
++                        assert.strictEqual(normalize(result.output), normalize(item.output), 'Output is incorrect.');
 +                    } else {
-+                        assert.strictEqual(result.output, item.output, "Output is incorrect.");
++                        assert.strictEqual(result.output, item.output, 'Output is incorrect.');
 +                    }
                  }
--            } else {
-+            }
-+            else {
+             } else {
                  assert.strictEqual(
-                     result.output,
-                     item.code,
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': patch
 +---
++
 +update eslint, various improvements
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ export function createGraphqlProcessor() {`
`72`	`72`	`if (message.endLine != null) {`
`73`	`73`	`message.endLine += lineOffset;`
`74`	`74`	`}`
`75`		`- if (message.fix && typeof offset !== 'undefined') {`
	`75`	`+ if (message.fix && offset !== undefined) {`
`76`	`76`	`message.fix.range[0] = offset + message.fix.range[0];`
`77`	`77`	`message.fix.range[1] = offset + message.fix.range[1];`
`78`	`78`	`}`