@reportforge/playwright-pdf 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 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.0] — 2026-06-22
+
+### Added
+
+- **Configurable report sections** — a new `sections` option adds or removes any section in any built-in template (`minimal` / `detailed` / `executive`) straight from `playwright.config`. Flat keys set a baseline for every chosen template; per-template keys override per template. Covers every block (cover page, charts, trend, requirements traceability, CI/environment, suite breakdown, failures, failure analysis, slow tests, defect log, release gate) plus display modifiers (pass-rate, full environment table, retries, failure and stack-trace depth). Unknown keys are rejected with a clear configuration error. Reports render identically to before when the option is omitted.
+
+### Changed
+
+- Shared section styles (cover page, charts, defect log, coverage bars, environment table, failure analysis, suite breakdown) moved to the base stylesheet, so a section toggled into a template that didn't ship it before now renders fully styled.
+
+---
+
 ## [0.5.1] — 2026-06-19
 
 ### Security

package/README.md

@@ -58,6 +58,7 @@ Three templates, one reporter. Every PDF is fully offline — fonts, charts, and
 - **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.
+- **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
 
 ---
@@ -198,6 +199,7 @@ All options are the second element of the reporter tuple.
 | `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. |
 | `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 -->
 
 Full reference: [reportforge.org/docs#configuration](https://reportforge.org/docs#configuration).
@@ -360,6 +362,38 @@ reporter: [
 
 One license check, one data-collection pass — faster than multiple reporter instances. Duplicate entries are silently deduplicated.
 
+### 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.
+
+```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
+    detailed: { ciEnvironment: false },
+  },
+}]]
+```
+
+Flat keys form the baseline for every chosen template; per-template keys
+(`minimal` / `detailed` / `executive`) override the baseline for that template.
+
+**Block toggles:** `coverPage`, `analysisOneliner`, `releaseGate`, `summary`,
+`charts`, `trend`, `requirementsMatrix`, `ciEnvironment`, `suiteBreakdown`,
+`failureDeepDive`, `failureAnalysis`, `slowTests`, `defectLog`.
+
+**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).
+
 ---
 
 ## CI/CD Integration
@@ -546,6 +580,7 @@ Full documentation at [reportforge.org/docs](https://reportforge.org/docs):
 - [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
 - **Changelog** — [CHANGELOG.md](./CHANGELOG.md)

package/dist/demo/cli.js

@@ -6531,15 +6531,134 @@ function dominantCategory(clusters) {
   return clusters[0]?.category ?? "unknown";
 }
 
+// src/templates/sections.ts
+init_cjs_shims();
+var SECTION_KEYS = [
+  // block toggles
+  "coverPage",
+  "analysisOneliner",
+  "releaseGate",
+  "summary",
+  "charts",
+  "trend",
+  "requirementsMatrix",
+  "ciEnvironment",
+  "suiteBreakdown",
+  "failureDeepDive",
+  "failureAnalysis",
+  "slowTests",
+  "defectLog",
+  // display modifiers
+  "passRate",
+  "fullEnvironment",
+  "retries",
+  "fullFailures",
+  "stackTraces"
+];
+var SECTION_DEFAULTS = {
+  minimal: {
+    coverPage: false,
+    analysisOneliner: false,
+    releaseGate: true,
+    summary: true,
+    charts: false,
+    trend: false,
+    requirementsMatrix: false,
+    ciEnvironment: true,
+    suiteBreakdown: true,
+    failureDeepDive: true,
+    failureAnalysis: false,
+    slowTests: false,
+    defectLog: false,
+    passRate: true,
+    fullEnvironment: false,
+    retries: true,
+    fullFailures: true,
+    stackTraces: true
+  },
+  detailed: {
+    coverPage: false,
+    analysisOneliner: false,
+    releaseGate: true,
+    summary: true,
+    charts: true,
+    trend: true,
+    requirementsMatrix: true,
+    ciEnvironment: true,
+    suiteBreakdown: true,
+    failureDeepDive: true,
+    failureAnalysis: true,
+    slowTests: true,
+    defectLog: true,
+    passRate: true,
+    fullEnvironment: true,
+    retries: true,
+    fullFailures: true,
+    stackTraces: true
+  },
+  executive: {
+    coverPage: true,
+    analysisOneliner: true,
+    releaseGate: true,
+    summary: true,
+    charts: true,
+    trend: true,
+    requirementsMatrix: false,
+    ciEnvironment: true,
+    suiteBreakdown: false,
+    failureDeepDive: true,
+    failureAnalysis: false,
+    slowTests: true,
+    defectLog: false,
+    passRate: true,
+    fullEnvironment: false,
+    retries: false,
+    fullFailures: false,
+    stackTraces: false
+  }
+};
+var SECTION_KEY_SET = new Set(SECTION_KEYS);
+function resolveSections(template, userSections) {
+  const base = SECTION_DEFAULTS[template];
+  if (!userSections) return { ...base };
+  const flat = {};
+  for (const [k, v] of Object.entries(userSections)) {
+    if (v !== void 0 && SECTION_KEY_SET.has(k)) flat[k] = v;
+  }
+  const perTemplateRaw = userSections[template] ?? {};
+  const perTemplate = {};
+  for (const [k, v] of Object.entries(perTemplateRaw)) {
+    if (v !== void 0) perTemplate[k] = v;
+  }
+  const result = { ...base, ...flat, ...perTemplate };
+  if (!result.charts) result.trend = false;
+  return result;
+}
+function allSectionsOn() {
+  return Object.fromEntries(SECTION_KEYS.map((k) => [k, true]));
+}
+
 // src/templates/engine.ts
 function jsonForInlineScript(value) {
   return JSON.stringify(value).replace(/<\//g, "<\\/");
 }
+function deriveOptions(s) {
+  return {
+    showCharts: s.charts,
+    showTrend: s.trend,
+    showStackTraces: s.stackTraces,
+    showFullEnvironment: s.fullEnvironment,
+    showPassRate: s.passRate,
+    showRetries: s.retries,
+    showFullFailures: s.fullFailures
+  };
+}
 var TemplateEngine = class {
   constructor() {
     this.chartjsInline = "";
     this.fontsBundleCss = "";
     this.customTemplateCache = /* @__PURE__ */ new Map();
+    this.styleCache = /* @__PURE__ */ new Map();
     this.handlebars = import_handlebars.default.create();
     this.templatesDir = import_path.default.resolve(__dirname, "templates");
     if (!import_fs.default.existsSync(this.templatesDir)) {
@@ -6559,14 +6678,14 @@ var TemplateEngine = class {
   setChartjsBundle(inline) {
     this.chartjsInline = inline;
   }
-  render(data, template) {
+  render(data, template, userSections) {
     const layoutPath = import_path.default.join(this.templatesDir, "layouts", `${template}.hbs`);
     if (!import_fs.default.existsSync(layoutPath)) {
       throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
     }
     const layoutSource = import_fs.default.readFileSync(layoutPath, "utf8");
     const compiledLayout = this.handlebars.compile(layoutSource);
-    const ctx = this.buildContext(data, template);
+    const ctx = this.buildContext(data, template, userSections);
     return compiledLayout(ctx);
   }
   renderFromPath(data, filePath) {
@@ -6581,17 +6700,11 @@ var TemplateEngine = class {
     return compiledFn(this.buildCustomContext(data));
   }
   buildCustomContext(data) {
+    const sections = allSectionsOn();
     return {
       ...data,
-      options: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: true,
-        showFullEnvironment: true,
-        showPassRate: true,
-        showRetries: true,
-        showFullFailures: true
-      },
+      options: deriveOptions(sections),
+      sections,
       tagGroups: this.buildTagGroups(data),
       slowTests: this.buildSlowTests(data),
       baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
@@ -6599,47 +6712,20 @@ var TemplateEngine = class {
       chartjsScript: this.buildChartjsScript()
     };
   }
-  buildContext(data, template) {
+  buildContext(data, template, userSections) {
     const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
     const templateCSS = this.readStyle(`${template}.css`);
-    const optionsMap = {
-      minimal: {
-        showCharts: false,
-        showTrend: false,
-        showStackTraces: true,
-        showFullEnvironment: false,
-        showPassRate: true,
-        showRetries: true,
-        showFullFailures: true
-      },
-      detailed: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: true,
-        showFullEnvironment: true,
-        showPassRate: true,
-        showRetries: true,
-        showFullFailures: true
-      },
-      executive: {
-        showCharts: true,
-        showTrend: true,
-        showStackTraces: false,
-        showFullEnvironment: false,
-        showPassRate: true,
-        showRetries: false,
-        showFullFailures: false
-      }
-    };
-    const chartjsScript = this.buildChartjsScript();
+    const sections = resolveSections(template, userSections);
+    const options = deriveOptions(sections);
     return {
       ...data,
-      options: optionsMap[template],
+      options,
+      sections,
       tagGroups: this.buildTagGroups(data),
       slowTests: this.buildSlowTests(data),
       baseCSS,
       templateCSS,
-      chartjsScript
+      chartjsScript: this.buildChartjsScript()
     };
   }
   buildChartjsScript() {
@@ -6687,9 +6773,12 @@ var TemplateEngine = class {
     return tests.sort((a, b) => b.durationMs - a.durationMs).slice(0, 10);
   }
   readStyle(filename) {
+    const cached = this.styleCache.get(filename);
+    if (cached !== void 0) return cached;
     const stylePath = import_path.default.join(this.templatesDir, "styles", filename);
-    if (!import_fs.default.existsSync(stylePath)) return "";
-    return import_fs.default.readFileSync(stylePath, "utf8");
+    const css = import_fs.default.existsSync(stylePath) ? import_fs.default.readFileSync(stylePath, "utf8") : "";
+    this.styleCache.set(filename, css);
+    return css;
   }
   registerPartials() {
     const partialsDir = import_path.default.join(this.templatesDir, "partials");
@@ -7274,6 +7363,12 @@ var PdfGenerator = class {
       `Compression: level=${compression.effective} jpeg-q=${compression.quality} max-w=${compression.maxWidth}px inline-failures\u2264${compression.maxInlineFailures}`
     );
     const outputPaths = [];
+    if (options.sections !== void 0) {
+      const hasCustom = sources.some((s) => s.kind !== "builtin");
+      if (hasCustom) {
+        logger.warn('[reportforge] "sections" applies to built-in templates only; it is ignored for custom templatePath templates.');
+      }
+    }
     const { page } = await this.browserManager.launch(options.puppeteerExecutablePath);
     try {
       for (const source of sources) {
@@ -7381,13 +7476,13 @@ var PdfGenerator = class {
     }
     const templateLabel = source.kind === "builtin" ? source.id : source.label;
     logger.info(`Rendering template: ${templateLabel}`);
-    const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id) : this.templateEngine.renderFromPath(renderData, source.absolutePath);
+    const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, options.sections) : this.templateEngine.renderFromPath(renderData, source.absolutePath);
     const tempHtmlPath = await this.htmlWriter.write(html);
     const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
     try {
       logger.info(`Navigating to temp HTML (${Math.round(html.length / 1024)} KB)...`);
       await page.goto(fileUrl, { waitUntil: "domcontentloaded", timeout: 6e4 });
-      const showCharts = source.kind === "builtin" ? source.id !== "minimal" : true;
+      const showCharts = source.kind === "builtin" ? resolveSections(source.id, options.sections).charts : true;
       await this.chartRenderer.waitForCharts(page, showCharts);
       logger.info(`Generating PDF \u2192 ${import_path6.default.relative(process.cwd(), outputPath)}`);
       await page.pdf({
@@ -11516,6 +11611,15 @@ var failureAnalysisConfigSchema = external_exports.object({
   collectUnclassified: external_exports.boolean().default(true),
   autoUpdateModel: external_exports.boolean().default(true)
 }).default({});
+var sectionFlagsShape = Object.fromEntries(
+  SECTION_KEYS.map((k) => [k, external_exports.boolean().optional()])
+);
+var sectionFlagsSchema = external_exports.object(sectionFlagsShape).strict();
+var sectionsSchema = sectionFlagsSchema.extend({
+  minimal: sectionFlagsSchema.optional(),
+  detailed: sectionFlagsSchema.optional(),
+  executive: sectionFlagsSchema.optional()
+}).strict();
 var ReporterOptionsSchema = external_exports.object({
   outputFile: external_exports.string().optional().default(DEFAULT_OPTIONS.outputFile),
   template: external_exports.union([
@@ -11553,7 +11657,8 @@ var ReporterOptionsSchema = external_exports.object({
     ).min(1, "templatePath array must not be empty")
   ]).optional().transform(
     (v) => v === void 0 ? void 0 : Array.isArray(v) ? v : [v]
-  )
+  ),
+  sections: sectionsSchema.optional()
 });
 function parseOptions(raw) {
   const result = ReporterOptionsSchema.safeParse(raw ?? {});

package/dist/index.d.mts

@@ -1,5 +1,21 @@
 import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
 
+/**
+ * Canonical section catalog. 13 block toggles (section present/absent) followed
+ * by 5 display modifiers (tweak a section that is on). Single source of truth —
+ * the Zod schema in src/config/schema.ts builds its flag shape from this array.
+ */
+declare const SECTION_KEYS: readonly ["coverPage", "analysisOneliner", "releaseGate", "summary", "charts", "trend", "requirementsMatrix", "ciEnvironment", "suiteBreakdown", "failureDeepDive", "failureAnalysis", "slowTests", "defectLog", "passRate", "fullEnvironment", "retries", "fullFailures", "stackTraces"];
+type SectionKey = (typeof SECTION_KEYS)[number];
+/** A partial map of section flags — used both as the flat baseline and per-template. */
+type SectionFlags = Partial<Record<SectionKey, boolean>>;
+/** The public `sections` option shape: flat flags + optional per-template overrides. */
+type SectionsOption = SectionFlags & {
+    minimal?: SectionFlags;
+    detailed?: SectionFlags;
+    executive?: SectionFlags;
+};
+
 declare const TEMPLATE_IDS: readonly ["minimal", "detailed", "executive"];
 type TemplateId = (typeof TEMPLATE_IDS)[number];
 /**
@@ -230,6 +246,30 @@ interface ReporterOptions {
      * templatePath: ['./templates/exec.hbs', './templates/eng.hbs']
      */
     templatePath?: string | string[];
+    /**
+     * Per-section override of which report sections appear, on top of the chosen
+     * template's defaults. Both-layered: flat keys are the baseline applied to
+     * every chosen template; per-template keys (`minimal` / `detailed` /
+     * `executive`) override the baseline for that template only.
+     *
+     * Block toggles: `coverPage`, `analysisOneliner`, `releaseGate`, `summary`,
+     * `charts`, `trend`, `requirementsMatrix`, `ciEnvironment`, `suiteBreakdown`,
+     * `failureDeepDive`, `failureAnalysis`, `slowTests`, `defectLog`.
+     * Display modifiers: `passRate`, `fullEnvironment`, `retries`, `fullFailures`,
+     * `stackTraces`.
+     *
+     * `trend` renders only when `charts` is also on and history data exists (`showTrend` enabled). Sections gated on data
+     * (`failureAnalysis`, `requirementsMatrix`, `slowTests`, `defectLog`) appear
+     * only when matching data exists — this option never changes data collection.
+     *
+     * @example
+     * sections: {
+     *   defectLog: false,                 // baseline for all chosen templates
+     *   minimal: { charts: true },        // add charts to the minimal report
+     *   detailed: { ciEnvironment: false },
+     * }
+     */
+    sections?: SectionsOption;
 }
 
 /**

package/dist/index.d.ts

@@ -1,5 +1,21 @@
 import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
 
+/**
+ * Canonical section catalog. 13 block toggles (section present/absent) followed
+ * by 5 display modifiers (tweak a section that is on). Single source of truth —
+ * the Zod schema in src/config/schema.ts builds its flag shape from this array.
+ */
+declare const SECTION_KEYS: readonly ["coverPage", "analysisOneliner", "releaseGate", "summary", "charts", "trend", "requirementsMatrix", "ciEnvironment", "suiteBreakdown", "failureDeepDive", "failureAnalysis", "slowTests", "defectLog", "passRate", "fullEnvironment", "retries", "fullFailures", "stackTraces"];
+type SectionKey = (typeof SECTION_KEYS)[number];
+/** A partial map of section flags — used both as the flat baseline and per-template. */
+type SectionFlags = Partial<Record<SectionKey, boolean>>;
+/** The public `sections` option shape: flat flags + optional per-template overrides. */
+type SectionsOption = SectionFlags & {
+    minimal?: SectionFlags;
+    detailed?: SectionFlags;
+    executive?: SectionFlags;
+};
+
 declare const TEMPLATE_IDS: readonly ["minimal", "detailed", "executive"];
 type TemplateId = (typeof TEMPLATE_IDS)[number];
 /**
@@ -230,6 +246,30 @@ interface ReporterOptions {
      * templatePath: ['./templates/exec.hbs', './templates/eng.hbs']
      */
     templatePath?: string | string[];
+    /**
+     * Per-section override of which report sections appear, on top of the chosen
+     * template's defaults. Both-layered: flat keys are the baseline applied to
+     * every chosen template; per-template keys (`minimal` / `detailed` /
+     * `executive`) override the baseline for that template only.
+     *
+     * Block toggles: `coverPage`, `analysisOneliner`, `releaseGate`, `summary`,
+     * `charts`, `trend`, `requirementsMatrix`, `ciEnvironment`, `suiteBreakdown`,
+     * `failureDeepDive`, `failureAnalysis`, `slowTests`, `defectLog`.
+     * Display modifiers: `passRate`, `fullEnvironment`, `retries`, `fullFailures`,
+     * `stackTraces`.
+     *
+     * `trend` renders only when `charts` is also on and history data exists (`showTrend` enabled). Sections gated on data
+     * (`failureAnalysis`, `requirementsMatrix`, `slowTests`, `defectLog`) appear
+     * only when matching data exists — this option never changes data collection.
+     *
+     * @example
+     * sections: {
+     *   defectLog: false,                 // baseline for all chosen templates
+     *   minimal: { charts: true },        // add charts to the minimal report
+     *   detailed: { ciEnvironment: false },
+     * }
+     */
+    sections?: SectionsOption;
 }
 
 /**