vitest-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Vitest Testing Skill

Vitest 测试 Skill

Core Patterns

核心模式

Basic Test

基础测试

typescript
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { Calculator } from './calculator';

describe('Calculator', () => {
  let calc: Calculator;
  beforeEach(() => { calc = new Calculator(); });

  it('adds two numbers', () => {
    expect(calc.add(2, 3)).toBe(5);
  });

  it('throws on divide by zero', () => {
    expect(() => calc.divide(10, 0)).toThrow();
  });
});
typescript
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { Calculator } from './calculator';

describe('Calculator', () => {
  let calc: Calculator;
  beforeEach(() => { calc = new Calculator(); });

  it('adds two numbers', () => {
    expect(calc.add(2, 3)).toBe(5);
  });

  it('throws on divide by zero', () => {
    expect(() => calc.divide(10, 0)).toThrow();
  });
});

Mocking (vi instead of jest)

Mock(使用 vi 而不是 jest)

typescript
import { vi } from 'vitest';

// Mock module
vi.mock('./database', () => ({
  getUser: vi.fn().mockResolvedValue({ name: 'Alice' }),
  saveUser: vi.fn().mockResolvedValue(true),
}));

// Mock function
const mockFn = vi.fn();
mockFn.mockReturnValue(42);
mockFn.mockResolvedValue({ data: 'test' });

// Spy
const spy = vi.spyOn(console, 'log').mockImplementation(() => {});
expect(spy).toHaveBeenCalledWith('message');
spy.mockRestore();

// Timers
vi.useFakeTimers();
vi.advanceTimersByTime(1000);
vi.runAllTimers();
vi.useRealTimers();
typescript
import { vi } from 'vitest';

// Mock module
vi.mock('./database', () => ({
  getUser: vi.fn().mockResolvedValue({ name: 'Alice' }),
  saveUser: vi.fn().mockResolvedValue(true),
}));

// Mock function
const mockFn = vi.fn();
mockFn.mockReturnValue(42);
mockFn.mockResolvedValue({ data: 'test' });

// Spy
const spy = vi.spyOn(console, 'log').mockImplementation(() => {});
expect(spy).toHaveBeenCalledWith('message');
spy.mockRestore();

// Timers
vi.useFakeTimers();
vi.advanceTimersByTime(1000);
vi.runAllTimers();
vi.useRealTimers();

In-Source Testing

源码内测试

typescript
// src/math.ts — tests alongside code!
export function add(a: number, b: number) { return a + b; }
export function multiply(a: number, b: number) { return a * b; }

if (import.meta.vitest) {
  const { it, expect } = import.meta.vitest;
  it('adds', () => { expect(add(2, 3)).toBe(5); });
  it('multiplies', () => { expect(multiply(3, 4)).toBe(12); });
}
typescript
// src/math.ts — tests alongside code!
export function add(a: number, b: number) { return a + b; }
export function multiply(a: number, b: number) { return a * b; }

if (import.meta.vitest) {
  const { it, expect } = import.meta.vitest;
  it('adds', () => { expect(add(2, 3)).toBe(5); });
  it('multiplies', () => { expect(multiply(3, 4)).toBe(12); });
}

Snapshot Testing

Snapshot 测试

typescript
it('serializes user', () => {
  expect(serializeUser(user)).toMatchSnapshot();
});

it('inline snapshot', () => {
  expect(serializeUser(user)).toMatchInlineSnapshot(`
    { "name": "Alice", "email": "alice@test.com" }
  `);
});
typescript
it('serializes user', () => {
  expect(serializeUser(user)).toMatchSnapshot();
});

it('inline snapshot', () => {
  expect(serializeUser(user)).toMatchInlineSnapshot(`
    { "name": "Alice", "email": "alice@test.com" }
  `);
});

React Component Testing

React 组件测试

typescript
import { render, screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import Button from './Button';

describe('Button', () => {
  it('renders with label', () => {
    render(<Button label="Click me" />);
    expect(screen.getByText('Click me')).toBeDefined();
  });
});
typescript
import { render, screen } from '@testing-library/react';
import { describe, it, expect } from 'vitest';
import Button from './Button';

describe('Button', () => {
  it('renders with label', () => {
    render(<Button label="Click me" />);
    expect(screen.getByText('Click me')).toBeDefined();
  });
});

Anti-Patterns

反模式

BadGoodWhy
jest.fn()
vi.fn()
Vitest uses
vi
jest.mock()
vi.mock()
Different namespace
No type safetyTypeScript + strictVitest is TS-first
不推荐推荐原因
jest.fn()
vi.fn()
Vitest 使用
vi
jest.mock()
vi.mock()
命名空间不同
缺少类型安全TypeScript + strictVitest 以 TypeScript 为先

Quick Reference

快速参考

TaskCommand
Run once
npx vitest run
Watch
npx vitest
(default)
UI
npx vitest --ui
Coverage
npx vitest --coverage
Specific file
npx vitest run src/math.test.ts
Filter
npx vitest run -t "adds"
任务命令
单次运行
npx vitest run
监听模式
npx vitest
(默认)
UI
npx vitest --ui
覆盖率
npx vitest --coverage
指定文件
npx vitest run src/math.test.ts
筛选
npx vitest run -t "adds"

vitest.config.ts

vitest.config.ts

typescript
import { defineConfig } from 'vitest/config';
export default defineConfig({
  test: {
    globals: true,
    environment: 'jsdom',
    coverage: { provider: 'v8', reporter: ['text', 'html'] },
    include: ['src/**/*.{test,spec}.{js,ts,tsx}'],
    includeSource: ['src/**/*.{js,ts}'],
  },
});
typescript
import { defineConfig } from 'vitest/config';
export default defineConfig({
  test: {
    globals: true,
    environment: 'jsdom',
    coverage: { provider: 'v8', reporter: ['text', 'html'] },
    include: ['src/**/*.{test,spec}.{js,ts,tsx}'],
    includeSource: ['src/**/*.{js,ts}'],
  },
});

Deep Patterns →
reference/playbook.md

深入模式 →
reference/playbook.md

§SectionLines
1Production ConfigurationConfig, workspace, setup file
2Mocking Patternsvi.mock, spies, timers, fetch
3React Testing LibraryComponents, hooks, providers
4Snapshot & Inline SnapshotsFile, inline, serializers
5Table-Driven Teststest.each, describe.each
6In-Source TestingCo-located tests in source
7API / Integration TestingServer tests with fetch
8CI/CD IntegrationGitHub Actions, scripts
9Debugging Quick-Reference10 common problems
10Best Practices Checklist13 items
§章节行数
1生产环境配置配置、工作区、设置文件
2Mock 模式vi.mock、spy、计时器、fetch
3React Testing Library组件、hooks、providers
4Snapshot 与 Inline Snapshot文件、内联、序列化器
5表格驱动测试test.each、describe.each
6源码内测试与源代码同置的测试
7API / 集成测试使用 fetch 的服务器测试
8CI/CD 集成GitHub Actions、脚本
9调试快速参考10 个常见问题
10最佳实践检查清单13 项