Vitest 最佳实践

快速参考

ts
import { describe, it, expect, beforeEach, vi } from vitest

describe(功能名称, () => {
beforeEach(() => {
vi.clearAllMocks()
})

it(应执行特定操作, () => {
expect(actual).toBe(expected)
})

it.todo(计划中的测试)
it.skip(暂时禁用)
it.only(开发时仅运行此项)
})

常用断言

ts
// 相等性
expect(value).toBe(42) // 严格相等 (===)
expect(obj).toEqual({ a: 1 }) // 深度相等
expect(obj).toStrictEqual({ a: 1 }) // 严格深度相等（检查类型）

// 真值判断
expect(value).toBeTruthy()
expect(value).toBeFalsy()
expect(value).toBeNull()
expect(value).toBeUndefined()

// 数字
expect(0.1 + 0.2).toBeCloseTo(0.3)
expect(value).toBeGreaterThan(5)

// 字符串/数组
expect(str).toMatch(/pattern/)
expect(str).toContain(子字符串)
expect(array).toContain(元素)
expect(array).toHaveLength(3)

// 对象
expect(obj).toHaveProperty(key)
expect(obj).toHaveProperty(nested.key, value)
expect(obj).toMatchObject({ subset: 属性子集 })

// 异常
expect(() => fn()).toThrow()
expect(() => fn()).toThrow(错误消息)
expect(() => fn()).toThrow(/pattern/)

异步测试

ts
// Async/await（推荐）
it(获取数据, async () => {
const data = await fetchData()
expect(data).toEqual({ id: 1 })
})

// Promise 匹配器 - 务必使用 await
await expect(fetchData()).resolves.toEqual({ id: 1 })
await expect(fetchData()).rejects.toThrow(错误)

// 错误写法 - 会产生误报
expect(promise).resolves.toBe(value) // 缺少 await！

快速模拟参考

ts
const mockFn = vi.fn()
mockFn.mockReturnValue(42)
mockFn.mockResolvedValue({ data: value })

expect(mockFn).toHaveBeenCalled()
expect(mockFn).toHaveBeenCalledWith(arg1, arg2)
expect(mockFn).toHaveBeenCalledTimes(2)

附加文档

• - 模拟: 参见 references/mocking.md 了解模块模拟、监视、清理
• 配置: 参见 references/config.md 了解 vitest.config、设置文件、覆盖率
• 模式: 参见 references/patterns.md 了解定时器、快照、反模式

测试方法快速参考