chore: add eslint-utils wrappers around deprecated ESLint methods (#7914

) * chore: add eslint-utils wrappers around deprecated ESLint methods * Fixed introduced linting complaints * Again: fixed introduced linting complaints
typescript-eslint · Nov 13, 2023 · a54a60b · a54a60b
1 parent 3e243f6
commit a54a60b
Show file tree

Hide file tree

Showing 103 changed files with 328 additions and 154 deletions.
diff --git a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
@@ -2,6 +2,7 @@ import prettier from '@prettier/sync';
 import { getContextualType } from '@typescript-eslint/type-utils';
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -147,7 +148,7 @@ export default createRule<Options, MessageIds>({
     },
   ],
   create(context, [{ formatWithPrettier }]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const services = ESLintUtils.getParserServices(context);
     const checker = services.program.getTypeChecker();
 

diff --git a/packages/eslint-plugin-tslint/src/rules/config.ts b/packages/eslint-plugin-tslint/src/rules/config.ts
@@ -1,4 +1,9 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
+import {
+  getCwd,
+  getFilename,
+  getSourceCode,
+} from '@typescript-eslint/utils/eslint-utils';
 import path from 'path';
 import type { RuleSeverity } from 'tslint';
 import { Configuration } from 'tslint';
@@ -119,8 +124,8 @@ export default createRule<Options, MessageIds>({
     context,
     [{ rules: tslintRules, rulesDirectory: tslintRulesDirectory, lintFile }],
   ) {
-    const fileName = path.resolve(context.getCwd(), context.getFilename());
-    const sourceCode = context.getSourceCode().text;
+    const fileName = path.resolve(getCwd(context), getFilename(context));
+    const sourceCode = getSourceCode(context).text;
     const services = ESLintUtils.getParserServices(context);
     const program = services.program;
 

diff --git a/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts b/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule, getNameFromMember, MemberNameType } from '../util';
 
@@ -30,7 +31,7 @@ export default createRule({
   },
   defaultOptions: [],
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     interface Method {
       name: string;

diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule, isParenthesized } from '../util';
 
@@ -134,7 +135,7 @@ export default createRule<Options, MessageIds>({
     },
   ],
   create(context, [options]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     const defaultOption = options.default;
     const readonlyOption = options.readonly ?? defaultOption;

diff --git a/packages/eslint-plugin/src/rules/await-thenable.ts b/packages/eslint-plugin/src/rules/await-thenable.ts
@@ -1,4 +1,5 @@
 import type { TSESLint } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 import * as tsutils from 'ts-api-utils';
 
 import {
@@ -50,7 +51,7 @@ export default createRule({
               {
                 messageId: 'removeAwait',
                 fix(fixer): TSESLint.RuleFix {
-                  const sourceCode = context.getSourceCode();
+                  const sourceCode = getSourceCode(context);
                   const awaitKeyword = nullThrows(
                     sourceCode.getFirstToken(node, isAwaitKeyword),
                     NullThrowsReasons.MissingToken('await', 'await expression'),

diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts
@@ -1,4 +1,5 @@
 import { AST_TOKEN_TYPES, type TSESLint } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule, getStringLength } from '../util';
 
@@ -102,7 +103,7 @@ export default createRule<[Options], MessageIds>({
       /^\/*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/;
     const commentDirectiveRegExMultiLine =
       /^\s*(?:\/|\*)*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/;
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     const descriptionFormats = new Map<string, RegExp>();
     for (const directive of [

diff --git a/packages/eslint-plugin/src/rules/ban-tslint-comment.ts b/packages/eslint-plugin/src/rules/ban-tslint-comment.ts
@@ -1,4 +1,5 @@
 import { AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -31,7 +32,7 @@ export default createRule({
   },
   defaultOptions: [],
   create: context => {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     return {
       Program(): void {
         const comments = sourceCode.getAllComments();

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -1,5 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule, objectReduceKey } from '../util';
 
@@ -218,7 +219,7 @@ export default createRule<Options, MessageIds>({
 
     function checkBannedTypes(
       typeNode: TSESTree.Node,
-      name = stringifyNode(typeNode, context.getSourceCode()),
+      name = stringifyNode(typeNode, getSourceCode(context)),
     ): void {
       const bannedType = bannedTypes.get(name);
 

diff --git a/packages/eslint-plugin/src/rules/block-spacing.ts b/packages/eslint-plugin/src/rules/block-spacing.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import type {
   InferMessageIdsTypeFromRule,
@@ -30,7 +31,7 @@ export default createRule<Options, MessageIds>({
   defaultOptions: ['always'],
 
   create(context, [whenToApplyOption]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const baseRules = baseRule.create(context);
     const always = whenToApplyOption !== 'never';
     const messageId = always ? 'missing' : 'extra';

diff --git a/packages/eslint-plugin/src/rules/brace-style.ts b/packages/eslint-plugin/src/rules/brace-style.ts
@@ -1,4 +1,5 @@
 import type { TSESTree } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import type {
   InferMessageIdsTypeFromRule,
@@ -32,7 +33,7 @@ export default createRule<Options, MessageIds>({
       context.options;
 
     const isAllmanStyle = style === 'allman';
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const rules = baseRule.create(context);
 
     /**

diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
@@ -1,5 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -95,7 +96,7 @@ export default createRule<Options, MessageIds>({
               {
                 messageId: 'preferFieldStyleSuggestion',
                 fix(fixer): TSESLint.RuleFix {
-                  const sourceCode = context.getSourceCode();
+                  const sourceCode = getSourceCode(context);
                   const name = sourceCode.getText(node.key);
 
                   let text = '';
@@ -130,7 +131,7 @@ export default createRule<Options, MessageIds>({
               {
                 messageId: 'preferGetterStyleSuggestion',
                 fix(fixer): TSESLint.RuleFix {
-                  const sourceCode = context.getSourceCode();
+                  const sourceCode = getSourceCode(context);
                   const name = sourceCode.getText(node.key);
 
                   let text = '';

diff --git a/packages/eslint-plugin/src/rules/class-methods-use-this.ts b/packages/eslint-plugin/src/rules/class-methods-use-this.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import {
   createRule,
@@ -99,7 +100,7 @@ export default createRule<Options, MessageIds>({
         };
     let stack: Stack | undefined;
 
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     function pushContext(
       member?: TSESTree.MethodDefinition | TSESTree.PropertyDefinition,

diff --git a/packages/eslint-plugin/src/rules/comma-dangle.ts b/packages/eslint-plugin/src/rules/comma-dangle.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import type {
   InferMessageIdsTypeFromRule,
@@ -94,7 +95,7 @@ export default createRule<Options, MessageIds>({
   defaultOptions: ['never'],
   create(context, [options]) {
     const rules = baseRule.create(context);
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const normalizedOptions = normalizeOptions(options);
 
     const predicate = {

diff --git a/packages/eslint-plugin/src/rules/comma-spacing.ts b/packages/eslint-plugin/src/rules/comma-spacing.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import {
   createRule,
@@ -55,7 +56,7 @@ export default createRule<Options, MessageIds>({
     },
   ],
   create(context, [{ before: spaceBefore, after: spaceAfter }]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const tokensAndComments = sourceCode.tokensAndComments;
     const ignoredTokens = new Set<TSESTree.PunctuatorToken>();
 

diff --git a/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts b/packages/eslint-plugin/src/rules/consistent-generic-constructors.ts
@@ -1,5 +1,6 @@
 import type { TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -31,7 +32,7 @@ export default createRule<Options, MessageIds>({
   },
   defaultOptions: ['constructor'],
   create(context, [mode]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     return {
       'VariableDeclarator,PropertyDefinition,:matches(FunctionDeclaration,FunctionExpression) > AssignmentPattern'(
         node:

diff --git a/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts b/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
@@ -1,5 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
+import { getScope, getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -28,7 +29,7 @@ export default createRule<Options, MessageIds>({
   },
   defaultOptions: ['record'],
   create(context, [mode]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     function checkMembers(
       members: TSESTree.TypeElement[],
@@ -63,7 +64,7 @@ export default createRule<Options, MessageIds>({
       }
 
       if (parentId) {
-        const scope = context.getScope();
+        const scope = getScope(context);
         const superVar = ASTUtils.findVariable(scope, parentId.name);
         if (superVar) {
           const isCircular = superVar.references.some(

diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
@@ -1,5 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 import * as ts from 'typescript';
 
 import {
@@ -90,7 +91,7 @@ export default createRule<Options, MessageIds>({
     },
   ],
   create(context, [options]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const parserServices = getParserServices(context, true);
 
     function isConst(node: TSESTree.TypeNode): boolean {
@@ -251,9 +252,9 @@ export default createRule<Options, MessageIds>({
             fixer.replaceText(node, getTextWithParentheses(node.expression)),
             fixer.insertTextAfter(
               node,
-              ` satisfies ${context
-                .getSourceCode()
-                .getText(node.typeAnnotation)}`,
+              ` satisfies ${getSourceCode(context).getText(
+                node.typeAnnotation,
+              )}`,
             ),
           ],
         });

diff --git a/packages/eslint-plugin/src/rules/consistent-type-definitions.ts b/packages/eslint-plugin/src/rules/consistent-type-definitions.ts
@@ -1,5 +1,9 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES, AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import {
+  getAncestors,
+  getSourceCode,
+} from '@typescript-eslint/utils/eslint-utils';
 
 import { createRule } from '../util';
 
@@ -26,21 +30,19 @@ export default createRule({
   },
   defaultOptions: ['interface'],
   create(context, [option]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     /**
      * Iterates from the highest parent to the currently traversed node
      * to determine whether any node in tree is globally declared module declaration
      */
     function isCurrentlyTraversedNodeWithinModuleDeclaration(): boolean {
-      return context
-        .getAncestors()
-        .some(
-          node =>
-            node.type === AST_NODE_TYPES.TSModuleDeclaration &&
-            node.declare &&
-            node.global,
-        );
+      return getAncestors(context).some(
+        node =>
+          node.type === AST_NODE_TYPES.TSModuleDeclaration &&
+          node.declare &&
+          node.global,
+      );
     }
 
     return {

diff --git a/packages/eslint-plugin/src/rules/consistent-type-exports.ts b/packages/eslint-plugin/src/rules/consistent-type-exports.ts
@@ -1,5 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { getSourceCode } from '@typescript-eslint/utils/eslint-utils';
 import { SymbolFlags } from 'typescript';
 
 import {
@@ -74,7 +75,7 @@ export default createRule<Options, MessageIds>({
   ],
 
   create(context, [{ fixMixedExportsWithInlineTypeSpecifier }]) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
     const sourceExportsMap: Record<string, SourceExports> = {};
     const services = getParserServices(context);
 

diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
@@ -1,5 +1,9 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import {
+  getDeclaredVariables,
+  getSourceCode,
+} from '@typescript-eslint/utils/eslint-utils';
 
 import {
   createRule,
@@ -104,7 +108,7 @@ export default createRule<Options, MessageIds>({
     const prefer = option.prefer ?? 'type-imports';
     const disallowTypeAnnotations = option.disallowTypeAnnotations !== false;
     const fixStyle = option.fixStyle ?? 'separate-type-imports';
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     const sourceImportsMap: Record<string, SourceImports> = {};
 
@@ -168,7 +172,7 @@ export default createRule<Options, MessageIds>({
                   continue;
                 }
 
-                const [variable] = context.getDeclaredVariables(specifier);
+                const [variable] = getDeclaredVariables(context, specifier);
                 if (variable.references.length === 0) {
                   unusedSpecifiers.push(specifier);
                 } else {