refactor: remove ESLint context fallbacks

G-Rath · G-Rath · commit d4caa67c799e · 2025-06-18T14:32:25.000+12:00
diff --git a/src/rules/expect-expect.ts b/src/rules/expect-expect.ts
@@ -6,8 +6,6 @@
 import { AST_NODE_TYPES, type TSESTree } from '@typescript-eslint/utils';
 import {
   createRule,
-  getAncestors,
-  getDeclaredVariables,
   getNodeName,
   getTestCallExpressionsFromDeclaredVariables,
   isSupportedAccessor,
@@ -94,7 +92,8 @@ export default createRule<
             : -1;
 
         if (node.type === AST_NODE_TYPES.FunctionDeclaration) {
-          const declaredVariables = getDeclaredVariables(context, node);
+          const declaredVariables =
+            context.sourceCode.getDeclaredVariables(node);
           const testCallExpressions =
             getTestCallExpressionsFromDeclaredVariables(
               declaredVariables,
@@ -129,7 +128,7 @@ export default createRule<
           unchecked.push(node);
         } else if (matchesAssertFunctionName(name, assertFunctionNames)) {
           // Return early in case of nested `it` statements.
-          checkCallExpressionUsed(getAncestors(context, node));
+          checkCallExpressionUsed(context.sourceCode.getAncestors(node));
         }
       },
       'Program:exit'() {
diff --git a/src/rules/no-commented-out-tests.ts b/src/rules/no-commented-out-tests.ts
@@ -1,5 +1,5 @@
 import type { TSESTree } from '@typescript-eslint/utils';
-import { createRule, getSourceCode } from './utils';
+import { createRule } from './utils';
 
 function hasTests(node: TSESTree.Comment) {
   return /^\s*[xf]?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/mu.test(
@@ -21,7 +21,7 @@ export default createRule({
   },
   defaultOptions: [],
   create(context) {
-    const sourceCode = getSourceCode(context);
+    const { sourceCode } = context;
 
     function checkNode(node: TSESTree.Comment) {
       if (!hasTests(node)) {
diff --git a/src/rules/no-conditional-expect.ts b/src/rules/no-conditional-expect.ts
@@ -2,7 +2,6 @@ import { AST_NODE_TYPES, type TSESTree } from '@typescript-eslint/utils';
 import {
   type KnownCallExpression,
   createRule,
-  getDeclaredVariables,
   getTestCallExpressionsFromDeclaredVariables,
   isSupportedAccessor,
   isTypeOfJestFnCall,
@@ -38,7 +37,7 @@ export default createRule({
 
     return {
       FunctionDeclaration(node) {
-        const declaredVariables = getDeclaredVariables(context, node);
+        const declaredVariables = context.sourceCode.getDeclaredVariables(node);
         const testCallExpressions = getTestCallExpressionsFromDeclaredVariables(
           declaredVariables,
           context,
diff --git a/src/rules/no-confusing-set-timeout.ts b/src/rules/no-confusing-set-timeout.ts
@@ -1,7 +1,6 @@
 import {
   type ParsedJestFnCall,
   createRule,
-  getScope,
   isIdentifier,
   parseJestFnCall,
 } from './utils';
@@ -49,7 +48,9 @@ export default createRule({
           return;
         }
 
-        if (!['global', 'module'].includes(getScope(context, node).type)) {
+        if (
+          !['global', 'module'].includes(context.sourceCode.getScope(node).type)
+        ) {
           context.report({ messageId: 'globalSetTimeout', node });
         }
 
diff --git a/src/rules/no-disabled-tests.ts b/src/rules/no-disabled-tests.ts
@@ -1,7 +1,6 @@
 import {
   createRule,
   getAccessorValue,
-  getScope,
   parseJestFnCall,
   resolveScope,
 } from './utils';
@@ -50,7 +49,7 @@ export default createRule({
         }
       },
       'CallExpression[callee.name="pending"]'(node) {
-        if (resolveScope(getScope(context, node), 'pending')) {
+        if (resolveScope(context.sourceCode.getScope(node), 'pending')) {
           return;
         }
 
diff --git a/src/rules/no-done-callback.ts b/src/rules/no-done-callback.ts
@@ -3,14 +3,7 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import {
-  createRule,
-  getFilename,
-  getNodeName,
-  getSourceCode,
-  isFunction,
-  parseJestFnCall,
-} from './utils';
+import { createRule, getNodeName, isFunction, parseJestFnCall } from './utils';
 
 const findCallbackArg = (
   node: TSESTree.CallExpression,
@@ -109,7 +102,7 @@ export default createRule({
               fix(fixer) {
                 const { body, params } = callback;
 
-                const sourceCode = getSourceCode(context);
+                const { sourceCode } = context;
                 const firstBodyToken = sourceCode.getFirstToken(body);
                 const lastBodyToken = sourceCode.getLastToken(body);
 
@@ -133,7 +126,7 @@ export default createRule({
                   !tokenAfterLastParam
                 ) {
                   throw new Error(
-                    `Unexpected null when attempting to fix ${getFilename(context)} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`,
+                    `Unexpected null when attempting to fix ${context.filename} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`,
                   );
                 }
 
diff --git a/src/rules/no-jasmine-globals.ts b/src/rules/no-jasmine-globals.ts
@@ -2,7 +2,6 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
 import {
   createRule,
   getNodeName,
-  getScope,
   isSupportedAccessor,
   resolveScope,
 } from './utils';
@@ -45,7 +44,7 @@ export default createRule({
           calleeName === 'fail' ||
           calleeName === 'pending'
         ) {
-          if (resolveScope(getScope(context, node), calleeName)) {
+          if (resolveScope(context.sourceCode.getScope(node), calleeName)) {
             // It's a local variable, not a jasmine global.
             return;
           }
diff --git a/src/rules/no-large-snapshots.ts b/src/rules/no-large-snapshots.ts
@@ -7,7 +7,6 @@ import {
 import {
   createRule,
   getAccessorValue,
-  getFilename,
   isSupportedAccessor,
   parseJestFnCall,
 } from './utils';
@@ -47,7 +46,7 @@ const reportOnViolation = (
     node.expression.left.type === AST_NODE_TYPES.MemberExpression &&
     isSupportedAccessor(node.expression.left.property)
   ) {
-    const fileName = getFilename(context);
+    const fileName = context.filename;
     const allowedSnapshotsInFile = allowedSnapshots[fileName];
 
     if (allowedSnapshotsInFile) {
@@ -106,7 +105,7 @@ export default createRule<[RuleOptions], MessageId>({
   },
   defaultOptions: [{}],
   create(context, [options]) {
-    if (getFilename(context).endsWith('.snap')) {
+    if (context.filename.endsWith('.snap')) {
       return {
         ExpressionStatement(node) {
           reportOnViolation(context, node, options);
diff --git a/src/rules/no-test-return-statement.ts b/src/rules/no-test-return-statement.ts
@@ -1,7 +1,6 @@
 import { AST_NODE_TYPES, type TSESTree } from '@typescript-eslint/utils';
 import {
   createRule,
-  getDeclaredVariables,
   getTestCallExpressionsFromDeclaredVariables,
   isFunction,
   isTypeOfJestFnCall,
@@ -53,7 +52,7 @@ export default createRule({
         context.report({ messageId: 'noReturnValue', node: returnStmt });
       },
       FunctionDeclaration(node) {
-        const declaredVariables = getDeclaredVariables(context, node);
+        const declaredVariables = context.sourceCode.getDeclaredVariables(node);
         const testCallExpressions = getTestCallExpressionsFromDeclaredVariables(
           declaredVariables,
           context,
diff --git a/src/rules/prefer-comparison-matcher.ts b/src/rules/prefer-comparison-matcher.ts
@@ -4,7 +4,6 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
-  getSourceCode,
   isBooleanLiteral,
   isStringNode,
   parseJestFnCall,
@@ -115,7 +114,7 @@ export default createRule({
 
         context.report({
           fix(fixer) {
-            const sourceCode = getSourceCode(context);
+            const { sourceCode } = context;
 
             // preserve the existing modifier if it's not a negation
             const modifierText =
diff --git a/src/rules/prefer-equality-matcher.ts b/src/rules/prefer-equality-matcher.ts
@@ -5,7 +5,6 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
-  getSourceCode,
   isBooleanLiteral,
   parseJestFnCall,
 } from './utils';
@@ -73,7 +72,7 @@ export default createRule({
         const buildFixer =
           (equalityMatcher: string): TSESLint.ReportFixFunction =>
           fixer => {
-            const sourceCode = getSourceCode(context);
+            const { sourceCode } = context;
 
             // preserve the existing modifier if it's not a negation
             let modifierText =
diff --git a/src/rules/prefer-importing-jest-globals.ts b/src/rules/prefer-importing-jest-globals.ts
@@ -3,7 +3,6 @@ import {
   type JestFnType,
   createRule,
   getAccessorValue,
-  getSourceCode,
   isIdentifier,
   isStringNode,
   isSupportedAccessor,
@@ -94,7 +93,7 @@ export default createRule({
           messageId: 'preferImportingJestGlobal',
           data: { jestFunctions: Array.from(functionsToImport).join(', ') },
           fix(fixer) {
-            const sourceCode = getSourceCode(context);
+            const { sourceCode } = context;
             const [firstNode] = sourceCode.ast.body;
 
             // check if "use strict" directive exists
diff --git a/src/rules/prefer-jest-mocked.ts b/src/rules/prefer-jest-mocked.ts
@@ -1,5 +1,5 @@
 import { AST_NODE_TYPES, type TSESTree } from '@typescript-eslint/utils';
-import { createRule, followTypeAssertionChain, getSourceCode } from './utils';
+import { createRule, followTypeAssertionChain } from './utils';
 
 const mockTypes = ['Mock', 'MockedFunction', 'MockedClass', 'MockedObject'];
 
@@ -42,7 +42,7 @@ export default createRule({
         return;
       }
 
-      const fnName = getSourceCode(context).text.slice(
+      const fnName = context.sourceCode.text.slice(
         ...followTypeAssertionChain(node.expression).range,
       );
 
diff --git a/src/rules/prefer-mock-promise-shorthand.ts b/src/rules/prefer-mock-promise-shorthand.ts
@@ -5,7 +5,6 @@ import {
   createRule,
   getAccessorValue,
   getNodeName,
-  getSourceCode,
   isFunction,
   isSupportedAccessor,
 } from './utils';
@@ -69,7 +68,7 @@ export default createRule({
         messageId: 'useMockShorthand',
         data: { replacement },
         fix(fixer) {
-          const sourceCode = getSourceCode(context);
+          const { sourceCode } = context;
 
           // there shouldn't be more than one argument, but if there is don't try
           // fixing since we have no idea what to do with the extra arguments
diff --git a/src/rules/prefer-spy-on.ts b/src/rules/prefer-spy-on.ts
@@ -3,7 +3,7 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import { createRule, getNodeName, getSourceCode } from './utils';
+import { createRule, getNodeName } from './utils';
 
 const findNodeObject = (
   node: TSESTree.CallExpression | TSESTree.MemberExpression,
@@ -57,7 +57,7 @@ const getAutoFixMockImplementation = (
   }
 
   const [arg] = jestFnCall.arguments;
-  const argSource = arg && getSourceCode(context).getText(arg);
+  const argSource = arg && context.sourceCode.getText(arg);
 
   return argSource
     ? `.mockImplementation(${argSource})`
diff --git a/src/rules/prefer-to-contain.ts b/src/rules/prefer-to-contain.ts
@@ -7,7 +7,6 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
-  getSourceCode,
   hasOnlyOneArgument,
   isBooleanLiteral,
   isSupportedAccessor,
@@ -88,7 +87,7 @@ export default createRule({
 
         context.report({
           fix(fixer) {
-            const sourceCode = getSourceCode(context);
+            const { sourceCode } = context;
 
             // we need to negate the expectation if the current expected
             // value is itself negated by the "not" modifier
diff --git a/src/rules/utils/misc.ts b/src/rules/utils/misc.ts
@@ -174,7 +174,7 @@ export const removeExtraArgumentsFixer = (
   const firstArg = func.arguments[from];
   const lastArg = func.arguments[func.arguments.length - 1];
 
-  const sourceCode = getSourceCode(context);
+  const { sourceCode } = context;
   let tokenAfterLastParam = sourceCode.getTokenAfter(lastArg)!;
 
   if (tokenAfterLastParam.value === ',') {
@@ -225,44 +225,3 @@ export const getFirstMatcherArg = (
 
   return followTypeAssertionChain(firstArg);
 };
-
-/* istanbul ignore next */
-export const getFilename = (
-  context: TSESLint.RuleContext<string, unknown[]>,
-) => {
-  return context.filename ?? context.getFilename();
-};
-
-/* istanbul ignore next */
-export const getSourceCode = (
-  context: TSESLint.RuleContext<string, unknown[]>,
-) => {
-  return context.sourceCode ?? context.getSourceCode();
-};
-
-/* istanbul ignore next */
-export const getScope = (
-  context: TSESLint.RuleContext<string, unknown[]>,
-  node: TSESTree.Node,
-) => {
-  return getSourceCode(context).getScope?.(node) ?? context.getScope();
-};
-
-/* istanbul ignore next */
-export const getAncestors = (
-  context: TSESLint.RuleContext<string, unknown[]>,
-  node: TSESTree.Node,
-) => {
-  return getSourceCode(context).getAncestors?.(node) ?? context.getAncestors();
-};
-
-/* istanbul ignore next */
-export const getDeclaredVariables = (
-  context: TSESLint.RuleContext<string, unknown[]>,
-  node: TSESTree.Node,
-) => {
-  return (
-    getSourceCode(context).getDeclaredVariables?.(node) ??
-    context.getDeclaredVariables(node)
-  );
-};
diff --git a/src/rules/utils/padding.ts b/src/rules/utils/padding.ts
@@ -15,7 +15,7 @@ import {
   type TSESTree,
 } from '@typescript-eslint/utils';
 import * as astUtils from './ast-utils';
-import { createRule, getSourceCode } from './misc';
+import { createRule } from './misc';
 
 // Statement types we'll respond to
 export const enum StatementType {
@@ -353,7 +353,7 @@ export const createPaddingRule = (
     create(context) {
       const paddingContext = {
         ruleContext: context,
-        sourceCode: getSourceCode(context),
+        sourceCode: context.sourceCode,
         scopeInfo: createScopeInfo(),
         configs,
       };
diff --git a/src/rules/utils/parseJestFnCall.ts b/src/rules/utils/parseJestFnCall.ts
diff --git a/src/rules/valid-expect.ts b/src/rules/valid-expect.ts
