feat: added Vitest support (#203)

Author: JoshuaKGoldberg

README.md

@@ -153,6 +153,21 @@ See the _Documentation_ link for each supported framework for how to set up cons
         </a>
       </td>
     </tr>
+    <tr>
+      <td>Vitest</td>
+      <td>
+        ✅️
+        ✨
+      </td>
+      <td>
+        <code>"vitest"</code>
+      </td>
+      <td>
+        <a href="./docs/Vitest.md">
+          <code>Vitest.md</code>
+        </a>
+      </td>
+    </tr>
     <tr>
       <td>Cypress</td>
       <td>⚙️</td>
@@ -203,16 +218,6 @@ See the _Documentation_ link for each supported framework for how to set up cons
         </a>
       </td>
     </tr>
-    <tr>
-      <td>Vitest</td>
-      <td>⚙️</td>
-      <td></td>
-      <td>
-        <a href="https://github.com/JoshuaKGoldberg/console-fail-test/issues/197">
-          <code>/issues/197</code>
-        </a>
-      </td>
-    </tr>
   </tbody>
 </table>
 

docs/Vitest.md

@@ -0,0 +1,26 @@
+# Vitest
+
+Vitest is supported both as a testing framework and a spy library.
+It will be auto-detected if available.
+
+## Setup
+
+In your `vitest.config.ts`, include `console-fail-test/vitest` in your [`setupFiles`](https://vitest.dev/config/#setupfiles):
+
+```js
+// vitest.config.ts
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  setupFiles: ["console-fail-test/setup"],
+});
+```
+
+Alternately, if you have a setup file already being run first, or you'd like to manually enable this in individual files, you can use the Node API:
+
+```js
+// some.test.js
+import * as vitest from "vitest";
+
+require("console-fail-test").cft();
+```

src/environments/selectTestFramework.ts

@@ -7,11 +7,13 @@ import { selectLabEnvironment } from "./lab";
 import { selectMochaEnvironment } from "./mocha";
 import { selectNodeTapEnvironment } from "./nodeTap";
 import { TestFrameworkSelector } from "./testEnvironmentTypes";
+import { selectVitestEnvironment } from "./vitest";
 
 const testEnvironmentsByName = new Map<SupportedTestFramework, TestFrameworkSelector>([
   ["jasmine", selectJasmineEnvironment],
   ["jest", selectJestEnvironment],
   ["mocha", selectMochaEnvironment],
+  ["vitest", selectVitestEnvironment],
 ]);
 
 const detectableTestEnvironmentSelectors: TestFrameworkSelector[] = [
@@ -20,6 +22,8 @@ const detectableTestEnvironmentSelectors: TestFrameworkSelector[] = [
   selectLabEnvironment,
   selectNodeTapEnvironment,
 
+  selectVitestEnvironment,
+
   // Jest should come before Jasmine because Jest includes a monkey-patched Jasmine
   selectJestEnvironment,
   selectJasmineEnvironment,

src/environments/vitest.ts

@@ -0,0 +1,36 @@
+import { TestFrameworkSelector } from "./testEnvironmentTypes";
+
+declare interface VitestModule {
+  afterEach: (callback: () => void) => void;
+  beforeEach: (callback: () => void) => void;
+}
+
+declare const __vitest_index__: VitestModule | undefined;
+
+export const selectVitestEnvironment: TestFrameworkSelector = () => {
+  if (typeof __vitest_index__ === "undefined") {
+    return undefined;
+  }
+
+  const vitest = __vitest_index__;
+
+  let afterEachCallback: (() => void) | undefined;
+  let beforeEachCallback: (() => void) | undefined;
+
+  vitest.afterEach(() => {
+    afterEachCallback?.();
+  });
+
+  vitest.beforeEach(() => {
+    beforeEachCallback?.();
+  });
+
+  return {
+    afterEach: (callback) => {
+      afterEachCallback = callback;
+    },
+    beforeEach: (callback) => {
+      beforeEachCallback = callback;
+    },
+  };
+};

src/spies/selectSpyFactory.ts

@@ -5,15 +5,19 @@ import { selectJasmineSpyFactory } from "./jasmine";
 import { selectJestSpyFactory } from "./jest";
 import { selectSinonSpyFactory } from "./sinon";
 import { SpyFactoryGetter as SpyFactorySelector } from "./spyTypes";
+import { selectVitestSpyFactory } from "./vitest";
 
 const spyFactoriesByName = new Map<SupportedSpyLibrary, SpyFactorySelector>([
   ["fallback", selectFallbackSpyFactory],
   ["jest", selectJestSpyFactory],
   ["jasmine", selectJasmineSpyFactory],
   ["sinon", selectSinonSpyFactory],
+  ["vitest", selectVitestSpyFactory],
 ]);
 
 const detectableSpyFactorySelectors: SpyFactorySelector[] = [
+  selectVitestSpyFactory,
+
   // Jest should come before Jasmine because Jest includes a monkey-patched Jasmine
   selectJestSpyFactory,
   selectJasmineSpyFactory,

src/spies/vitest.ts

@@ -0,0 +1,45 @@
+import { SpyCallArgs, SpyFactory, SpyFactoryGetter } from "./spyTypes";
+
+declare interface Vitest {
+  vi: {
+    spyOn(container: unknown, methodName: string): ViSpy;
+  };
+}
+
+declare interface ViSpy {
+  calls: SpyCallArgs[];
+  restore(): void;
+}
+
+declare const __vitest_index__: Vitest | undefined;
+
+const isVitestModule = (spyLibrary: unknown): spyLibrary is Vitest => {
+  return (
+    typeof spyLibrary === "object" &&
+    !!(spyLibrary as Partial<Vitest>).vi &&
+    typeof (spyLibrary as Vitest).vi.spyOn === "function"
+  );
+};
+
+const createVitestSpyFactory = (spyLibrary: Vitest): SpyFactory => {
+  return (container: any, methodName: string) => {
+    const spy = spyLibrary.vi.spyOn(container, methodName);
+
+    return {
+      getCalls: () => spy.calls,
+      restore: spy.restore,
+    };
+  };
+};
+
+export const selectVitestSpyFactory: SpyFactoryGetter = ({ spyLibrary }) => {
+  if (isVitestModule(spyLibrary)) {
+    return createVitestSpyFactory(spyLibrary);
+  }
+
+  if (typeof __vitest_index__ !== "undefined" && isVitestModule(__vitest_index__)) {
+    return createVitestSpyFactory(__vitest_index__);
+  }
+
+  return undefined;
+};