Vitestのベストプラクティス

クイックリファレンス

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

describe('feature name', () => {
  beforeEach(() => {
    vi.clearAllMocks()
  })

  it('should do something specific', () => {
    expect(actual).toBe(expected)
  })

  it.todo('planned test')
  it.skip('temporarily disabled')
  it.only('run only this during dev')
})

よく使うアサーション

// 等価性
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('substring')
expect(array).toContain(item)
expect(array).toHaveLength(3)

// オブジェクト
expect(obj).toHaveProperty('key')
expect(obj).toHaveProperty('nested.key', 'value')
expect(obj).toMatchObject({ subset: 'of properties' })

// 例外
expect(() => fn()).toThrow()
expect(() => fn()).toThrow('error message')
expect(() => fn()).toThrow(/pattern/)

非同期テスト

// async/await (推奨)
it('fetches data', async () => {
  const data = await fetchData()
  expect(data).toEqual({ id: 1 })
})

// Promise マッチャー - 必ず await を付ける
await expect(fetchData()).resolves.toEqual({ id: 1 })
await expect(fetchData()).rejects.toThrow('Error')

// 間違い - false positive を作成する
expect(promise).resolves.toBe(value)  // await がない!

モックのクイックリファレンス

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

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

検証ゲート

テストを追加または変更する際は、このシーケンスを使用してください。各ステップに達成目標があります。

1. テストスイートを実行する — パッケージまたはワークスペースのルートから、CI が使用するのと同じコマンドを実行してください (package.json スクリプトを確認してください。多くの場合 vitest run、pnpm test、または npm test)。合格: 終了コードが 0 で、レポートに失敗したテストがゼロと表示されます。
2. 非同期マッチャー — 合格: すべての expect(…).resolves と expect(…).rejects に await プレフィックスがついています (await expect(...))。非同期テストを参照。resolves または rejects が await なしで現れている行はこのゲートを失敗します。

追加ドキュメント

• モッキング: references/mocking.md を参照してモジュールモッキング、スパイ、クリーンアップについて確認してください
• 設定: references/config.md を参照して vitest.config、セットアップファイル、カバレッジについて確認してください
• パターン: references/patterns.md を参照してタイマー、スナップショット、アンチパターンについて確認してください

テストメソッドのクイックリファレンス