Vitest ベストプラクティス

Vitest テスティングフレームワークのための包括的なパフォーマンス最適化とベストプラクティスガイド。テスト作成、リファクタリング、コードレビューを導くために優先順位付けされた 8 つのカテゴリにわたる 44 のルールを含みます。

適用時期

以下の場合、これらのガイドラインを参照してください:

• 新しい Vitest テストを書く場合
• 不安定または遅いテストをデバッグする場合
• テスト設定をセットアップする場合
• PR でテストコードをレビューする場合
• Jest から Vitest に移行する場合
• CI/CD テストパフォーマンスを最適化する場合

ルールカテゴリ(優先度順)

優先度	カテゴリ	影響度	プレフィックス
1	非同期パターン	CRITICAL	async-
2	テストセットアップと分離	CRITICAL	setup-
3	モッキングパターン	HIGH	mock-
4	パフォーマンス	HIGH	perf-
5	スナップショットテスト	MEDIUM	snap-
6	環境	MEDIUM	env-
7	アサーション	LOW-MEDIUM	assert-
8	テスト構成	LOW	org-

クイックリファレンス

1. 非同期パターン (CRITICAL)

• async-await-assertions - 非同期アサーションを await して偽陽性を防ぐ
• async-return-promises - テスト関数から Promise を return する
• async-fake-timers - 時間依存コードに fake タイマーを使う
• async-waitfor-polling - 非同期条件に vi.waitFor を使う
• async-concurrent-expect - 並行テストでテストコンテキスト expect を使う
• async-act-wrapper - ユーザーイベントを await して act 警告を回避する
• async-error-handling - 非同期エラーハンドリングを適切にテストする

2. テストセットアップと分離 (CRITICAL)

• setup-beforeeach-cleanup - afterEach フックで状態をクリーンアップする
• setup-restore-mocks - 各テスト後にモックを restore する
• setup-avoid-shared-state - テスト間の共有可変状態を避ける
• setup-beforeall-expensive - 高コストな一度きりのセットアップに beforeAll を使う
• setup-reset-modules - モジュール状態をテストする場合はモジュールをリセットする
• setup-test-factories - 複雑なテストデータにテストファクトリを使う

3. モッキングパターン (HIGH)

• mock-vi-mock-hoisting - vi.mock ホイスティング動作を理解する
• mock-spyon-vs-mock - vi.spyOn vs vi.mock を適切に使い分ける
• mock-implementation-not-value - 動的モックに mockImplementation を使う
• mock-msw-network - ネットワークリクエストモッキングに MSW を使う
• mock-avoid-overmocking - 過度なモッキングを避ける
• mock-type-safety - モックで型安全性を保つ
• mock-clear-between-tests - テスト間でモック状態をクリアする

4. パフォーマンス (HIGH)

• perf-pool-selection - パフォーマンスに適したプールを選ぶ
• perf-disable-isolation - 安全な場合はテスト分離を無効にする
• perf-happy-dom - 可能なら jsdom より happy-dom を使う
• perf-sharding - CI 並列化にシャーディングを使う
• perf-run-mode-ci - CI 環境でランモードを使う
• perf-bail-fast-fail - CI での高速失敗に bail を使う

5. スナップショットテスト (MEDIUM)

• snap-inline-over-file - 小さい値にはファイルスナップショットより inline スナップショットを推奨
• snap-avoid-large - 大きなスナップショットを避ける
• snap-stable-serialization - 安定したスナップショットシリアライゼーションを確保する
• snap-review-updates - コミット前にスナップショット更新をレビューする
• snap-describe-intent - スナップショットテストを説明的に命名する

6. 環境 (MEDIUM)

• env-per-file-override - 必要に応じてファイル単位で環境をオーバーライドする
• env-setup-files - グローバル設定にセットアップファイルを使う
• env-globals-config - グローバルを一貫して設定する
• env-browser-api-mocking - テスト環境で利用できないブラウザ API をモックする

7. アサーション (LOW-MEDIUM)

• assert-specific-matchers - 汎用マッチャーより特定のマッチャーを使う
• assert-edge-cases - エッジケースと境界をテストする
• assert-one-assertion-concept - テストごとに 1 つのコンセプトをテストする
• assert-expect-assertions - 非同期テストに expect.assertions を使う
• assert-toequal-vs-tobe - toBe vs toEqual を正しく使い分ける

8. テスト構成 (LOW)

• org-file-colocation - テストファイルをソースファイルと同じ場所に置く
• org-describe-nesting - describe ブロックで論理的なグループ化を使う
• org-test-naming - テストを説明的に命名する
• org-test-skip-only - skip と only を適切に使う

使い方

詳細な説明とコード例については、個別のリファレンスファイルを読んでください:

• セクション定義 - カテゴリ構造と影響度レベル
• ルールテンプレート - 新しいルール追加用テンプレート
• async-await-assertions - ルールファイル例
• mock-vi-mock-hoisting - ルールファイル例

関連スキル

• TDD 方法論については、test-tdd スキルを参照してください
• MSW での API モッキングについては、test-msw スキルを参照してください
• TypeScript テストパターンについては、typescript スキルを参照してください

完全なコンパイル済みドキュメント

すべてのルールが展開された完全なガイド: AGENTS.md