eslint-plugin-jest 28.13.5 → 29.0.0

package/README.md

@@ -329,7 +329,7 @@ Manually fixable by
 | [expect-expect](docs/rules/expect-expect.md)                                         | Enforce assertion to be made in a test body                               |     | ✅  |     |     |
 | [max-expects](docs/rules/max-expects.md)                                             | Enforces a maximum number assertion calls in a test body                  |     |     |     |     |
 | [max-nested-describe](docs/rules/max-nested-describe.md)                             | Enforces a maximum depth to nested describe calls                         |     |     |     |     |
-| [no-alias-methods](docs/rules/no-alias-methods.md)                                   | Disallow alias methods                                                    | ✅  | 🎨  | 🔧  |     |
+| [no-alias-methods](docs/rules/no-alias-methods.md)                                   | Disallow alias methods                                                    | ✅  |     | 🔧  |     |
 | [no-commented-out-tests](docs/rules/no-commented-out-tests.md)                       | Disallow commented out tests                                              |     | ✅  |     |     |
 | [no-conditional-expect](docs/rules/no-conditional-expect.md)                         | Disallow calling `expect` conditionally                                   | ✅  |     |     |     |
 | [no-conditional-in-test](docs/rules/no-conditional-in-test.md)                       | Disallow conditional logic in tests                                       |     |     |     |     |

package/docs/rules/no-alias-methods.md

@@ -1,8 +1,6 @@
 # Disallow alias methods (`no-alias-methods`)
 
