fix: Update ESLint peer requirements to 8.40.0

This was already required by certain rules which depend on features in
ESLint 8.40.0, this release is merely adjusting the peer dependency
range to accurately reflect that.

Author: mskelton

package.json

@@ -58,7 +58,7 @@
     "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "eslint": ">=7",
+    "eslint": ">=8.40.0",
     "eslint-plugin-jest": ">=25"
   },
   "peerDependenciesMeta": {

src/rules/expect-expect.ts

@@ -1,7 +1,6 @@
 import { Rule } from 'eslint';
 import ESTree from 'estree';
 import { dig, isExpectCall, isTestCall } from '../utils/ast';
-import { getSourceCode } from '../utils/misc';
 
 function isAssertionCall(
   context: Rule.RuleContext,
@@ -21,7 +20,6 @@ export default {
       ...((context.options?.[0] as Record<string, unknown>) ?? {}),
     };
 
-    const sourceCode = getSourceCode(context);
     const unchecked: ESTree.CallExpression[] = [];
 
     function checkExpressions(nodes: ESTree.Node[]) {
@@ -43,10 +41,7 @@ export default {
         } else if (
           isAssertionCall(context, node, options.assertFunctionNames)
         ) {
-          const ancestors = sourceCode.getAncestors
-            ? sourceCode.getAncestors(node)
-            : context.getAncestors();
-
+          const ancestors = context.sourceCode.getAncestors(node);
           checkExpressions(ancestors);
         }
       },

src/rules/missing-playwright-await.ts

@@ -7,7 +7,6 @@ import {
   isIdentifier,
   isPropertyAccessor,
 } from '../utils/ast';
-import { getSourceCode } from '../utils/misc';
 
 const validTypes = new Set([
   'AwaitExpression',
@@ -101,7 +100,6 @@ function getCallType(
 
 export default {
   create(context) {
-    const sourceCode = getSourceCode(context);
     const options = context.options[0] || {};
     const awaitableMatchers = new Set([
       ...expectPlaywrightMatchers,
@@ -136,7 +134,7 @@ export default {
       // find where it is referenced. When we find the reference, we can
       // re-check validity.
       if (node.parent.type === 'VariableDeclarator') {
-        const scope = sourceCode.getScope(node.parent.parent);
+        const scope = context.sourceCode.getScope(node.parent.parent);
 
         for (const ref of scope.references) {
           const refParent = (ref.identifier as Rule.Node).parent;

src/rules/no-unsafe-references.ts

@@ -1,7 +1,7 @@
-import { AST, Rule, Scope, SourceCode } from 'eslint';
+import { AST, Rule, Scope } from 'eslint';
 import * as ESTree from 'estree';
 import { getStringValue, isFunction, isPageMethod } from '../utils/ast';
-import { getSourceCode, truthy } from '../utils/misc';
+import { truthy } from '../utils/misc';
 
 /** Collect all variable references in the parent scopes recursively. */
 function collectVariables(scope: Scope.Scope | null): string[] {
@@ -48,19 +48,22 @@ function addArgument(
 }
 
 /** Get the opening parenthesis of the function. */
-function getParen(sourceCode: SourceCode, node: ESTree.Node): AST.Token | null {
-  let token: AST.Token | null = sourceCode.getFirstToken(node);
+function getParen(
+  context: Rule.RuleContext,
+  node: ESTree.Node,
+): AST.Token | null {
+  let token: AST.Token | null = context.sourceCode.getFirstToken(node);
 
   while (token && token.value !== '(') {
-    token = sourceCode.getTokenAfter(token);
+    token = context.sourceCode.getTokenAfter(token);
   }
 
   return token;
 }
 
 /** Add a parameter to the function. */
 function addParam(
-  sourceCode: SourceCode,
+  context: Rule.RuleContext,
   fixer: Rule.RuleFixer,
   node: ESTree.ArrowFunctionExpression | ESTree.FunctionExpression,
   refs: string,
@@ -77,7 +80,7 @@ function addParam(
   }
 
   // If the function has no params, add the reference after the opening parenthesis
-  const token = getParen(sourceCode, node);
+  const token = getParen(context, node);
   return token ? fixer.insertTextAfter(token, `[${refs}]`) : null;
 }
 
@@ -90,8 +93,7 @@ export default {
         const [fn] = node.arguments;
         if (!fn || !isFunction(fn)) return;
 
-        const sourceCode = getSourceCode(context);
-        const { through, upper } = sourceCode.getScope(fn.body);
+        const { through, upper } = context.sourceCode.getScope(fn.body);
         const allRefs = new Set(collectVariables(upper));
 
         // This logic is confusing at first. If we find a variable within the
@@ -120,7 +122,7 @@ export default {
 
                 return [
                   addArgument(fixer, node, refs),
-                  addParam(sourceCode, fixer, fn, refs),
+                  addParam(context, fixer, fn, refs),
                 ].filter(truthy);
               },
             });

src/rules/prefer-to-contain.ts

@@ -5,7 +5,6 @@ import {
   isBooleanLiteral,
   isPropertyAccessor,
 } from '../utils/ast';
-import { getSourceCode } from '../utils/misc';
 import { parseExpectCall } from '../utils/parseExpectCall';
 import { KnownCallExpression } from '../utils/types';
 
@@ -49,8 +48,6 @@ export default {
 
         context.report({
           fix(fixer) {
-            const sourceCode = getSourceCode(context);
-
             // We need to negate the expectation if the current expected
             // value is itself negated by the "not" modifier
             const addNotModifier =
@@ -71,7 +68,7 @@ export default {
               // replace the matcher argument with the value from the "includes"
               fixer.replaceText(
                 expectCall.args[0],
-                sourceCode.getText(includesCall.arguments[0]),
+                context.sourceCode.getText(includesCall.arguments[0]),
               ),
             ];
 

src/rules/prefer-web-first-assertions.ts

@@ -1,7 +1,6 @@
 import { Rule } from 'eslint';
 import ESTree from 'estree';
 import { getRawValue, getStringValue, isBooleanLiteral } from '../utils/ast';
-import { getSourceCode } from '../utils/misc';
 import { parseExpectCall } from '../utils/parseExpectCall';
 
 type MethodConfig = {
@@ -63,8 +62,7 @@ function dereference(context: Rule.RuleContext, node: ESTree.Node) {
     return node;
   }
 
-  const sourceCode = getSourceCode(context);
-  const scope = sourceCode.getScope(node);
+  const scope = context.sourceCode.getScope(node);
 
   // Find the variable declaration and return the initializer
   for (const ref of scope.references) {

src/utils/misc.ts

@@ -1,14 +1,8 @@
-import { Rule } from 'eslint';
-
 export const getAmountData = (amount: number) => ({
   amount: amount.toString(),
   s: amount === 1 ? '' : 's',
 });
 
-export function getSourceCode(context: Rule.RuleContext) {
-  return context.sourceCode ?? context.getSourceCode();
-}
-
 export const truthy = Boolean as unknown as <T>(
   value: T | undefined | null | false | 0 | '',
 ) => value is T;