fix: replace usage of deprecated Context#getSourceCode

jest-community · Jan 1, 2024 · 86197f6 · 86197f6
1 parent 55326e1
commit 86197f6
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 14 deletions.
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 } from './utils';
+import { createRule, getSourceCode } from './utils';
 
 function hasTests(node: TSESTree.Comment) {
   return /^\s*[xf]?(test|it|describe)(\.\w+|\[['"]\w+['"]\])?\s*\(/mu.test(
@@ -23,7 +23,7 @@ export default createRule({
   },
   defaultOptions: [],
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     function checkNode(node: TSESTree.Comment) {
       if (!hasTests(node)) {

diff --git a/src/rules/no-done-callback.ts b/src/rules/no-done-callback.ts
@@ -3,7 +3,13 @@ import {
   type TSESLint,
   type TSESTree,
 } from '@typescript-eslint/utils';
-import { createRule, getNodeName, isFunction, parseJestFnCall } from './utils';
+import {
+  createRule,
+  getNodeName,
+  getSourceCode,
+  isFunction,
+  parseJestFnCall,
+} from './utils';
 
 const findCallbackArg = (
   node: TSESTree.CallExpression,
@@ -104,7 +110,7 @@ export default createRule({
               fix(fixer) {
                 const { body, params } = callback;
 
-                const sourceCode = context.getSourceCode();
+                const sourceCode = getSourceCode(context);
                 const firstBodyToken = sourceCode.getFirstToken(body);
                 const lastBodyToken = sourceCode.getLastToken(body);
 

diff --git a/src/rules/prefer-comparison-matcher.ts b/src/rules/prefer-comparison-matcher.ts
@@ -4,6 +4,7 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
+  getSourceCode,
   isBooleanLiteral,
   isStringNode,
   parseJestFnCall,
@@ -116,7 +117,7 @@ export default createRule({
 
         context.report({
           fix(fixer) {
-            const sourceCode = context.getSourceCode();
+            const sourceCode = getSourceCode(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,6 +5,7 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
+  getSourceCode,
   isBooleanLiteral,
   parseJestFnCall,
 } from './utils';
@@ -74,7 +75,7 @@ export default createRule({
         const buildFixer =
           (equalityMatcher: string): TSESLint.ReportFixFunction =>
           fixer => {
-            const sourceCode = context.getSourceCode();
+            const sourceCode = getSourceCode(context);
 
             // preserve the existing modifier if it's not a negation
             let modifierText =

diff --git a/src/rules/prefer-mock-promise-shorthand.ts b/src/rules/prefer-mock-promise-shorthand.ts
@@ -5,6 +5,7 @@ import {
   createRule,
   getAccessorValue,
   getNodeName,
+  getSourceCode,
   isFunction,
   isSupportedAccessor,
 } from './utils';
@@ -70,7 +71,7 @@ export default createRule({
         messageId: 'useMockShorthand',
         data: { replacement },
         fix(fixer) {
-          const sourceCode = context.getSourceCode();
+          const sourceCode = getSourceCode(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 } from './utils';
+import { createRule, getNodeName, getSourceCode } from './utils';
 
 const findNodeObject = (
   node: TSESTree.CallExpression | TSESTree.MemberExpression,
@@ -57,7 +57,7 @@ const getAutoFixMockImplementation = (
   }
 
   const [arg] = jestFnCall.arguments;
-  const argSource = arg && context.getSourceCode().getText(arg);
+  const argSource = arg && getSourceCode(context).getText(arg);
 
   return argSource
     ? `.mockImplementation(${argSource})`

diff --git a/src/rules/prefer-to-contain.ts b/src/rules/prefer-to-contain.ts
@@ -7,6 +7,7 @@ import {
   createRule,
   getAccessorValue,
   getFirstMatcherArg,
+  getSourceCode,
   hasOnlyOneArgument,
   isBooleanLiteral,
   isSupportedAccessor,
@@ -89,7 +90,7 @@ export default createRule({
 
         context.report({
           fix(fixer) {
-            const sourceCode = context.getSourceCode();
+            const sourceCode = getSourceCode(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
@@ -178,7 +178,7 @@ export const removeExtraArgumentsFixer = (
   const firstArg = func.arguments[from];
   const lastArg = func.arguments[func.arguments.length - 1];
 
-  const sourceCode = context.getSourceCode();
+  const sourceCode = getSourceCode(context);
   let tokenAfterLastParam = sourceCode.getTokenAfter(lastArg)!;
 
   if (tokenAfterLastParam.value === ',') {
@@ -230,11 +230,19 @@ export const getFirstMatcherArg = (
   return followTypeAssertionChain(firstArg);
 };
 
+export const getSourceCode = (
+  context: TSESLint.RuleContext<string, unknown[]>,
+) => {
+  return 'sourceCode' in context
+    ? (context.sourceCode as TSESLint.SourceCode)
+    : context.getSourceCode();
+};
+
 export const getScope = (
   context: TSESLint.RuleContext<string, unknown[]>,
   node: TSESTree.Node,
 ) => {
-  const sourceCode = context.getSourceCode();
+  const sourceCode = getSourceCode(context);
 
   if ('getScope' in sourceCode) {
     return sourceCode.getScope(node);
@@ -247,7 +255,7 @@ export const getAncestors = (
   context: TSESLint.RuleContext<string, unknown[]>,
   node: TSESTree.Node,
 ) => {
-  const sourceCode = context.getSourceCode();
+  const sourceCode = getSourceCode(context);
 
   if ('getAncestors' in sourceCode) {
     return sourceCode.getAncestors(node);
@@ -260,7 +268,7 @@ export const getDeclaredVariables = (
   context: TSESLint.RuleContext<string, unknown[]>,
   node: TSESTree.Node,
 ) => {
-  const sourceCode = context.getSourceCode();
+  const sourceCode = getSourceCode(context);
 
   if ('getDeclaredVariables' in sourceCode) {
     return sourceCode.getDeclaredVariables(node);