@reportforge/playwright-pdf 0.6.2 → 0.7.0

package/CHANGELOG.md

@@ -3,6 +3,21 @@
 All notable changes to this project will be documented in this file.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [0.6.3] — 2026-06-27
+
+### Fixed
+
+- **Demo command now resolves under `npx`** — the documented `npx @reportforge/playwright-pdf reportforge-demo` could never run: with two package bins and neither matching the package's unscoped name (`playwright-pdf`), npx aborted with `could not determine executable to run`. The package now ships a single dispatcher bin named `playwright-pdf`, so `npx @reportforge/playwright-pdf <command>` resolves correctly.
+
+### Changed
+
+- **CLI is now subcommand-based.** The `reportforge-demo` and `reportforge-export-feedback` bins are consolidated into one `playwright-pdf` bin with subcommands:
+  - `npx @reportforge/playwright-pdf demo [--template=minimal|detailed|executive] [--output=<path>]`
+  - `npx @reportforge/playwright-pdf export-feedback`
+  - This is breaking **only** if you relied on the old `reportforge-demo` / `reportforge-export-feedback` names on your `PATH` after a global install; the `npx` invocations gain capability and lose none.
+
+---
+
 ## [0.6.2] — 2026-06-23
 
 ### Fixed

package/README.md

@@ -46,18 +46,18 @@ Three templates, one reporter. Every PDF is fully offline — fonts, charts, and
 ## Features
 
 - **3 templates** — `minimal` (developer), `detailed` (QA team), `executive` (stakeholders)
-- **Detailed reports** — KPI dashboard, suite breakdown, failure deep-dive with screenshots, CI/CD environment
+- **Detailed reports** — KPI dashboard, suite breakdown with inline failure detail (error, screenshot, root-cause chip) under each failed test, CI/CD environment
 - **Embedded Chart.js** — pass-rate doughnut + per-suite bar chart, bundled inline (no CDN)
 - **Self-contained PDFs** — screenshots, fonts, logos all embedded; share or archive with confidence
 - **Custom branding** — logo, primary/accent colours, watermark, PDF password encryption
 - **Dynamic filenames** — `{date}`, `{branch}`, `{status}` tokens in the output path
-- **Instant demo report** — `npx @reportforge/playwright-pdf reportforge-demo` generates a realistic sample PDF before subscribing — no license key required
+- **Instant demo report** — `npx @reportforge/playwright-pdf demo` generates a realistic sample PDF before subscribing — no license key required
 - **CI/CD snippets** — GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
 - **Shard merging** — combine N Playwright JSON shard reports into one PDF via `shardResults`; accepts glob patterns or explicit paths
 - **Notifications** — post pass/fail summaries to Slack, Teams, Discord, or email after each run; configurable trigger (`always` / `failure` / `success`) per channel; email supports optional PDF attachment via `attachPdf`
 - **Flakiness trend** — top-N flakiest tests table with per-test dot sparkline across stored history runs in the `detailed` template; `flakinessTopN` option (default 5, `0` disables)
