テスト・品質確認ガイド

docs/testing/ は、テスト、静的解析、コードスタイル、E2E など、品質確認の実行方法と判断基準を置くカテゴリです。

このカテゴリに置くもの

• PHPUnit、PHPStan、PHPCS、Prettier、Playwright などの実行ガイド
• テストデータ、fixture、E2E 方針など、品質確認の補助資料
• ローカルで品質確認を行うための参照先

CI のトリガーやワークフロー運用は CI、実行コマンドの一覧は コマンド一覧 を正本とします。このカテゴリでは各ツールの使い方と、テスト方針の判断材料を扱います。手動シナリオ手順は シナリオテスト に置きます。

正本ドキュメント

目的	正本
品質管理ツール全体	この README
PHPUnit	PHPUnit 実行ガイド
Vitest（フロントエンド）	Vitest 実行ガイド
PHPStan	PHPStan 実行ガイド
PHPCS	PHPCS 実行ガイド
Prettier	Prettier 実行ガイド
Playwright E2E	Playwright E2E 実行ガイド
Playwright E2E 実行コマンド一覧	Playwright E2E 実行コマンド一覧
有料記事 E2E fixture	有料記事 E2E fixture 実行ガイド
PHPCS / PHPStan などの設定詳細	品質設定ドキュメント
実行コマンド一覧	コマンド一覧
CI の運用判断	CI 運用方針

補助資料・履歴資料の扱い

一時的な失敗調査や環境依存の回避策は、恒常的に参照する内容だけをこのカテゴリへ残します。障害調査として再利用する資料は トラブルシューティング へ分けてください。

役割分担

領域	このカテゴリで扱うこと	詳細・正本
PHPUnit	ユニットテスト、パフォーマンステストの実行方法。書かないテスト・書くテストの指針（正本）	PHPUnit 実行ガイド
Vitest	TS/JS ユニットテスト（コロケート *.test.ts）	Vitest 実行ガイド
PHPStan	静的解析の実行方法、エラーの読み方	PHPStan 実行ガイド
PHPCS	コーディング規約チェックの実行方法	PHPCS 実行ガイド
Prettier	JS / TS / CSS / JSON / Markdown の整形方法	Prettier 実行ガイド
Playwright E2E	ローカルブラウザテストの実行方法	Playwright E2E 実行ガイド
Playwright E2E コマンド	npm スクリプトだけを探す	Playwright E2E 実行コマンド一覧

ローカル品質確認の入口

変更内容に応じて必要なコマンドだけを実行します。コマンド名・対象範囲・CI との対応は コマンド一覧 を正本としてください。

目的	入口
PHPStan + Deptrac	コマンド一覧: まとめて実行
PHPCS / PHPCBF	コマンド一覧: PHPCS
PHPUnit	コマンド一覧: PHPUnit
Vitest	コマンド一覧: Vitest
Prettier / ESLint / TS	コマンド一覧
CI の実行タイミング	CI 運用方針

ファイル構成

docs/testing/
├── README.md                          # このファイル（全体の索引）
├── playwright-e2e-commands.md         # Playwright E2E 実行コマンド一覧
├── paid-article-e2e-fixtures.md       # 有料記事 E2E fixture 実行ガイド
├── playwright-e2e-guide.md            # Playwright E2E実行ガイド
├── unit-testing/
│   ├── phpunit-guide.md              # PHPUnit実行ガイド
│   └── vitest-guide.md               # Vitest実行ガイド
├── static-analysis/
│   └── phpstan-guide.md              # PHPStan実行ガイド
└── code-style/
    ├── phpcs-guide.md                # PHPCS実行ガイド
    └── prettier-guide.md             # Prettier実行ガイド

手動シナリオ手順書は シナリオテスト セクションを参照してください。

シナリオテスト

手動シナリオは シナリオテスト を参照してください。有料記事の販売確認は 有料記事 codoc ペイウォール を参照してください。

次のステップ

学習リソース

• PHPUnit公式ドキュメント
• PHPStan公式ドキュメント
• PHPCS公式ドキュメント
• Prettier公式ドキュメント
• Playwright公式ドキュメント

プロジェクトのドキュメント

• ドキュメントトップ
• アーキテクチャ
• コーディング規約