explorbot-plan

Explorbot テスト計画の作成

機能の説明、要件、ドキュメント、および開始 URL をもとに、Explorbot の正確な Markdown 形式で テスト計画 を手動で作成します。ブラウザーや実際の探索は必要ありません。

計画の作成に Explorbot をインストールする必要はありません — Markdown ファイルを用意するだけです。 インストールが必要なのは、後で計画を 実行 するときだけです（「出力」を参照）。

収集する入力情報

• 機能、要件、ユーザーストーリー（ドキュメントまたは説明を依頼してください）。
• スイートのタイトル（テスト対象の機能）。
• 開始 URL：アプリのホストからの相対パス（例：/login）、または完全な絶対 URL。 これは必須です。相対パスはプロジェクト設定の web.url、またはグローバルモードでコマンドが指定するサイト（EXPLORBOT_URL / 登録済みホスト）を基準に解決されます。
• 各シナリオの優先度：critical、important、high、normal、low。

形式

# User Authentication

### Prerequisite

* URL: /login


# User signs in with valid credentials

## Steps
* Enter a registered email in the email field
* Enter the matching password
* Submit the sign-in form

## Expected
* The user lands on the authenticated dashboard
* The signed-in account is shown in the header


# Sign-in is rejected for an unknown account

## Steps
* Enter an unregistered email and any password
* Submit the sign-in form

## Expected
* An invalid-credentials error is shown
* The user stays on the sign-in page

ルール

• の次の行は `# Suite Title` です。通常、1 ファイルにつき 1 スイートです。 を繰り返すことで、スイートを追加できます。
• ### Prerequisite — 最初のリスト項目は * URL: <path> にしてください。これは、読者と TUI のためにスイート全体の開始ページを記録します。相対パスは web.url / playwright.url を基準に解決されます。絶対 URL も使用できます。
• 各テストは `` ブロックの後に # Scenario（h1）を置きます。 優先度が指定されていない場合は、normal が適用されます。
• Prerequisite の URL は、スイート内のすべてのテストの開始ページです。別のページから開始するシナリオは、独自の Prerequisite URL を持つ別のスイートにします。
• ## Steps と ## Expected では * の箇条書きを使います。長い箇条書きは、続きの行を 2 つのスペースでインデントして折り返します。
• Steps は ガイダンス です — テスターが適宜調整できるようにします。各ステップは独立した作業とし、壊れやすいセレクターは使わないでください。## Expected の各項目は、手順を言い換えるのではなく、個別に検証可能（実際の副作用を伴うデータ、状態、または UI の変更）でなければなりません。
• シナリオのタイトルはクリック手順ではなく、ビジネス上の成果を表します。

検証

計画を渡す前に、テストケースと URL: /path または URL: https://… の Prerequisite が含まれていることを確認してください。終了コード 0 なら合格です。それ以外の場合は、計画を修正して再実行してください。

npx -y mdq-cli@latest 'comment(/^test/) && section("Prerequisite") item(/^URL: (\/|https?:\/\/)\S*$/)' <plan-file>

出力

手動で作成した計画は入力としてのみ扱われます — Explorbot が書き換えることはありません。そのため、対象のコードの隣にあるリポジトリ内（tests/plans/<feature>.md など）に保存し、そのパスを explorbot test に渡してください。生成された計画と一緒に保存したい場合に限り、実行時の output/plans/ に保存します。プロジェクト設定では output/plans/、グローバルモードでは ~/.explorbot/sites/<host>/output/plans/ を使用します。

実行します（インデックス：すべての場合は 1、1,3、1-5、または *）：

npx explorbot test checkout-plan.md '*'
EXPLORBOT_URL=https://app.example.com npx explorbot test checkout-plan.md '*'

test は URL 引数を取りません。プロジェクト設定の web.url を使用し、グローバルモードでは EXPLORBOT_URL が必要です。セッションが完了すると終了コード 0 を返します — 終了コードではなく、output/reports/ のレポートを確認してください。[[explorbot-fundamentals]] を参照してください。