test: use vitest

Author: posva

__tests__/Promised.spec.ts

@@ -1,9 +1,19 @@
+// @vitest-environment jsdom
 /* eslint-disable no-unused-vars */
 import { mount } from '@vue/test-utils'
-import { mockWarn } from 'jest-mock-warn'
 import { PromisedImpl as Promised } from '../src/Promised'
 import fakePromise from 'faked-promise'
 import { h } from 'vue'
+import {
+  describe,
+  it,
+  expect,
+  beforeEach,
+  afterEach,
+  afterAll,
+  vi,
+} from 'vitest'
+import { mockWarn } from './vitest-mock-warn'
 
 // keep a real setTimeout
 const timeout = setTimeout
@@ -95,9 +105,9 @@ describe('Promised', () => {
 
   describe('three slots pendingDelay', () => {
     beforeEach(() => {
-      jest.useFakeTimers('modern')
-      jest.spyOn(global, 'setTimeout')
-      jest.spyOn(global, 'clearTimeout')
+      vi.useFakeTimers()
+      vi.spyOn(global, 'setTimeout')
+      vi.spyOn(global, 'clearTimeout')
     })
     afterEach(() => {
       // @ts-expect-error: mocked
@@ -107,13 +117,13 @@ describe('Promised', () => {
     })
 
     afterAll(() => {
-      jest.useRealTimers()
+      vi.useRealTimers()
     })
 
     it('displays nothing before the delay', async () => {
       let { wrapper } = factory({ pendingDelay: 300 })
       expect(wrapper.text()).toBe('')
-      jest.runAllTimers()
+      vi.runAllTimers()
       await wrapper.vm.$nextTick()
       expect(wrapper.text()).toMatch('pending')
     })
@@ -192,7 +202,7 @@ describe('Promised', () => {
 
   mockWarn()
 
-  it('warns on missing slot', async () => {
+  it.only('warns on missing slot', async () => {
     const [promise, _resolve, reject] = fakePromise<any>()
     mount(Promised, {
       propsData: { promise, pendingDelay: 0 },
@@ -206,6 +216,6 @@ describe('Promised', () => {
     reject(new Error())
     await tick()
 
-    expect('Missing slot "rejected"').toHaveBeenWarned()
+    expect(/Missing slot "rejected"/).toHaveBeenWarned()
   })
 })

__tests__/__snapshots__/Promised.spec.ts.snap

@@ -0,0 +1,129 @@
+// https://github.com/posva/jest-mock-warn/blob/master/src/index.js
+
+import { afterEach, beforeEach, expect, SpyInstance, vi } from 'vitest'
+
+interface CustomMatchers<R = unknown> {
+  toHaveBeenWarned(): R
+  toHaveBeenWarnedLast(): R
+  toHaveBeenWarnedTimes(n: number): R
+}
+
+declare module 'vitest' {
+  interface Assertion<T = any> extends CustomMatchers<T> {}
+  interface AsymmetricMatchersContaining extends CustomMatchers {}
+}
+
+export function mockWarn() {
+  expect.extend({
+    toHaveBeenWarned(received: string | RegExp) {
+      asserted.set(received.toString(), received)
+      const passed = warn.mock.calls.some((args) =>
+        typeof received === 'string'
+          ? args[0].indexOf(received) > -1
+          : received.test(args[0])
+      )
+      if (passed) {
+        return {
+          pass: true,
+          message: () => `expected "${received}" not to have been warned.`,
+        }
+      } else {
+        const msgs = warn.mock.calls.map((args) => args[0]).join('\n - ')
+        return {
+          pass: false,
+          message: () =>
+            `expected "${received}" to have been warned.\n\nActual messages:\n\n - ${msgs}`,
+        }
+      }
+    },
+
+    toHaveBeenWarnedLast(received: string | RegExp) {
+      asserted.set(received.toString(), received)
+      const lastCall = warn.mock.calls[warn.mock.calls.length - 1][0]
+      const passed =
+        typeof received === 'string'
+          ? lastCall.indexOf(received) > -1
+          : received.test(lastCall)
+      if (passed) {
+        return {
+          pass: true,
+          message: () => `expected "${received}" not to have been warned last.`,
+        }
+      } else {
+        const msgs = warn.mock.calls.map((args) => args[0]).join('\n - ')
+        return {
+          pass: false,
+          message: () =>
+            `expected "${received}" to have been warned last.\n\nActual messages:\n\n - ${msgs}`,
+        }
+      }
+    },
+
+    toHaveBeenWarnedTimes(received: string | RegExp, n: number) {
+      asserted.set(received.toString(), received)
+      let found = 0
+      warn.mock.calls.forEach((args) => {
+        const isFound =
+          typeof received === 'string'
+            ? args[0].indexOf(received) > -1
+            : received.test(args[0])
+        if (isFound) {
+          found++
+        }
+      })
+
+      if (found === n) {
+        return {
+          pass: true,
+          message: () =>
+            `expected "${received}" to have been warned ${n} times.`,
+        }
+      } else {
+        return {
+          pass: false,
+          message: () =>
+            `expected "${received}" to have been warned ${n} times but got ${found}.`,
+        }
+      }
+    },
+  })
+
+  let warn: SpyInstance
+  const asserted = new Map<string, string | RegExp>()
+
+  beforeEach(() => {
+    asserted.clear()
+    warn = vi.spyOn(console, 'warn')
+    warn.mockImplementation(() => {})
+  })
+
+  afterEach(() => {
+    const assertedArray = Array.from(asserted)
+    const nonAssertedWarnings = warn.mock.calls
+      .map((args) => args[0])
+      .filter((received) => {
+        return !assertedArray.some(([key, assertedMsg]) => {
+          return typeof assertedMsg === 'string'
+            ? received.indexOf(assertedMsg) > -1
+            : assertedMsg.test(received)
+        })
+      })
+    warn.mockRestore()
+    if (nonAssertedWarnings.length) {
+      nonAssertedWarnings.forEach((warning) => {
+        console.warn(warning)
+      })
+      throw new Error(`test case threw unexpected warnings.`)
+    }
+  })
+}
+
+declare global {
+  namespace Vi {
+    interface JestAssertion<T = any> {
+      toHaveBeenWarned(): void
+      toHaveBeenWarnedLast(): void
+      toHaveBeenWarnedTimes(n: number): void
+    }
+  }
+}

__tests__/vitest-mock-warn.ts

@@ -24,7 +24,7 @@
     "lint": "prettier -c --parser typescript \"{src,__tests__,e2e}/**/*.[jt]s?(x)\"",
     "lint:fix": "pnpm run lint --write",
     "test:types": "tsc --build tsconfig.json",
-    "test:unit": "jest --coverage",
+    "test:unit": "vitest --coverage",
     "test": "pnpm run lint && pnpm run test:types && pnpm run test:unit && pnpm run build && pnpm run build:dts"
   },
   "files": [
@@ -49,17 +49,16 @@
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-terser": "^0.4.3",
-    "@size-limit/preset-small-lib": "^8.1.0",
-    "@types/jest": "^27.5.2",
+    "@size-limit/preset-small-lib": "^8.2.4",
     "@types/jsdom": "^21.1.1",
     "@vitejs/plugin-vue": "^4.2.3",
+    "@vitest/coverage-c8": "^0.31.1",
     "@vue/compiler-sfc": "^3.3.4",
     "@vue/server-renderer": "^3.3.4",
     "@vue/test-utils": "^2.3.2",
     "conventional-changelog-cli": "^2.2.2",
     "faked-promise": "^2.2.2",
-    "jest": "^27.5.1",
-    "jest-mock-warn": "^1.1.0",
+    "jsdom": "^22.0.0",
     "lint-staged": "^13.2.2",
     "mande": "^2.0.6",
     "pascalcase": "^2.0.0",
@@ -68,9 +67,9 @@
     "rollup": "^3.23.0",
     "rollup-plugin-typescript2": "^0.34.1",
     "size-limit": "^8.2.4",
-    "ts-jest": "^27.1.5",
     "typescript": "^5.0.4",
     "vite": "^4.0.0",
+    "vitest": "^0.31.1",
     "vue": "^3.3.4",
     "vue-prism-component": "^2.0.0",
     "yorkie": "^2.0.0"