feat!: add vitest v5 support

BREAKING CHANGE: support for Vitest <2, Node <222 has been dropped

Author: mcous

.github/workflows/ci.yaml

@@ -15,13 +15,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: ['18', '20', '22', '24']
+        node-version: ['22', '24']
         vitest-version: ['latest']
         include:
           - node-version: '24'
             vitest-version: '2'
           - node-version: '24'
             vitest-version: '3'
+          - node-version: '24'
+            vitest-version: 'beta'
 
     steps:
       - name: Checkout source
@@ -32,9 +34,16 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Override vitest version
+      - name: Override Vitest version
         if: matrix.vitest-version != 'latest'
-        run: pnpm add --no-lockfile -D vitest@${{ matrix.vitest-version }} @vitest/expect@${{ matrix.vitest-version }} @vitest/coverage-istanbul@${{ matrix.vitest-version }}
+        env:
+          version: ${{ matrix.vitest-version }}
+        run: |
+          pnpm add --no-lockfile -D \
+            vitest@${version} \
+            @vitest/expect@${version} \
+            @vitest/pretty-format@${version} \
+            @vitest/coverage-istanbul@${version}
 
       - name: Run tests
         run: pnpm coverage

package.json

@@ -41,9 +41,6 @@
     "test": "vitest"
   },
   "prettier": "@mcous/prettier-config",
-  "dependencies": {
-    "pretty-format": "^30.3.0"
-  },
   "devDependencies": {
     "@mcous/eslint-config": "^0.9.0",
     "@mcous/prettier-config": "^0.4.0",
@@ -59,16 +56,20 @@
     "vitest": "^4.1.5"
   },
   "peerDependencies": {
-    "@vitest/expect": ">=0.31.0 <5",
-    "vitest": ">=0.31.0 <5"
+    "@vitest/expect": "*",
+    "@vitest/pretty-format": "*",
+    "vitest": ">=2.0.2 <6"
   },
   "peerDependenciesMeta": {
     "@vitest/expect": {
       "optional": true
+    },
+    "@vitest/pretty-format": {
+      "optional": true
     }
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22"
   },
   "packageManager": "pnpm@10.33.1+sha512.05ba3c1d5d1c18f68df06470d74055e62d41fc110a0c660db1b2dfb2785327f04cf0f68345d4609bc52089e7fa0343c31593b2f9594e2c5d5da426230acc9820",
   "publishConfig": {

pnpm-lock.yaml

@@ -1,7 +1,7 @@
 import {
   format as prettyFormat,
   plugins as prettyFormatPlugins,
-} from 'pretty-format'
+} from '@vitest/pretty-format'
 
 import { type Behavior, BehaviorType } from './behaviors.ts'
 import { getBehaviorStack } from './stubs.ts'

src/debug.ts

@@ -1,8 +1,8 @@
-import type { AnyFunction, MockInstance } from './types.ts'
+import type { AnyFunction, AnyMockInstance } from './types.ts'
 
 /** Get the fallback implementation of a mock if no matching stub is found. */
 export const getFallbackImplementation = (
-  mock: MockInstance,
+  mock: AnyMockInstance,
 ): AnyFunction | undefined => {
   return (
     (mock.getMockImplementation() as AnyFunction | undefined) ??
@@ -25,7 +25,7 @@ interface TinyspyInternals {
  * which is stored on a Symbol key in the mock object.
  */
 const getTinyspyInternals = (
-  mock: MockInstance,
+  mock: AnyMockInstance,
 ): TinyspyInternals | undefined => {
   const maybeTinyspy = mock as unknown as Record<PropertyKey, unknown>
 

src/fallback-implementation.ts

@@ -10,7 +10,6 @@ import type {
   AsFunction,
   Mock,
   MockInstance,
-  NormalizeMockable,
   ParametersOf,
 } from './types.ts'
 
@@ -75,13 +74,13 @@ export const configureMock = <TFunc extends AnyMockable>(
 
 export const validateMock = <TFunc extends AnyMockable>(
   maybeMock: TFunc | MockInstance<TFunc>,
-): MockInstance<NormalizeMockable<TFunc>> => {
+): MockInstance<TFunc> => {
   if (
     typeof maybeMock === 'function' &&
     'mockImplementation' in maybeMock &&
     typeof maybeMock.mockImplementation === 'function'
   ) {
-    return maybeMock as unknown as MockInstance<NormalizeMockable<TFunc>>
+    return maybeMock as unknown as MockInstance<TFunc>
   }
 
   throw new NotAMockFunctionError(maybeMock)
@@ -102,6 +101,6 @@ export const getBehaviorStack = <TFunc extends AnyMockable>(
 
 export const asMock = <TFunc extends AnyMockable>(
   mock: MockInstance<TFunc>,
-): Mock<NormalizeMockable<TFunc>> => {
-  return mock as unknown as Mock<NormalizeMockable<TFunc>>
+): Mock<TFunc> => {
+  return mock as unknown as Mock<TFunc>
 }