eslint-plugin-jest 28.2.0 → 28.4.0

package/README.md

@@ -363,7 +363,7 @@ set to warn in.\
 | [require-to-throw-message](docs/rules/require-to-throw-message.md)           | Require a message for `toThrow()`                                         |     |     |     |     |
 | [require-top-level-describe](docs/rules/require-top-level-describe.md)       | Require test cases and hooks to be inside a `describe` block              |     |     |     |     |
 | [valid-describe-callback](docs/rules/valid-describe-callback.md)             | Enforce valid `describe()` callback                                       | ✅  |     |     |     |
-| [valid-expect](docs/rules/valid-expect.md)                                   | Enforce valid `expect()` usage                                            | ✅  |     |     |     |
+| [valid-expect](docs/rules/valid-expect.md)                                   | Enforce valid `expect()` usage                                            | ✅  |     | 🔧  |     |
 | [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md)             | Require promises that have expectations in their chain to be valid        | ✅  |     |     |     |
 | [valid-title](docs/rules/valid-title.md)                                     | Enforce valid titles                                                      | ✅  |     | 🔧  |     |
 

package/docs/rules/prefer-importing-jest-globals.md

@@ -42,6 +42,42 @@ describe('foo', () => {
 });
 ```
 
+## Options
+
+This rule can be configured as follows
+
+```json
+{
+  "type": "object",
+  "properties": {
+    "types": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["hook", "describe", "test", "expect", "jest", "unknown"]
+      }
+    }
+  },
+  "additionalProperties": false
+}
+```
+
+#### types
+
+A list of Jest global types to enforce explicit imports for. By default, all
+Jest globals are enforced.
+
+This option is useful when you only want to enforce explicit imports for a
+subset of Jest globals. For instance, when migrating to ESM, you might want to
+enforce explicit imports only for the `jest` global, as of
+[Jest's ESM documentation](https://jestjs.io/docs/ecmascript-modules#differences-between-esm-and-commonjs).
+
+```json5
+{
+  'jest/prefer-importing-jest-globals': ['error', { types: ['jest'] }],
+}
+```
+
 ## Further Reading
 
 - [Documentation](https://jestjs.io/docs/api)

package/docs/rules/valid-expect.md

@@ -3,8 +3,14 @@
 💼 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
+[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
 <!-- end auto-generated rule header -->
 
+> [!NOTE] Test function will be fixed if it is async and does not have await in
+> the async assertion.
+
 Ensure `expect()` is called with a single argument and there is an actual
 expectation made.
 

package/lib/rules/expect-expect.js

@@ -40,9 +40,9 @@ var _default = exports.default = (0, _utils2.createRule)({
       properties: {
         assertFunctionNames: {
           type: 'array',
-          items: [{
+          items: {
             type: 'string'
-          }]
+          }
         },
         additionalTestBlockFunctions: {
           type: 'array',

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

@@ -10,6 +10,7 @@ const createFixerImports = (isModule, functionsToImport) => {
   const allImportsFormatted = Array.from(functionsToImport).sort().join(', ');
   return isModule ? `import { ${allImportsFormatted} } from '@jest/globals';` : `const { ${allImportsFormatted} } = require('@jest/globals');`;
 };
+const allJestFnTypes = ['hook', 'describe', 'test', 'expect', 'jest', 'unknown'];
 var _default = exports.default = (0, _utils2.createRule)({
   name: __filename,
   meta: {
@@ -21,17 +22,34 @@ var _default = exports.default = (0, _utils2.createRule)({
     },
     fixable: 'code',
     type: 'problem',
-    schema: []
+    schema: [{
+      type: 'object',
+      properties: {
+        types: {
+          type: 'array',
+          items: {
+            type: 'string',
+            enum: allJestFnTypes
+          }
+        }
+      },
+      additionalProperties: false
+    }]
   },
-  defaultOptions: [],
+  defaultOptions: [{
+    types: allJestFnTypes
+  }],
   create(context) {
+    const {
+      types = allJestFnTypes
+    } = context.options[0] || {};
     const importedFunctionsWithSource = {};
     const functionsToImport = new Set();
     let reportingNode;
     return {
       ImportDeclaration(node) {
         node.specifiers.forEach(specifier => {
-          if (specifier.type === 'ImportSpecifier') {
+          if (specifier.type === _utils.AST_NODE_TYPES.ImportSpecifier) {
             importedFunctionsWithSource[specifier.local.name] = node.source.value;
           }
         });
@@ -41,7 +59,7 @@ var _default = exports.default = (0, _utils2.createRule)({
         if (!jestFnCall) {
           return;
         }
-        if (jestFnCall.head.type !== 'import') {
+        if (jestFnCall.head.type !== 'import' && types.includes(jestFnCall.type)) {
           functionsToImport.add(jestFnCall.name);
           reportingNode ||= jestFnCall.head.node;
         }

package/lib/rules/valid-expect.js

@@ -28,6 +28,14 @@ const getPromiseCallExpressionNode = node => {
   return null;
 };
 const findPromiseCallExpressionNode = node => node.parent?.parent && [_utils.AST_NODE_TYPES.CallExpression, _utils.AST_NODE_TYPES.ArrayExpression].includes(node.parent.type) ? getPromiseCallExpressionNode(node.parent) : null;
+const findFirstAsyncFunction = ({
+  parent
+}) => {
+  if (!parent) {
+    return null;
+  }
+  return (0, _utils2.isFunction)(parent) && parent.async ? parent : findFirstAsyncFunction(parent);
+};
 const getParentIfThenified = node => {
   const grandParentNode = node.parent?.parent;
   if (grandParentNode && grandParentNode.type === _utils.AST_NODE_TYPES.CallExpression && grandParentNode.callee.type === _utils.AST_NODE_TYPES.MemberExpression && (0, _utils2.isSupportedAccessor)(grandParentNode.callee.property) && ['then', 'catch'].includes((0, _utils2.getAccessorValue)(grandParentNode.callee.property)) && grandParentNode.parent) {
@@ -65,6 +73,7 @@ var _default = exports.default = (0, _utils2.createRule)({
       asyncMustBeAwaited: 'Async assertions must be awaited{{ orReturned }}',
       promisesWithAsyncAssertionsMustBeAwaited: 'Promises which return async assertions must be awaited{{ orReturned }}'
     },
+    fixable: 'code',
     type: 'suggestion',
     schema: [{
       type: 'object',
@@ -242,7 +251,19 @@ var _default = exports.default = (0, _utils2.createRule)({
               orReturned
             },
             messageId: finalNode === targetNode ? 'asyncMustBeAwaited' : 'promisesWithAsyncAssertionsMustBeAwaited',
-            node
+            node,
+            fix(fixer) {
+              if (!findFirstAsyncFunction(finalNode)) {
+                return [];
+              }
+              const returnStatement = finalNode.parent?.type === _utils.AST_NODE_TYPES.ReturnStatement ? finalNode.parent : null;
+              if (alwaysAwait && returnStatement) {
+                const sourceCodeText = (0, _utils2.getSourceCode)(context).getText(returnStatement);
+                const replacedText = sourceCodeText.replace('return', 'await');
+                return fixer.replaceText(returnStatement, replacedText);
+              }
+              return fixer.insertTextBefore(finalNode, 'await ');
+            }
           });
           if (isParentArrayExpression) {
             pushPromiseArrayException(finalNode.loc);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-jest",
-  "version": "28.2.0",
+  "version": "28.4.0",
   "description": "ESLint rules for Jest",
   "keywords": [
     "eslint",
@@ -29,7 +29,7 @@
     "prettier:write": "prettier --write 'docs/**/*.md' README.md '.github/**' package.json tsconfig.json src/globals.json .yarnrc.yml",
     "postpublish": "pinst --enable",
     "test": "jest",
-    "tools:regenerate-docs": "yarn prepack && eslint-doc-generator",
+    "regenerate-docs": "yarn prepack && eslint-doc-generator",
     "typecheck": "tsc -p ."
   },
   "commitlint": {
@@ -86,13 +86,13 @@
     "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 || ^9.0.0",
+    "eslint": "^7.0.0 || ^8.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-comments": "^3.1.2",
-    "eslint-plugin-eslint-plugin": "^5.0.6",
+    "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-import": "^2.25.1",
-    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-remote-tester": "^3.0.0",
     "eslint-remote-tester-repositories": "~1.0.0",
@@ -124,7 +124,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.8.1",
+  "packageManager": "yarn@3.8.2",
   "engines": {
     "node": "^16.10.0 || ^18.12.0 || >=20.0.0"
   },