-- **Offline failure analysis** — sorts failures into 7 root-cause buckets and clusters them, right inside the `detailed` PDF (one-liner in `executive`). No network, no AI service — a small embedded classifier that updates itself safely over your existing license refresh; pin it any time. Full details at [reportforge.org/docs/advanced/failure-analysis](https://reportforge.org/docs/advanced/failure-analysis).
-- `reportforge-export-feedback` — exports locally-collected unrecognized failures (tokenized, local-only) for optional manual sharing.
+- **Offline failure analysis** — sorts each failure into one of 7 root-cause buckets and renders a per-test root-cause chip inline under the failed test in the `detailed` PDF (dominant-cause one-liner in `executive`). No network, no AI service — a small embedded classifier that updates itself safely over your existing license refresh; pin it any time. Full details at [reportforge.org/docs/advanced/failure-analysis](https://reportforge.org/docs/advanced/failure-analysis).
+- `npx @reportforge/playwright-pdf export-feedback` — exports locally-collected unrecognized failures (tokenized, local-only) for optional manual sharing.
 - **Configurable sections** — add or remove any report section per template via `sections`.
 - **Hybrid licensing** — one short key unlocks it; reports keep rendering offline via a cached JWT between refreshes
 
@@ -92,7 +92,7 @@ npx playwright test
 # → reports/2026-05-01-main-failed.pdf
 ```
 
-> **See it first.** Run `npx @reportforge/playwright-pdf reportforge-demo` to generate a realistic sample PDF in under 60 seconds — no license key required. Supports `--template=minimal|detailed|executive` and `--output=<path>`.
+> **See it first.** Run `npx @reportforge/playwright-pdf demo` to generate a realistic sample PDF in under 60 seconds — no license key required. Supports `--template=minimal|detailed|executive` and `--output=<path>`.
 
 > **License required.** Start a **[7-day free trial at reportforge.org/pricing](https://reportforge.org/pricing)** — card required, no charge until day 8. Paste the resulting `RFSU-…` key into `RF_LICENSE_KEY`. Without a valid license the reporter logs a warning and skips PDF generation; your Playwright tests still run normally.
 
@@ -198,6 +198,7 @@ All options are the second element of the reporter tuple.
 | `historySize` | `number` | `10` | Maximum number of test runs to keep in the history file (integer ≥ 2). Older runs are pruned on append. |
 | `showTrend` | `boolean` | `true` | Show the pass-rate sparkline and delta badge in the `detailed` template. Set to `false` to disable history tracking entirely. |
 | `flakinessTopN` | `number` | `5` | Maximum flaky tests to show in the flakiness table (`detailed` template). Set to `0` to disable the table entirely. |
+| `slowTestThreshold` | `number` | `10` | Minimum timed-test count before `SLOW` badges appear in the suite breakdown. The badge marks the 10 slowest tests; below this many it stays hidden (every test would be trivially "slowest"). Set to `0` to always badge the slowest. |
 | `templatePath` | `string \| string[]` | — | Path to a custom Handlebars (`.hbs`) template file. Takes precedence over `template`. Pass an array to generate one PDF per custom template. See the Custom Templates docs. |
 | `sections` | `object` | per-template | Override which report sections appear, on top of the chosen template's defaults. Flat keys are the baseline for every chosen template; per-template keys (`minimal`\|`detailed`\|`executive`) override per template. Block toggles: `coverPage`, `analysisOneliner`, `releaseGate`, `summary`, `charts`, `trend`, `requirementsMatrix`, `ciEnvironment`, `suiteBreakdown`, `failureDeepDive`, `failureAnalysis`, `slowTests`, `defectLog`. Display modifiers: `passRate`, `fullEnvironment`, `retries`, `fullFailures`, `stackTraces`. See the Report Sections docs. |
 <!-- AUTOGEN:options-table END -->
@@ -391,10 +392,10 @@ reporter: [['@reportforge/playwright-pdf', {
 | `trend` | Pass-rate trend line, run-history table, and flakiness table (rendered inside `charts`) |
 | `requirementsMatrix` | Tests grouped by `@tag('REQ-…')` with coverage bars (requirements traceability) |
 | `ciEnvironment` | Branch, commit, browsers, CI provider, OS, Node, Playwright, projects, workers |
-| `suiteBreakdown` | Per-suite → per-test table (status, duration, tags, retries) |
-| `failureDeepDive` | Failure cards: error message, stack trace, screenshot, retry history |
-| `failureAnalysis` | Clustered root-cause buckets from the offline classifier |
-| `slowTests` | Slowest tests, duration-ranked |
+| `suiteBreakdown` | Per-suite → per-test table (status, duration, tags, retries). Failed tests carry their failure detail, root-cause chip, and a `SLOW` badge inline (the three keys below) |
+| `failureDeepDive` | Inline failure detail under each failed test in the breakdown: error message, stack trace, screenshot, retry history |
+| `failureAnalysis` | Inline per-test root-cause chip under each failed test (category + representative error + match strength, from the offline classifier) |
+| `slowTests` | `SLOW` badge on the duration-ranked slowest tests, shown inline in the breakdown |
 | `defectLog` | `DEF-####` numbered failure table (severity, retries) |
 
 #### Display modifiers — tune a section that's on
@@ -404,8 +405,8 @@ reporter: [['@reportforge/playwright-pdf', {
 | `passRate` | Show the pass-rate % on the Passed KPI card (`summary`) |
 | `fullEnvironment` | Full environment table instead of the compact grid (`ciEnvironment`) |
 | `retries` | Retries column in the suite breakdown (`suiteBreakdown`) |
-| `fullFailures` | Full failure cards instead of one-line summaries (`failureDeepDive`) |
-| `stackTraces` | Include `<pre>` stack traces in the failure cards (`failureDeepDive`) |
+| `fullFailures` | Include the screenshot in the inline failure detail (compact templates omit it) (`failureDeepDive`) |
+| `stackTraces` | Include `<pre>` stack traces in the inline failure detail (`failureDeepDive`) |
 
 #### Per-template defaults
 
@@ -421,7 +422,7 @@ Omit `sections` entirely and each template renders exactly this (✓ = on):
 | `trend` | – | ✓ | ✓ |
 | `requirementsMatrix` | – | ✓ | – |
 | `ciEnvironment` | ✓ | ✓ | ✓ |
-| `suiteBreakdown` | ✓ | ✓ | – |
+| `suiteBreakdown` | ✓ | ✓ | ✓ |
 | `failureDeepDive` | ✓ | ✓ | ✓ |
 | `failureAnalysis` | – | ✓ | – |
 | `slowTests` | – | ✓ | ✓ |
@@ -435,7 +436,8 @@ Omit `sections` entirely and each template renders exactly this (✓ = on):
 #### Dependencies & gotchas
 
 - **`trend` needs `charts`.** The trend line, run-history, and flakiness table live inside the charts block, so `trend: true` does nothing with `charts: false` (it's coerced off). It also needs history data — keep the top-level `showTrend` option on.
-- **Data-gated sections** — `failureAnalysis`, `requirementsMatrix`, `slowTests`, `defectLog` render only when there's matching data (clusters, tagged tests, timed tests, failures). Toggling them on with no data shows nothing.
+- **Inline failure detail needs `suiteBreakdown`.** `failureDeepDive` (failure detail), `failureAnalysis` (root-cause chip), and `slowTests` (`SLOW` badge) now render *inside* the suite breakdown, so they show nothing when `suiteBreakdown` is off. The chip (`failureAnalysis`) also needs `failureDeepDive` — it lives inside the failure detail, so it's coerced off without it.
+- **Data-gated sections** — `failureAnalysis`, `requirementsMatrix`, `slowTests`, `defectLog` render only when there's matching data (classified failures, tagged tests, a meaningful slow set, failures). Toggling them on with no data shows nothing.
 - **Render-layer only.** `sections` controls what's drawn, never what's collected — the data switches stay separate: `showTrend` (history), `flakinessTopN` (flaky-table size), `failureAnalysis.enabled` (classifier), `includeScreenshots` (images).
 - **Custom templates.** `sections` applies to the built-in templates; a custom `templatePath` controls its own layout (every section available) and ignores `sections` — you'll get a warning if both are set.