@reportforge/playwright-pdf 0.6.0 → 0.6.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 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.1] — 2026-06-22
+
+### Documentation
+
+- **Expanded the Report Sections reference** — per-section descriptions for all 13 block toggles, the 5 display modifiers, a per-template defaults matrix, and the dependency rules (`trend` needs `charts`, data-gated sections, render-layer only) in both the README and the docs site.
+- Fixed the README documentation links to point at the real `/docs/<page>` routes instead of non-existent `/docs#<anchor>` anchors.
+
+_No runtime changes — `@reportforge/playwright-pdf@0.6.1` is identical in behaviour to `0.6.0`._
+
+---
+
 ## [0.6.0] — 2026-06-22
 
 ### Added

package/README.md

@@ -109,7 +109,7 @@ npx playwright test
 
 ### Chrome setup
 
-The reporter auto-detects Chrome via `PUPPETEER_EXECUTABLE_PATH`, then system Chrome, then `chrome-finder`. Full per-OS instructions: [reportforge.org/docs#chrome-setup](https://reportforge.org/docs#chrome-setup).
+The reporter auto-detects Chrome via `PUPPETEER_EXECUTABLE_PATH`, then system Chrome, then `chrome-finder`. Full per-OS instructions: [reportforge.org/docs/running-tests#chrome-setup](https://reportforge.org/docs/running-tests#chrome-setup).
 
 **Windows**
 
@@ -202,7 +202,7 @@ All options are the second element of the reporter tuple.
 | `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 -->
 
-Full reference: [reportforge.org/docs#configuration](https://reportforge.org/docs#configuration).
+Full reference: [reportforge.org/docs/configuration](https://reportforge.org/docs/configuration).
 
 ### Shard Merging
 
@@ -364,41 +364,86 @@ One license check, one data-collection pass — faster than multiple reporter in
 
 ### Report Sections
 
-Each template ships a curated set of sections. Override them per run with the
-`sections` option — add a section a template hides, or remove one it shows.
+Each built-in template ships a curated set of sections. The `sections` option lets you **add a section a template hides or remove one it shows — per template** — without writing a custom template.
 
 ```ts
 reporter: [['@reportforge/playwright-pdf', {
   template: ['minimal', 'detailed'],
   sections: {
-    defectLog: false,                 // baseline: drop the defect log everywhere
-    minimal:  { charts: true },       // add charts to the minimal report
+    defectLog: false,                 // flat key: baseline for EVERY chosen template
+    minimal:  { charts: true },       // per-template key: overrides the baseline
     detailed: { ciEnvironment: false },
   },
 }]]
 ```
 
-Flat keys form the baseline for every chosen template; per-template keys
-(`minimal` / `detailed` / `executive`) override the baseline for that template.
+**Resolution order** (lowest → highest): the template's defaults → flat keys (baseline for all chosen templates) → per-template keys (`minimal` / `detailed` / `executive`). An unknown key throws a configuration error (typo-safe).
 
-**Block toggles:** `coverPage`, `analysisOneliner`, `releaseGate`, `summary`,
-`charts`, `trend`, `requirementsMatrix`, `ciEnvironment`, `suiteBreakdown`,
-`failureDeepDive`, `failureAnalysis`, `slowTests`, `defectLog`.
+#### Block toggles — which sections appear
 
-**Display modifiers:** `passRate` (summary), `fullEnvironment` (full env table vs
-compact), `retries` (suite retries column), `fullFailures` + `stackTraces`
-(failure detail depth).
-
-`trend` renders only when `charts` is also on **and** history data exists (`showTrend` enabled). Data-gated sections
-(`failureAnalysis`, `requirementsMatrix`, `slowTests`, `defectLog`) appear only
-when matching data exists — `sections` controls rendering, never data collection.
-An unknown key throws a config error (typo-safe).
+| Key | Renders |
+|---|---|
+| `coverPage` | Full-page cover: title, verdict badge, KPI stats strip, branch + commit |
+| `analysisOneliner` | One-line failure-analysis summary banner |
+| `releaseGate` | Ship/hold recommendation banner (APPROVED TO SHIP / HOLD) |
+| `summary` | KPI strip (total · passed · failed · timed-out · skipped · flaky), verdict, duration, pass rate, flaky callout |
+| `charts` | Pass-rate doughnut + stacked suite-results bar |
+| `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 |
+| `defectLog` | `DEF-####` numbered failure table (severity, retries) |
+
+#### Display modifiers — tune a section that's on
+
+| Key | Effect |
+|---|---|
+| `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`) |
+
+#### Per-template defaults
+
+Omit `sections` entirely and each template renders exactly this (✓ = on):
+
+| Section | minimal | detailed | executive |
+|---|:-:|:-:|:-:|
+| `coverPage` | – | – | ✓ |
+| `analysisOneliner` | – | – | ✓ |
+| `releaseGate` | ✓ | ✓ | ✓ |
+| `summary` | ✓ | ✓ | ✓ |
+| `charts` | – | ✓ | ✓ |
+| `trend` | – | ✓ | ✓ |
+| `requirementsMatrix` | – | ✓ | – |
+| `ciEnvironment` | ✓ | ✓ | ✓ |
+| `suiteBreakdown` | ✓ | ✓ | – |
+| `failureDeepDive` | ✓ | ✓ | ✓ |
+| `failureAnalysis` | – | ✓ | – |
+| `slowTests` | – | ✓ | ✓ |
+| `defectLog` | – | ✓ | – |
+| `passRate` | ✓ | ✓ | ✓ |
+| `fullEnvironment` | – | ✓ | – |
+| `retries` | ✓ | ✓ | – |
+| `fullFailures` | ✓ | ✓ | – |
+| `stackTraces` | ✓ | ✓ | – |
+
+#### 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.
+- **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.
 
 ---
 
 ## CI/CD Integration
 
-Full workflows for all four CI providers: [reportforge.org/docs#ci-cd](https://reportforge.org/docs#ci-cd).
+Full workflows for all four CI providers: [reportforge.org/docs/ci-cd](https://reportforge.org/docs/ci-cd).
 
 ### GitHub Actions
 
@@ -534,7 +579,7 @@ export RF_LICENSE_KEY=RFSU-XXXX-XXXX-XXXX-XXXX
 npx playwright test
 ```
 
-Full lifecycle + offline failure modes: [reportforge.org/docs#license](https://reportforge.org/docs#license).
+Full lifecycle + offline failure modes: [reportforge.org/docs/licensing](https://reportforge.org/docs/licensing).
 
 ---
 
@@ -566,7 +611,7 @@ Common issues:
 - **`pdfPassword` ignored** → requires `qpdf` on `PATH` (`apt install qpdf` / `brew install qpdf` / `choco install qpdf`).
 - **No PDF generated** → verify `RF_LICENSE_KEY` is set and your subscription is active. `RF_DEBUG=1` will show the activation result; missing key, expired subscription, network failure, or no JWT cache all skip PDF generation.
 
-Full guide: [reportforge.org/docs#troubleshooting](https://reportforge.org/docs#troubleshooting).
+Full guide: [reportforge.org/docs/troubleshooting](https://reportforge.org/docs/troubleshooting).
 
 ---
 
@@ -574,15 +619,15 @@ Full guide: [reportforge.org/docs#troubleshooting](https://reportforge.org/docs#
 
 Full documentation at [reportforge.org/docs](https://reportforge.org/docs):
 
-- [Quick start](https://reportforge.org/docs#install) — install, configure, activate
-- [Chrome setup](https://reportforge.org/docs#chrome-setup) — Windows, Linux, macOS
-- [CI/CD integration](https://reportforge.org/docs#ci-cd) — GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
-- [Configuration reference](https://reportforge.org/docs#configuration) — all options
-- [Filename tokens](https://reportforge.org/docs#tokens) — `{date}`, `{branch}`, `{status}`
-- [Templates](https://reportforge.org/docs#templates) — minimal, detailed, executive
-- [Report Sections](https://reportforge.org/docs#report-sections) — add or remove sections per template
-- [License & offline behaviour](https://reportforge.org/docs#license) — JWT cache, machine cap, cancellation
-- [Troubleshooting](https://reportforge.org/docs#troubleshooting) — common issues and debug flags
+- [Quick start](https://reportforge.org/docs/quickstart) — install, configure, activate
+- [Chrome setup](https://reportforge.org/docs/running-tests#chrome-setup) — Windows, Linux, macOS
+- [CI/CD integration](https://reportforge.org/docs/ci-cd) — GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins, Azure DevOps
+- [Configuration reference](https://reportforge.org/docs/configuration) — all options
+- [Filename tokens](https://reportforge.org/docs/configuration#tokens) — `{date}`, `{branch}`, `{status}`
+- [Templates](https://reportforge.org/docs/templates) — minimal, detailed, executive
+- [Report Sections](https://reportforge.org/docs/configuration#report-sections) — add or remove sections per template
+- [License & offline behaviour](https://reportforge.org/docs/licensing) — JWT cache, machine cap, cancellation
+- [Troubleshooting](https://reportforge.org/docs/troubleshooting) — common issues and debug flags
 - **Changelog** — [CHANGELOG.md](./CHANGELOG.md)
 
 ---

package/dist/index.js

@@ -13231,7 +13231,7 @@ var PdfReporter = class {
     this.dataCollector = new DataCollector();
     this.pdfGenerator = new PdfGenerator();
     this.options = parseOptions(rawOptions);
-    const version = true ? "0.6.0" : "0.x";
+    const version = true ? "0.6.1" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,

package/dist/index.mjs

@@ -13232,7 +13232,7 @@ var PdfReporter = class {
     this.dataCollector = new DataCollector();
     this.pdfGenerator = new PdfGenerator();
     this.options = parseOptions(rawOptions);
-    const version = true ? "0.6.0" : "0.x";
+    const version = true ? "0.6.1" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportforge/playwright-pdf",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Enterprise-ready PDF reports for Playwright Test — minimal, detailed, and executive templates with CI/CD integrations",
   "license": "MIT",
   "author": "ReportForge",