@vitest/eslint-plugin 1.1.10 → 1.1.12

package/README.md

@@ -3,7 +3,7 @@
 ![npm](https://img.shields.io/npm/v/@vitest/eslint-plugin)
 [![ci](https://github.com/vitest-dev/eslint-plugin-vitest/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/veritem/eslint-plugin-vitest/actions/workflows/ci.yml)
 
-Eslint plugin for vitest
+ESLint plugin for Vitest
 
 ### Installation
 
@@ -21,7 +21,7 @@ npm install @vitest/eslint-plugin --save-dev
 
 ### Usage
 
-Make sure you're running eslint `v9.0.0` or higher for the latest version of this plugin to work. The following example is how your `eslint.config.js` should be setup for this plugin to work for you.
+Make sure you're running ESLint `v9.0.0` or higher for the latest version of this plugin to work. The following example is how your `eslint.config.js` should be setup for this plugin to work for you.
 
 ```js
 import vitest from "@vitest/eslint-plugin";
@@ -40,7 +40,7 @@ export default [
 ];
 ```
 
-If you're not using the latest version of eslint (version `v8.57.0` or lower) you can setup this plugin using the following configuration
+If you're not using the latest version of ESLint (version `v8.57.0` or lower) you can setup this plugin using the following configuration
 
 Add `vitest` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
@@ -65,7 +65,7 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
-If you're using old Eslint configuration, make sure to use legacy key like the following
+If you're using old ESLint configuration, make sure to use legacy key like the following
 
 ```js
 {
@@ -171,7 +171,7 @@ export default [
 | [require-to-throw-message](docs/rules/require-to-throw-message.md)                                                       | require toThrow() to be called with an error message                  |    | 🌐 |    |    |    |
 | [require-top-level-describe](docs/rules/require-top-level-describe.md)                                                   | enforce that all tests are in a top-level describe                    |    | 🌐 |    |    |    |
 | [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-title](docs/rules/valid-title.md)                                                                                 | enforce valid titles                                                  | ✅  |    | 🔧 |    |    |
 
 <!-- end auto-generated rules list -->

package/dist/index.cjs

@@ -23,7 +23,7 @@ function _interopNamespaceCompat(e) {
 const path__namespace = /*#__PURE__*/_interopNamespaceCompat(path);
 const ts__default = /*#__PURE__*/_interopDefaultCompat(ts);
 
-const version = "1.1.9";
+const version = "1.1.11";
 
 function createEslintRule(rule) {
   const createRule = utils.ESLintUtils.RuleCreator(
@@ -105,6 +105,15 @@ var ModifierName = /* @__PURE__ */ ((ModifierName2) => {
   ModifierName2["not"] = "not";
   ModifierName2["rejects"] = "rejects";
   ModifierName2["resolves"] = "resolves";
+  ModifierName2["returns"] = "returns";
+  ModifierName2["branded"] = "branded";
+  ModifierName2["asserts"] = "asserts";
+  ModifierName2["constructorParameters"] = "constructorParameters";
+  ModifierName2["parameters"] = "parameters";
+  ModifierName2["thisParameter"] = "thisParameter";
+  ModifierName2["guards"] = "guards";
+  ModifierName2["instance"] = "instance";
+  ModifierName2["items"] = "items";
   return ModifierName2;
 })(ModifierName || {});
 var EqualityMatcher = /* @__PURE__ */ ((EqualityMatcher2) => {
@@ -2344,6 +2353,11 @@ const getPromiseCallExpressionNode = (node) => {
   return null;
 };
 const promiseArrayExceptionKey = ({ start, end }) => `${start.line}:${start.column}-${end.line}:${end.column}`;
+const getNormalizeFunctionExpression = (functionExpression) => {
+  if (functionExpression.parent.type === utils.AST_NODE_TYPES.Property && functionExpression.type === utils.AST_NODE_TYPES.FunctionExpression)
+    return functionExpression.parent;
+  return functionExpression;
+};
 function getParentIfThenified(node) {
   const grandParentNode = node.parent?.parent;
   if (grandParentNode && grandParentNode.type === utils.AST_NODE_TYPES.CallExpression && grandParentNode.callee.type === utils.AST_NODE_TYPES.MemberExpression && isSupportedAccessor(grandParentNode.callee.property) && ["then", "catch"].includes(getAccessorValue(grandParentNode.callee.property)) && grandParentNode.parent)
@@ -2353,6 +2367,13 @@ function getParentIfThenified(node) {
 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 findFirstFunctionExpression = ({
+  parent
+}) => {
+  if (!parent)
+    return null;
+  return isFunction(parent) ? parent : findFirstFunctionExpression(parent);
+};
 const isAcceptableReturnNode = (node, allowReturn) => {
   if (allowReturn && node.type === utils.AST_NODE_TYPES.ReturnStatement)
     return true;
@@ -2380,6 +2401,7 @@ const validExpect = createEslintRule({
       promisesWithAsyncAssertionsMustBeAwaited: "Promises which return async assertions must be awaited{{orReturned}}"
     },
     type: "suggestion",
+    fixable: "code",
     schema: [
       {
         type: "object",
@@ -2413,6 +2435,7 @@ const validExpect = createEslintRule({
   }],
   create: (context, [{ alwaysAwait, asyncMatchers = defaultAsyncMatchers$1, minArgs = 1, maxArgs = 1 }]) => {
     const arrayExceptions = /* @__PURE__ */ new Set();
+    const descriptors = [];
     const pushPromiseArrayException = (loc) => arrayExceptions.add(promiseArrayExceptionKey(loc));
     const promiseArrayExceptionExists = (loc) => arrayExceptions.has(promiseArrayExceptionKey(loc));
     const findTopMostMemberExpression = (node) => {
@@ -2429,6 +2452,7 @@ const validExpect = createEslintRule({
     return {
       CallExpression(node) {
         const vitestFnCall = parseVitestFnCallWithReason(node, context);
+        const settings = parsePluginSettings(context.settings);
         if (typeof vitestFnCall === "string") {
           const reportingNode = node.parent?.type === utils.AST_NODE_TYPES.MemberExpression ? findTopMostMemberExpression(node.parent).property : node;
           if (vitestFnCall === "matcher-not-found") {
@@ -2452,6 +2476,8 @@ const validExpect = createEslintRule({
             return;
           }
           return;
+        } else if (vitestFnCall?.type === "expectTypeOf" && settings.typecheck) {
+          return;
         } else if (vitestFnCall?.type !== "expect") {
           return;
         }
@@ -2507,19 +2533,47 @@ const validExpect = createEslintRule({
         if (!parentNode?.parent || !shouldBeAwaited)
           return;
         const isParentArrayExpression = parentNode.parent.type === utils.AST_NODE_TYPES.ArrayExpression;
-        const orReturned = alwaysAwait ? "" : " or returned";
         const targetNode = getParentIfThenified(parentNode);
         const finalNode = findPromiseCallExpressionNode(targetNode) || targetNode;
         if (finalNode.parent && !isAcceptableReturnNode(finalNode.parent, !alwaysAwait) && !promiseArrayExceptionExists(finalNode.loc)) {
-          context.report({
-            loc: finalNode.loc,
-            data: { orReturned },
+          descriptors.push({
             messageId: finalNode === targetNode ? "asyncMustBeAwaited" : "promisesWithAsyncAssertionsMustBeAwaited",
-            node
+            node: finalNode
           });
           if (isParentArrayExpression)
             pushPromiseArrayException(finalNode.loc);
         }
+      },
+      "Program:exit"() {
+        const fixes = [];
+        descriptors.forEach(({ node, messageId }, index) => {
+          const orReturned = alwaysAwait ? "" : " or returned";
+          context.report({
+            loc: node.loc,
+            data: { orReturned },
+            messageId,
+            node,
+            fix(fixer) {
+              const functionExpression = findFirstFunctionExpression(node);
+              if (!functionExpression)
+                return null;
+              const foundAsyncFixer = fixes.some((fix) => fix.text === "async ");
+              if (!functionExpression.async && !foundAsyncFixer) {
+                const targetFunction = getNormalizeFunctionExpression(functionExpression);
+                fixes.push(fixer.insertTextBefore(targetFunction, "async "));
+              }
+              const returnStatement = node.parent?.type === utils.AST_NODE_TYPES.ReturnStatement ? node.parent : null;
+              if (alwaysAwait && returnStatement) {
+                const sourceCodeText = context.sourceCode.getText(returnStatement);
+                const replacedText = sourceCodeText.replace("return", "await");
+                fixes.push(fixer.replaceText(returnStatement, replacedText));
+              } else {
+                fixes.push(fixer.insertTextBefore(node, "await "));
+              }
+              return index === descriptors.length - 1 ? fixes : null;
+            }
+          });
+        });
       }
     };
   }

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { isAbsolute, posix } from 'node:path';
 import ts from 'typescript';
 import { createRequire } from 'node:module';
 
-const version = "1.1.9";
+const version = "1.1.11";
 
 function createEslintRule(rule) {
   const createRule = ESLintUtils.RuleCreator(
@@ -86,6 +86,15 @@ var ModifierName = /* @__PURE__ */ ((ModifierName2) => {
   ModifierName2["not"] = "not";
   ModifierName2["rejects"] = "rejects";
   ModifierName2["resolves"] = "resolves";
+  ModifierName2["returns"] = "returns";
+  ModifierName2["branded"] = "branded";
+  ModifierName2["asserts"] = "asserts";
+  ModifierName2["constructorParameters"] = "constructorParameters";
+  ModifierName2["parameters"] = "parameters";
+  ModifierName2["thisParameter"] = "thisParameter";
+  ModifierName2["guards"] = "guards";
+  ModifierName2["instance"] = "instance";
+  ModifierName2["items"] = "items";
   return ModifierName2;
 })(ModifierName || {});
 var EqualityMatcher = /* @__PURE__ */ ((EqualityMatcher2) => {
@@ -2325,6 +2334,11 @@ const getPromiseCallExpressionNode = (node) => {
   return null;
 };
 const promiseArrayExceptionKey = ({ start, end }) => `${start.line}:${start.column}-${end.line}:${end.column}`;
+const getNormalizeFunctionExpression = (functionExpression) => {
+  if (functionExpression.parent.type === AST_NODE_TYPES.Property && functionExpression.type === AST_NODE_TYPES.FunctionExpression)
+    return functionExpression.parent;
+  return functionExpression;
+};
 function getParentIfThenified(node) {
   const grandParentNode = node.parent?.parent;
   if (grandParentNode && grandParentNode.type === AST_NODE_TYPES.CallExpression && grandParentNode.callee.type === AST_NODE_TYPES.MemberExpression && isSupportedAccessor(grandParentNode.callee.property) && ["then", "catch"].includes(getAccessorValue(grandParentNode.callee.property)) && grandParentNode.parent)
@@ -2334,6 +2348,13 @@ function getParentIfThenified(node) {
 const findPromiseCallExpressionNode = (node) => node.parent?.parent && [AST_NODE_TYPES.CallExpression, AST_NODE_TYPES.ArrayExpression].includes(
   node.parent.type
 ) ? getPromiseCallExpressionNode(node.parent) : null;
+const findFirstFunctionExpression = ({
+  parent
+}) => {
+  if (!parent)
+    return null;
+  return isFunction(parent) ? parent : findFirstFunctionExpression(parent);
+};
 const isAcceptableReturnNode = (node, allowReturn) => {
   if (allowReturn && node.type === AST_NODE_TYPES.ReturnStatement)
     return true;
@@ -2361,6 +2382,7 @@ const validExpect = createEslintRule({
       promisesWithAsyncAssertionsMustBeAwaited: "Promises which return async assertions must be awaited{{orReturned}}"
     },
     type: "suggestion",
+    fixable: "code",
     schema: [
       {
         type: "object",
@@ -2394,6 +2416,7 @@ const validExpect = createEslintRule({
   }],
   create: (context, [{ alwaysAwait, asyncMatchers = defaultAsyncMatchers$1, minArgs = 1, maxArgs = 1 }]) => {
     const arrayExceptions = /* @__PURE__ */ new Set();
+    const descriptors = [];
     const pushPromiseArrayException = (loc) => arrayExceptions.add(promiseArrayExceptionKey(loc));
     const promiseArrayExceptionExists = (loc) => arrayExceptions.has(promiseArrayExceptionKey(loc));
     const findTopMostMemberExpression = (node) => {
@@ -2410,6 +2433,7 @@ const validExpect = createEslintRule({
     return {
       CallExpression(node) {
         const vitestFnCall = parseVitestFnCallWithReason(node, context);
+        const settings = parsePluginSettings(context.settings);
         if (typeof vitestFnCall === "string") {
           const reportingNode = node.parent?.type === AST_NODE_TYPES.MemberExpression ? findTopMostMemberExpression(node.parent).property : node;
           if (vitestFnCall === "matcher-not-found") {
@@ -2433,6 +2457,8 @@ const validExpect = createEslintRule({
             return;
           }
           return;
+        } else if (vitestFnCall?.type === "expectTypeOf" && settings.typecheck) {
+          return;
         } else if (vitestFnCall?.type !== "expect") {
           return;
         }
@@ -2488,19 +2514,47 @@ const validExpect = createEslintRule({
         if (!parentNode?.parent || !shouldBeAwaited)
           return;
         const isParentArrayExpression = parentNode.parent.type === AST_NODE_TYPES.ArrayExpression;
-        const orReturned = alwaysAwait ? "" : " or returned";
         const targetNode = getParentIfThenified(parentNode);
         const finalNode = findPromiseCallExpressionNode(targetNode) || targetNode;
         if (finalNode.parent && !isAcceptableReturnNode(finalNode.parent, !alwaysAwait) && !promiseArrayExceptionExists(finalNode.loc)) {
-          context.report({
-            loc: finalNode.loc,
-            data: { orReturned },
+          descriptors.push({
             messageId: finalNode === targetNode ? "asyncMustBeAwaited" : "promisesWithAsyncAssertionsMustBeAwaited",
-            node
+            node: finalNode
           });
           if (isParentArrayExpression)
             pushPromiseArrayException(finalNode.loc);
         }
+      },
+      "Program:exit"() {
+        const fixes = [];
+        descriptors.forEach(({ node, messageId }, index) => {
+          const orReturned = alwaysAwait ? "" : " or returned";
+          context.report({
+            loc: node.loc,
+            data: { orReturned },
+            messageId,
+            node,
+            fix(fixer) {
+              const functionExpression = findFirstFunctionExpression(node);
+              if (!functionExpression)
+                return null;
+              const foundAsyncFixer = fixes.some((fix) => fix.text === "async ");
+              if (!functionExpression.async && !foundAsyncFixer) {
+                const targetFunction = getNormalizeFunctionExpression(functionExpression);
+                fixes.push(fixer.insertTextBefore(targetFunction, "async "));
+              }
+              const returnStatement = node.parent?.type === AST_NODE_TYPES.ReturnStatement ? node.parent : null;
+              if (alwaysAwait && returnStatement) {
+                const sourceCodeText = context.sourceCode.getText(returnStatement);
+                const replacedText = sourceCodeText.replace("return", "await");
+                fixes.push(fixer.replaceText(returnStatement, replacedText));
+              } else {
+                fixes.push(fixer.insertTextBefore(node, "await "));
+              }
+              return index === descriptors.length - 1 ? fixes : null;
+            }
+          });
+        });
       }
     };
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vitest/eslint-plugin",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "license": "MIT",
   "description": "Eslint plugin for vitest",
   "repository": "vitest-dev/eslint-plugin-vitest",