ci: include Vitest versions in matrix (#42)

Author: mcous

.github/workflows/ci.yaml

@@ -9,14 +9,19 @@ on:
 
 jobs:
   test:
-    name: Test / Node.js ${{ matrix.node-version }} / ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+    name: Test / Node.js ${{ matrix.node-version }} / Vitest ${{ matrix.vitest-version }}
+    runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: ['18', '20', '22']
+        node-version: ['18', '20', '22', '24']
+        vitest-version: ['latest']
+        include:
+          - node-version: '24'
+            vitest-version: '2'
+          - node-version: '24'
+            vitest-version: '3'
 
     steps:
       - name: Checkout source
@@ -27,6 +32,10 @@ jobs:
         with:
           node-version: ${{ matrix.node-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 }}
+
       - name: Run tests
         run: pnpm coverage
 

test/debug.test.ts

@@ -3,6 +3,7 @@ import { describe, expect, it, vi } from 'vitest'
 import * as subject from '../src/vitest-when.ts'
 
 const DEBUG_OPTIONS = { log: false }
+const VI_FN_NAME_MATCHER = /(?:vi\.fn\(\)|spy)/u
 
 describe('vitest-when debug', () => {
   it('debugs a non-stubbed spy', () => {
@@ -11,7 +12,7 @@ describe('vitest-when debug', () => {
     const result = subject.debug(spy, DEBUG_OPTIONS)
 
     expect(result).toEqual({
-      name: 'vi.fn()',
+      name: expect.stringMatching(VI_FN_NAME_MATCHER),
       stubbings: [],
       unmatchedCalls: [],
       description: expect.stringContaining(
@@ -28,7 +29,7 @@ describe('vitest-when debug', () => {
     const result = subject.debug(spy, DEBUG_OPTIONS)
 
     expect(result).toEqual({
-      name: 'vi.fn()',
+      name: expect.stringMatching(VI_FN_NAME_MATCHER),
       stubbings: [
         {
           args: ['hello', 'world'],
@@ -52,7 +53,7 @@ describe('vitest-when debug', () => {
     const result = subject.debug(spy, DEBUG_OPTIONS)
 
     expect(result).toMatchObject({
-      name: 'vi.fn()',
+      name: expect.stringMatching(VI_FN_NAME_MATCHER),
       stubbings: [
         {
           args: [expect.any(String)],
@@ -75,7 +76,7 @@ describe('vitest-when debug', () => {
     const result = subject.debug(spy, DEBUG_OPTIONS)
 
     expect(result).toMatchObject({
-      name: 'vi.fn()',
+      name: expect.stringMatching(VI_FN_NAME_MATCHER),
       stubbings: [
         {
           args: [expect.any(String)],

test/typing.test-d.ts

@@ -139,8 +139,8 @@ describe('vitest-when type signatures', () => {
       .calledWith(1)
       .thenReturn({ simpleMethod: () => '' })
 
-    expectTypeOf(result).toEqualTypeOf<
-      MockedClass<new (input: number) => SimpleClass>
+    expectTypeOf(result).branded.toEqualTypeOf<
+      MockedClass<typeof SimpleClass>
     >()
   })
 
@@ -202,9 +202,7 @@ describe('vitest-when type signatures', () => {
       .calledWith(42)
       .thenReturn({ simpleMethod: () => '' })
 
-    expectTypeOf(result).branded.toEqualTypeOf<
-      MockedClass<new (input: number) => SimpleClass>
-    >()
+    expectTypeOf(result).toEqualTypeOf<MockedClass<typeof SimpleClass>>()
 
     // @ts-expect-error: args wrong type
     subject.when(TestClass).calledWith('42')
@@ -218,9 +216,7 @@ describe('vitest-when type signatures', () => {
         this.simpleMethod = () => `${input}`
       })
 
-    expectTypeOf(result).branded.toEqualTypeOf<
-      MockedClass<new (input: number) => SimpleClass>
-    >()
+    expectTypeOf(result).toEqualTypeOf<MockedClass<typeof SimpleClass>>()
 
     // @ts-expect-error: args wrong type
     subject.when(TestClass).calledWith('42')

test/vitest-when.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it, vi } from 'vitest'
+import vitestPkg from 'vitest/package.json' with { type: 'json' }
 
 import * as subject from '../src/vitest-when.ts'
 import { SimpleClass } from './fixtures.ts'
@@ -19,6 +20,7 @@ expect.extend({
 })
 
 const noop = () => undefined
+const vitestMajorVersion = Number(vitestPkg.version.split('.')[0])
 
 describe('vitest-when', () => {
   it('should raise an error if passed a non-spy', () => {
@@ -60,16 +62,18 @@ describe('vitest-when', () => {
     expect(spy()).toEqual(100)
   })
 
-  it('should fall back to original implementation after reset', () => {
-    const spy = vi.fn((n) => 2 * n)
+  it.skipIf(vitestMajorVersion < 3)(
+    'should fall back to original implementation after reset',
+    () => {
+      const spy = vi.fn((n) => 2 * n)
 
-    vi.resetAllMocks()
-    expect(spy(2)).toEqual(4)
+      vi.resetAllMocks()
 
-    subject.when(spy).calledWith(1).thenReturn(4)
-    expect(spy(1)).toEqual(4)
-    expect(spy(2)).toEqual(4)
-  })
+      subject.when(spy).calledWith(1).thenReturn(4)
+      expect(spy(1)).toEqual(4)
+      expect(spy(2)).toEqual(4)
+    },
+  )
 
   it('should return a number of times', () => {
     const spy = subject