-💼⚠️ This rule is enabled in the ✅ `recommended`
-[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
-This rule _warns_ in the 🎨 `style`
+💼 This rule is enabled in the ✅ `recommended`
 [config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
 
 🔧 This rule is automatically fixable by the
@@ -10,7 +8,7 @@ This rule _warns_ in the 🎨 `style`
 
 <!-- end auto-generated rule header -->
 
-> These aliases are going to be removed in the next major version of Jest - see
+> These aliases have been removed in Jest v30 - see
 > <https://github.com/jestjs/jest/issues/13164> for more
 
 Several Jest methods have alias names, such as `toThrow` having the alias of

package/docs/rules/no-deprecated-functions.md

@@ -53,5 +53,5 @@ Jest 27.
 
 ### `jest.genMockFromModule`
 
-This function was renamed to `createMockFromModule` in Jest 26, and is scheduled
-for removal in Jest 30.
+This function was renamed to `createMockFromModule` in Jest 26, and removed in
+Jest 30.

package/lib/index.js

@@ -38,7 +38,6 @@ const recommendedRules = {
   'jest/valid-title': 'error'
 };
 const styleRules = {
-  'jest/no-alias-methods': 'warn',
   'jest/prefer-to-be': 'error',
   'jest/prefer-to-contain': 'error',
   'jest/prefer-to-have-length': 'error'

package/lib/rules/expect-expect.js

@@ -68,7 +68,7 @@ var _default = exports.default = (0, _utils2.createRule)({
       for (const node of nodes) {
         const index = node.type === _utils.AST_NODE_TYPES.CallExpression ? unchecked.indexOf(node) : -1;
         if (node.type === _utils.AST_NODE_TYPES.FunctionDeclaration) {
-          const declaredVariables = (0, _utils2.getDeclaredVariables)(context, node);
+          const declaredVariables = context.sourceCode.getDeclaredVariables(node);
           const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
           checkCallExpressionUsed(testCallExpressions);
         }
@@ -88,7 +88,7 @@ var _default = exports.default = (0, _utils2.createRule)({
           unchecked.push(node);
         } else if (matchesAssertFunctionName(name, assertFunctionNames)) {
           // Return early in case of nested `it` statements.
-          checkCallExpressionUsed((0, _utils2.getAncestors)(context, node));
+          checkCallExpressionUsed(context.sourceCode.getAncestors(node));
         }
       },
       'Program:exit'() {

package/lib/rules/no-commented-out-tests.js

@@ -22,7 +22,9 @@ var _default = exports.default = (0, _utils.createRule)({
   },
   defaultOptions: [],
   create(context) {
-    const sourceCode = (0, _utils.getSourceCode)(context);
+    const {
+      sourceCode
+    } = context;
     function checkNode(node) {
       if (!hasTests(node)) {
         return;

package/lib/rules/no-conditional-expect.js

@@ -28,7 +28,7 @@ var _default = exports.default = (0, _utils2.createRule)({
     const decreaseConditionalDepth = () => inTestCase && conditionalDepth--;
     return {
       FunctionDeclaration(node) {
-        const declaredVariables = (0, _utils2.getDeclaredVariables)(context, node);
+        const declaredVariables = context.sourceCode.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
         if (testCallExpressions.length > 0) {
           inTestCase = true;

package/lib/rules/no-confusing-set-timeout.js

@@ -36,7 +36,7 @@ var _default = exports.default = (0, _utils.createRule)({
           shouldEmitOrderSetTimeout = true;
           return;
         }
-        if (!['global', 'module'].includes((0, _utils.getScope)(context, node).type)) {
+        if (!['global', 'module'].includes(context.sourceCode.getScope(node).type)) {
           context.report({
             messageId: 'globalSetTimeout',
             node

package/lib/rules/no-disabled-tests.js

@@ -44,7 +44,7 @@ var _default = exports.default = (0, _utils.createRule)({
         }
       },
       'CallExpression[callee.name="pending"]'(node) {
-        if ((0, _utils.resolveScope)((0, _utils.getScope)(context, node), 'pending')) {
+        if ((0, _utils.resolveScope)(context.sourceCode.getScope(node), 'pending')) {
           return;
         }
         context.report({

package/lib/rules/no-done-callback.js

@@ -79,7 +79,9 @@ var _default = exports.default = (0, _utils2.createRule)({
                 body,
                 params
               } = callback;
-              const sourceCode = (0, _utils2.getSourceCode)(context);
+              const {
+                sourceCode
+              } = context;
               const firstBodyToken = sourceCode.getFirstToken(body);
               const lastBodyToken = sourceCode.getLastToken(body);
               const [firstParam] = params;
@@ -92,7 +94,7 @@ var _default = exports.default = (0, _utils2.createRule)({
 
               /* istanbul ignore if */
               if (!firstBodyToken || !lastBodyToken || !tokenBeforeFirstParam || !tokenAfterLastParam) {
-                throw new Error(`Unexpected null when attempting to fix ${(0, _utils2.getFilename)(context)} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
+                throw new Error(`Unexpected null when attempting to fix ${context.filename} - please file a github issue at https://github.com/jest-community/eslint-plugin-jest`);
               }
               let argumentFix = fixer.replaceText(firstParam, '()');
               if (tokenBeforeFirstParam.value === '(' && tokenAfterLastParam.value === ')') {

package/lib/rules/no-jasmine-globals.js

@@ -35,7 +35,7 @@ var _default = exports.default = (0, _utils2.createRule)({
           return;
         }
         if (calleeName === 'spyOn' || calleeName === 'spyOnProperty' || calleeName === 'fail' || calleeName === 'pending') {
-          if ((0, _utils2.resolveScope)((0, _utils2.getScope)(context, node), calleeName)) {
+          if ((0, _utils2.resolveScope)(context.sourceCode.getScope(node), calleeName)) {
             // It's a local variable, not a jasmine global.
             return;
           }

package/lib/rules/no-large-snapshots.js

@@ -20,7 +20,7 @@ const reportOnViolation = (context, node, {
   }
   let isAllowed = false;
   if (node.type === _utils.AST_NODE_TYPES.ExpressionStatement && 'left' in node.expression && node.expression.left.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(node.expression.left.property)) {
-    const fileName = (0, _utils2.getFilename)(context);
+    const fileName = context.filename;
     const allowedSnapshotsInFile = allowedSnapshots[fileName];
     if (allowedSnapshotsInFile) {
       const snapshotName = (0, _utils2.getAccessorValue)(node.expression.left.property);
@@ -75,7 +75,7 @@ var _default = exports.default = (0, _utils2.createRule)({
   },
   defaultOptions: [{}],
   create(context, [options]) {
-    if ((0, _utils2.getFilename)(context).endsWith('.snap')) {
+    if (context.filename.endsWith('.snap')) {
       return {
         ExpressionStatement(node) {
           reportOnViolation(context, node, options);

package/lib/rules/no-test-return-statement.js

@@ -43,7 +43,7 @@ var _default = exports.default = (0, _utils2.createRule)({
         });
       },
       FunctionDeclaration(node) {
-        const declaredVariables = (0, _utils2.getDeclaredVariables)(context, node);
+        const declaredVariables = context.sourceCode.getDeclaredVariables(node);
         const testCallExpressions = (0, _utils2.getTestCallExpressionsFromDeclaredVariables)(declaredVariables, context);
         if (testCallExpressions.length === 0) {
           return;

package/lib/rules/prefer-comparison-matcher.js

@@ -85,7 +85,9 @@ var _default = exports.default = (0, _utils2.createRule)({
         }
         context.report({
           fix(fixer) {
-            const sourceCode = (0, _utils2.getSourceCode)(context);
+            const {
+              sourceCode
+            } = context;
 
             // preserve the existing modifier if it's not a negation
             const modifierText = modifier && (0, _utils2.getAccessorValue)(modifier) !== 'not' ? `.${(0, _utils2.getAccessorValue)(modifier)}` : '';

package/lib/rules/prefer-equality-matcher.js

@@ -53,7 +53,9 @@ var _default = exports.default = (0, _utils2.createRule)({
         // value is itself negated by the "not" modifier
         const addNotModifier = (comparison.operator === '!==' ? !matcherValue : matcherValue) === hasNot;
         const buildFixer = equalityMatcher => fixer => {
-          const sourceCode = (0, _utils2.getSourceCode)(context);
+          const {
+            sourceCode
+          } = context;
 
           // preserve the existing modifier if it's not a negation
           let modifierText = modifier && (0, _utils2.getAccessorValue)(modifier) !== 'not' ? `.${(0, _utils2.getAccessorValue)(modifier)}` : '';

package/lib/rules/prefer-importing-jest-globals.js

@@ -69,7 +69,9 @@ var _default = exports.default = (0, _utils2.createRule)({
             jestFunctions: Array.from(functionsToImport).join(', ')
           },
           fix(fixer) {
-            const sourceCode = (0, _utils2.getSourceCode)(context);
+            const {
+              sourceCode
+            } = context;
             const [firstNode] = sourceCode.ast.body;
 
             // check if "use strict" directive exists
@@ -80,7 +82,7 @@ var _default = exports.default = (0, _utils2.createRule)({
             if (importNode?.type === _utils.AST_NODE_TYPES.ImportDeclaration) {
               for (const specifier of importNode.specifiers) {
                 if (specifier.type === _utils.AST_NODE_TYPES.ImportSpecifier) {
-                  let importName = specifier.imported.name ?? '';
+                  let importName = 'name' in specifier.imported ? specifier.imported.name : '';
                   const local = (0, _utils2.getAccessorValue)(specifier.local);
                   if (local !== importName) {
                     importName = `${importName} as ${local}`;

package/lib/rules/prefer-jest-mocked.js

@@ -42,7 +42,7 @@ var _default = exports.default = (0, _utils2.createRule)({
       if (left.type !== _utils.AST_NODE_TYPES.Identifier || right.type !== _utils.AST_NODE_TYPES.Identifier || left.name !== 'jest' || !mockTypes.includes(right.name)) {
         return;
       }
-      const fnName = (0, _utils2.getSourceCode)(context).text.slice(...(0, _utils2.followTypeAssertionChain)(node.expression).range);
+      const fnName = context.sourceCode.text.slice(...(0, _utils2.followTypeAssertionChain)(node.expression).range);
       context.report({
         node,
         messageId: 'useJestMocked',

package/lib/rules/prefer-mock-promise-shorthand.js

@@ -49,7 +49,9 @@ var _default = exports.default = (0, _utils2.createRule)({
           replacement
         },
         fix(fixer) {
-          const sourceCode = (0, _utils2.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

package/lib/rules/prefer-spy-on.js

@@ -34,7 +34,7 @@ const getAutoFixMockImplementation = (jestFnCall, context) => {
     return '';
   }
   const [arg] = jestFnCall.arguments;
-  const argSource = arg && (0, _utils2.getSourceCode)(context).getText(arg);
+  const argSource = arg && context.sourceCode.getText(arg);
   return argSource ? `.mockImplementation(${argSource})` : '.mockImplementation()';
 };
 var _default = exports.default = (0, _utils2.createRule)({

package/lib/rules/prefer-to-contain.js

@@ -58,7 +58,9 @@ var _default = exports.default = (0, _utils2.createRule)({
         const hasNot = jestFnCall.modifiers.some(nod => (0, _utils2.getAccessorValue)(nod) === 'not');
         context.report({
           fix(fixer) {
-            const sourceCode = (0, _utils2.getSourceCode)(context);
+            const {
+              sourceCode
+            } = context;
 
             // we need to negate the expectation if the current expected
             // value is itself negated by the "not" modifier

package/lib/rules/unbound-method.js

@@ -37,10 +37,7 @@ var _default = exports.default = (0, _utils2.createRule)({
     ...baseRule?.meta,
     docs: {
       description: 'Enforce unbound methods are called with their expected scope',
-      requiresTypeChecking: true,
-      ...baseRule?.meta.docs,
-      // mark this as not recommended
-      recommended: undefined
+      ...baseRule?.meta.docs
     }
   },
   create(context) {

package/lib/rules/utils/misc.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getFirstMatcherArg = exports.getFilename = exports.getDeclaredVariables = exports.getAncestors = exports.findTopMostCallExpression = exports.createRule = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeAlias = void 0;
+exports.getFirstMatcherArg = exports.findTopMostCallExpression = exports.createRule = exports.TestCaseName = exports.ModifierName = exports.HookName = exports.EqualityMatcher = exports.DescribeAlias = void 0;
 exports.getNodeName = getNodeName;
-exports.replaceAccessorFixer = exports.removeExtraArgumentsFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = exports.getSourceCode = exports.getScope = void 0;
+exports.replaceAccessorFixer = exports.removeExtraArgumentsFixer = exports.isFunction = exports.isBooleanLiteral = exports.hasOnlyOneArgument = exports.getTestCallExpressionsFromDeclaredVariables = void 0;
 var _path = require("path");
 var _utils = require("@typescript-eslint/utils");
 var _package = require("../../../package.json");
@@ -120,7 +120,9 @@ exports.replaceAccessorFixer = replaceAccessorFixer;
 const removeExtraArgumentsFixer = (fixer, context, func, from) => {
   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 === ',') {
     tokenAfterLastParam = sourceCode.getTokenAfter(tokenAfterLastParam);
@@ -156,34 +158,4 @@ const getFirstMatcherArg = expectFnCall => {
   }
   return (0, _followTypeAssertionChain.followTypeAssertionChain)(firstArg);
 };
-
-/* istanbul ignore next */
-exports.getFirstMatcherArg = getFirstMatcherArg;
-const getFilename = context => {
-  return context.filename ?? context.getFilename();
-};
-
-/* istanbul ignore next */
-exports.getFilename = getFilename;
-const getSourceCode = context => {
-  return context.sourceCode ?? context.getSourceCode();
-};
-
-/* istanbul ignore next */
-exports.getSourceCode = getSourceCode;
-const getScope = (context, node) => {
-  return getSourceCode(context).getScope?.(node) ?? context.getScope();
-};
-
-/* istanbul ignore next */
-exports.getScope = getScope;
-const getAncestors = (context, node) => {
-  return getSourceCode(context).getAncestors?.(node) ?? context.getAncestors();
-};
-
-/* istanbul ignore next */
-exports.getAncestors = getAncestors;
-const getDeclaredVariables = (context, node) => {
-  return getSourceCode(context).getDeclaredVariables?.(node) ?? context.getDeclaredVariables(node);
-};
-exports.getDeclaredVariables = getDeclaredVariables;
+exports.getFirstMatcherArg = getFirstMatcherArg;

package/lib/rules/utils/padding.js

@@ -280,7 +280,7 @@ const createPaddingRule = (name, description, configs, deprecated = false) => {
     create(context) {
       const paddingContext = {
         ruleContext: context,
-        sourceCode: (0, _misc.getSourceCode)(context),
+        sourceCode: context.sourceCode,
         scopeInfo: createScopeInfo(),
         configs
       };

package/lib/rules/utils/parseJestFnCall.js

@@ -50,10 +50,6 @@ const determineJestFnType = name => {
   return 'unknown';
 };
 const ValidJestFnCallChains = ['afterAll', 'afterEach', 'beforeAll', 'beforeEach', 'describe', 'describe.each', 'describe.only', 'describe.only.each', 'describe.skip', 'describe.skip.each', 'fdescribe', 'fdescribe.each', 'xdescribe', 'xdescribe.each', 'it', 'it.concurrent', 'it.concurrent.failing', 'it.concurrent.each', 'it.concurrent.failing.each', 'it.concurrent.failing.only.each', 'it.concurrent.failing.skip.each', 'it.concurrent.only.each', 'it.concurrent.skip.each', 'it.each', 'it.failing', 'it.failing.each', 'it.only', 'it.only.each', 'it.only.failing', 'it.only.failing.each', 'it.skip', 'it.skip.each', 'it.skip.failing', 'it.skip.failing.each', 'it.todo', 'fit', 'fit.each', 'fit.failing', 'fit.failing.each', 'xit', 'xit.each', 'xit.failing', 'xit.failing.each', 'test', 'test.concurrent', 'test.concurrent.failing', 'test.concurrent.each', 'test.concurrent.failing.each', 'test.concurrent.failing.only.each', 'test.concurrent.failing.skip.each', 'test.concurrent.only.each', 'test.concurrent.skip.each', 'test.each', 'test.failing', 'test.failing.each', 'test.only', 'test.only.each', 'test.only.failing', 'test.only.failing.each', 'test.skip', 'test.skip.each', 'test.skip.failing', 'test.skip.failing.each', 'test.todo', 'xtest', 'xtest.each', 'xtest.failing', 'xtest.failing.each'];
-
-// todo: switch back to using declaration merging once https://github.com/typescript-eslint/typescript-eslint/pull/8485
-//  is landed
-
 const resolvePossibleAliasedGlobal = (global, context) => {
   const globalAliases = context.settings.jest?.globalAliases ?? {};
   const alias = Object.entries(globalAliases).find(([, aliases]) => aliases.includes(global));
@@ -215,13 +211,9 @@ const describeImportDefAsImport = def => {
   if (def.parent.importKind === 'type') {
     return null;
   }
-  let imported = def.node.imported.name ?? '';
-  if ('value' in def.node.imported) {
-    imported = def.node.imported.value;
-  }
   return {
     source: def.parent.source.value,
-    imported,
+    imported: 'name' in def.node.imported ? def.node.imported.name : def.node.imported.value,
     local: def.node.local.name
   };
 };
@@ -305,7 +297,7 @@ const resolveScope = (scope, identifier) => {
 exports.resolveScope = resolveScope;
 const resolveToJestFn = (context, accessor) => {
   const identifier = (0, _utils2.getAccessorValue)(accessor);
-  const maybeImport = resolveScope((0, _utils2.getScope)(context, accessor), identifier);
+  const maybeImport = resolveScope(context.sourceCode.getScope(accessor), identifier);
 
   // the identifier was found as a local variable or function declaration
   // meaning it's not a function from jest

package/lib/rules/valid-expect.js

@@ -286,7 +286,7 @@ var _default = exports.default = (0, _utils2.createRule)({
               }
               const returnStatement = node.parent?.type === _utils.AST_NODE_TYPES.ReturnStatement ? node.parent : null;
               if (alwaysAwait && returnStatement) {
-                const sourceCodeText = (0, _utils2.getSourceCode)(context).getText(returnStatement);
+                const sourceCodeText = context.sourceCode.getText(returnStatement);
                 const replacedText = sourceCodeText.replace('return', 'await');
                 fixes.push(fixer.replaceText(returnStatement, replacedText));
               } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "28.13.5",
+  "version": "29.0.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -67,7 +67,7 @@
     ]
   },
   "dependencies": {
-    "@typescript-eslint/utils": "^6.0.0 || ^7.0.0 || ^8.0.0"
+    "@typescript-eslint/utils": "^8.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
@@ -80,18 +80,18 @@
     "@schemastore/package": "^0.0.10",
     "@semantic-release/changelog": "^6.0.0",
     "@semantic-release/git": "^10.0.0",
-    "@tsconfig/node16": "^16.0.0",
+    "@tsconfig/node20": "^20.0.0",
     "@types/eslint": "^8.4.6",
     "@types/jest": "^29.0.0",
-    "@types/node": "^16.0.0",
+    "@types/node": "^20.0.0",
     "@types/semver": "^7.5.8",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^7.0.0",
-    "@typescript-eslint/utils": "^7.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@typescript-eslint/utils": "^8.0.0",
     "babel-jest": "^29.0.0",
     "babel-plugin-replace-ts-export-assignment": "^0.0.2",
     "dedent": "^1.5.0",
-    "eslint": "^7.0.0 || ^8.0.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^10.0.0",
     "eslint-doc-generator": "^2.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
@@ -111,13 +111,12 @@
     "rimraf": "^5.0.0",
     "semantic-release": "^24.0.0",
     "semver": "^7.3.5",
-    "strip-ansi": "^6.0.0",
     "ts-node": "^10.2.1",
     "typescript": "^5.0.4"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.0.0 || ^7.0.0 || ^8.0.0",
-    "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "eslint": "^8.57.0 || ^9.0.0",
     "jest": "*"
   },
   "peerDependenciesMeta": {
@@ -130,7 +129,7 @@
   },
   "packageManager": "yarn@3.8.7",
   "engines": {
-    "node": "^16.10.0 || ^18.12.0 || >=20.0.0"
+    "node": "^20.12.0 || ^22.0.0 || >=24.0.0"
   },
   "publishConfig": {
     "provenance": true