Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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-<timestamp>.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-<timestamp>.html` in the output directory
- Automatically handles filename collisions with numeric suffix

## Config By Project Type

### Static Site Generator (Docusaurus, VitePress, etc.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-<timestamp>.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-<timestamp>.html` in the output directory
- Automatically handles filename collisions with numeric suffix

## Config By Project Type

### Static Site Generator (Docusaurus, VitePress, etc.)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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-<timestamp>.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-<timestamp>.html` in the output directory
- Automatically handles filename collisions with numeric suffix

## Config By Project Type

### Static Site Generator (Docusaurus, VitePress, etc.)
Expand Down
Loading