Skip to content

テスト・品質確認ガイド

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

このカテゴリに置くもの

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

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

正本ドキュメント

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

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

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

役割分担

領域このカテゴリで扱うこと詳細・正本
PHPUnitユニットテスト、パフォーマンステストの実行方法PHPUnit 実行ガイド
VitestTS/JS ユニットテスト(コロケート *.test.tsVitest 実行ガイド
PHPStan静的解析の実行方法、エラーの読み方PHPStan 実行ガイド
PHPCSコーディング規約チェックの実行方法PHPCS 実行ガイド
PrettierJS / TS / CSS / JSON / Markdown の整形方法Prettier 実行ガイド
Playwright E2Eローカルブラウザテストの実行方法Playwright E2E 実行ガイド
Playwright E2E コマンドnpm スクリプトだけを探すPlaywright E2E 実行コマンド一覧
Stripe Checkout / Webhook E2E通常 E2E、PHPUnit、Local 専用自動化の線引き有料記事 Stripe Checkout / Webhook 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 実行ガイド
├── paid-article-stripe-e2e-policy.md  # Stripe Checkout / Webhook E2E 方針
├── 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実行ガイド

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

シナリオテスト

手動シナリオは シナリオテスト を参照してください。有料記事決済の通し確認は 有料記事決済 シナリオテスト手順 を正本とします。

次のステップ

学習リソース

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