From 6cc70f8aa1d1a234e04dc07ffb19a431a91e9255 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 17 Apr 2026 20:49:53 +0000 Subject: [PATCH] Add CLI-only options documentation for --reporters flag Document the new --reporters / -r CLI argument for selecting output reporters (terminal, json, html). Includes HTML reporter features and output path behavior. --- .../references/config-guidance.md | 51 +++++++++++++++++++ .../references/config-guidance.md | 51 +++++++++++++++++++ .../references/config-guidance.md | 51 +++++++++++++++++++ 3 files changed, 153 insertions(+) diff --git a/plugins/doc-detective/skills/doc-detective-project-bootstrap/references/config-guidance.md b/plugins/doc-detective/skills/doc-detective-project-bootstrap/references/config-guidance.md index b554c1d..5f045eb 100644 --- a/plugins/doc-detective/skills/doc-detective-project-bootstrap/references/config-guidance.md +++ b/plugins/doc-detective/skills/doc-detective-project-bootstrap/references/config-guidance.md @@ -68,6 +68,57 @@ interface Config { } ``` +## CLI-Only Options + +Some options are only available via CLI arguments and cannot be set in the config file. + +### `--reporters` / `-r` + +Select which output reporters to use. Accepts multiple values. + +**Available reporters:** + +| Reporter | Description | +|----------|-------------| +| `terminal` | Outputs results to the console with colored status indicators | +| `json` | Writes results to a JSON file (default: `testResults-.json`) | +| `html` | Generates a self-contained HTML report with interactive features | + +**Default:** `terminal json` (both terminal output and JSON file) + +**Usage:** + +```bash +# Default: terminal output + JSON file +doc-detective runTests + +# Add HTML report to default output +doc-detective runTests --reporters terminal json html + +# HTML report only +doc-detective runTests -r html + +# JSON file only (no terminal output) +doc-detective runTests -r json +``` + +**HTML reporter features:** + +- Self-contained single file with inlined CSS and JavaScript +- Works offline (no CDN dependencies except Google Fonts fallback) +- Dark mode toggle +- Search and filter by status (pass/fail/warning/skipped) +- Collapsible spec/test/context/step hierarchy +- Media thumbnails with lightbox for screenshots and recordings +- JSON download button to export raw results +- Print-friendly layout + +**Output path behavior:** + +- If `output` ends in `.html` or `.htm`, writes to that exact file +- Otherwise, generates `testResults-.html` in the output directory +- Automatically handles filename collisions with numeric suffix + ## Config By Project Type ### Static Site Generator (Docusaurus, VitePress, etc.) diff --git a/skills/doc-detective-project-bootstrap/references/config-guidance.md b/skills/doc-detective-project-bootstrap/references/config-guidance.md index b554c1d..5f045eb 100644 --- a/skills/doc-detective-project-bootstrap/references/config-guidance.md +++ b/skills/doc-detective-project-bootstrap/references/config-guidance.md @@ -68,6 +68,57 @@ interface Config { } ``` +## CLI-Only Options + +Some options are only available via CLI arguments and cannot be set in the config file. + +### `--reporters` / `-r` + +Select which output reporters to use. Accepts multiple values. + +**Available reporters:** + +| Reporter | Description | +|----------|-------------| +| `terminal` | Outputs results to the console with colored status indicators | +| `json` | Writes results to a JSON file (default: `testResults-.json`) | +| `html` | Generates a self-contained HTML report with interactive features | + +**Default:** `terminal json` (both terminal output and JSON file) + +**Usage:** + +```bash +# Default: terminal output + JSON file +doc-detective runTests + +# Add HTML report to default output +doc-detective runTests --reporters terminal json html + +# HTML report only +doc-detective runTests -r html + +# JSON file only (no terminal output) +doc-detective runTests -r json +``` + +**HTML reporter features:** + +- Self-contained single file with inlined CSS and JavaScript +- Works offline (no CDN dependencies except Google Fonts fallback) +- Dark mode toggle +- Search and filter by status (pass/fail/warning/skipped) +- Collapsible spec/test/context/step hierarchy +- Media thumbnails with lightbox for screenshots and recordings +- JSON download button to export raw results +- Print-friendly layout + +**Output path behavior:** + +- If `output` ends in `.html` or `.htm`, writes to that exact file +- Otherwise, generates `testResults-.html` in the output directory +- Automatically handles filename collisions with numeric suffix + ## Config By Project Type ### Static Site Generator (Docusaurus, VitePress, etc.) diff --git a/src/skills/doc-detective-project-bootstrap/references/config-guidance.md b/src/skills/doc-detective-project-bootstrap/references/config-guidance.md index b554c1d..5f045eb 100644 --- a/src/skills/doc-detective-project-bootstrap/references/config-guidance.md +++ b/src/skills/doc-detective-project-bootstrap/references/config-guidance.md @@ -68,6 +68,57 @@ interface Config { } ``` +## CLI-Only Options + +Some options are only available via CLI arguments and cannot be set in the config file. + +### `--reporters` / `-r` + +Select which output reporters to use. Accepts multiple values. + +**Available reporters:** + +| Reporter | Description | +|----------|-------------| +| `terminal` | Outputs results to the console with colored status indicators | +| `json` | Writes results to a JSON file (default: `testResults-.json`) | +| `html` | Generates a self-contained HTML report with interactive features | + +**Default:** `terminal json` (both terminal output and JSON file) + +**Usage:** + +```bash +# Default: terminal output + JSON file +doc-detective runTests + +# Add HTML report to default output +doc-detective runTests --reporters terminal json html + +# HTML report only +doc-detective runTests -r html + +# JSON file only (no terminal output) +doc-detective runTests -r json +``` + +**HTML reporter features:** + +- Self-contained single file with inlined CSS and JavaScript +- Works offline (no CDN dependencies except Google Fonts fallback) +- Dark mode toggle +- Search and filter by status (pass/fail/warning/skipped) +- Collapsible spec/test/context/step hierarchy +- Media thumbnails with lightbox for screenshots and recordings +- JSON download button to export raw results +- Print-friendly layout + +**Output path behavior:** + +- If `output` ends in `.html` or `.htm`, writes to that exact file +- Otherwise, generates `testResults-.html` in the output directory +- Automatically handles filename collisions with numeric suffix + ## Config By Project Type ### Static Site Generator (Docusaurus, VitePress, etc.)