@reportforge/playwright-pdf 0.21.0 → 0.22.1

package/dist/index.js

@@ -10330,7 +10330,10 @@ var DEFAULT_OPTIONS = {
   historySize: 10,
   showTrend: true,
   flakinessTopN: 5,
-  slowTestThreshold: 10
+  slowTestThreshold: 10,
+  // Ticket-ID shape: @ODP-5328, REQ-001, JIRA-123. Tags matching this land in
+  // the Requirements Traceability matrix; the rest fall to the tag summary.
+  requirementTagPattern: "^@?[A-Z][A-Z0-9]*-\\d+$"
 };
 
 // src/templates/sections.ts
@@ -10559,6 +10562,14 @@ var ReporterOptionsSchema = external_exports.object({
   remoteHistory: external_exports.boolean().default(false),
   flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
   slowTestThreshold: external_exports.number().int().min(0, "slowTestThreshold must be 0 or greater").optional().default(DEFAULT_OPTIONS.slowTestThreshold),
+  requirementTagPattern: external_exports.string().refine((v) => {
+    try {
+      new RegExp(v);
+      return true;
+    } catch {
+      return false;
+    }
+  }, "requirementTagPattern must be a valid regular expression").optional().default(DEFAULT_OPTIONS.requirementTagPattern),
   failureAnalysis: failureAnalysisConfigSchema,
   capture: captureConfigSchema,
   live: liveConfigSchema,
@@ -12638,6 +12649,7 @@ var PAGE_CONTENT_HEIGHT_PX = (A4_HEIGHT_MM - 2 * PAGE_MARGIN_Y_MM) * PX_PER_MM;
 function isUnknownValue(v) {
   return !v || v === "unknown";
 }
+var NUMERIC_COLLATOR = new Intl.Collator(void 0, { numeric: true });
 var SLOW_MEDIAN_FACTOR = 2;
 function buildSuiteChartChunks(rows) {
   const chunks = [];
@@ -12687,17 +12699,22 @@ var TemplateEngine = class {
   setChartjsBundle(inline) {
     this.chartjsInline = inline;
   }
-  render(data, template, userSections, slowTestThreshold) {
+  render(data, template, opts = {}) {
     const layoutPath = import_path3.default.join(this.templatesDir, "layouts", `${template}.hbs`);
     if (!import_fs4.default.existsSync(layoutPath)) {
       throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
     }
     const layoutSource = import_fs4.default.readFileSync(layoutPath, "utf8");
     const compiledLayout = this.handlebars.compile(layoutSource);
-    const ctx = this.buildContext(data, template, userSections, slowTestThreshold);
+    const ctx = this.assembleContext(
+      data,
+      resolveSections(template, opts.sections),
+      this.readStyle(`${template}.css`),
+      opts
+    );
     return compiledLayout(ctx);
   }
-  renderFromPath(data, filePath, slowTestThreshold) {
+  renderFromPath(data, filePath, opts = {}) {
     if (!this.customTemplateCache.has(filePath)) {
       if (!import_fs4.default.existsSync(filePath)) {
         throw new Error(`[reportforge] Custom template not found: ${filePath}`);
@@ -12706,46 +12723,27 @@ var TemplateEngine = class {
       this.customTemplateCache.set(filePath, this.handlebars.compile(source));
     }
     const compiledFn = this.customTemplateCache.get(filePath);
-    return compiledFn(this.buildCustomContext(data, slowTestThreshold));
+    return compiledFn(this.assembleContext(data, allSectionsOn(), "", opts));
   }
-  buildCustomContext(data, slowTestThreshold) {
-    const sections = allSectionsOn();
-    const slow = this.buildSlowTests(data);
-    return {
-      ...data,
-      projects: this.enrichProjects(data, slow, sections, slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold),
-      options: deriveOptions(sections),
-      sections,
-      tagGroups: this.buildTagGroups(data),
-      slowTests: slow.ranked,
-      baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
-      templateCSS: "",
-      chartjsScript: this.buildChartjsScript(),
-      watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
-      releaseGateTally: buildFailureTally(data.analysis),
-      suiteChartLarge: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX,
-      suiteChartChunks: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX ? buildSuiteChartChunks(data.charts.suiteResults) : []
-    };
-  }
-  buildContext(data, template, userSections, slowTestThreshold) {
-    const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
-    const templateCSS = this.readStyle(`${template}.css`);
-    const sections = resolveSections(template, userSections);
+  assembleContext(data, sections, templateCSS, opts) {
     const options = deriveOptions(sections);
     const slow = this.buildSlowTests(data);
+    const tags = this.buildTagGroups(data, opts.requirementTagPattern);
     return {
       ...data,
       projects: this.enrichProjects(
         data,
         slow,
         sections,
-        slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
+        opts.slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
       ),
       options,
       sections,
-      tagGroups: this.buildTagGroups(data),
+      tagGroups: tags.all,
+      requirementTagGroups: tags.requirements,
+      categoryTagGroups: tags.categories,
       slowTests: slow.ranked,
-      baseCSS,
+      baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
       templateCSS,
       chartjsScript: this.buildChartjsScript(),
       watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
@@ -12757,7 +12755,7 @@ var TemplateEngine = class {
   buildChartjsScript() {
     return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
   }
-  buildTagGroups(data) {
+  buildTagGroups(data, requirementTagPattern) {
     const tagMap = /* @__PURE__ */ new Map();
     for (const project of data.projects) {
       for (const suite of this.flattenSuites(project.suites)) {
@@ -12772,11 +12770,20 @@ var TemplateEngine = class {
         }
       }
     }
-    return Array.from(tagMap.entries()).map(([tag, counts]) => ({
-      tag,
-      ...counts,
-      coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
-    }));
+    const regex = new RegExp(requirementTagPattern ?? DEFAULT_OPTIONS.requirementTagPattern);
+    const requirements = [];
+    const categories = [];
+    for (const [tag, counts] of tagMap) {
+      const row = {
+        tag,
+        ...counts,
+        coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
+      };
+      (regex.test(tag) ? requirements : categories).push(row);
+    }
+    requirements.sort((a, b) => NUMERIC_COLLATOR.compare(a.tag, b.tag));
+    categories.sort((a, b) => b.total - a.total || a.tag.localeCompare(b.tag));
+    return { all: [...requirements, ...categories], requirements, categories };
   }
   buildSlowTests(data) {
     const tests = [];
@@ -13533,7 +13540,12 @@ 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, options.sections, options.slowTestThreshold) : this.templateEngine.renderFromPath(renderData, source.absolutePath, options.slowTestThreshold);
+    const renderOpts = {
+      sections: options.sections,
+      slowTestThreshold: options.slowTestThreshold,
+      requirementTagPattern: options.requirementTagPattern
+    };
+    const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, renderOpts) : this.templateEngine.renderFromPath(renderData, source.absolutePath, renderOpts);
     const tempHtmlPath = await this.htmlWriter.write(html);
     const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
     try {
@@ -14401,7 +14413,7 @@ var PdfReporter = class {
     this.options = parseOptions(rawOptions);
     setLogLevel(this.options.logLevel);
     this.dataCollector = new DataCollector(this.options.capture);
-    this.version = true ? "0.21.0" : "0.x";
+    this.version = true ? "0.22.1" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${this.version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,

package/dist/index.mjs

@@ -10331,7 +10331,10 @@ var DEFAULT_OPTIONS = {
   historySize: 10,
   showTrend: true,
   flakinessTopN: 5,
-  slowTestThreshold: 10
+  slowTestThreshold: 10,
+  // Ticket-ID shape: @ODP-5328, REQ-001, JIRA-123. Tags matching this land in
+  // the Requirements Traceability matrix; the rest fall to the tag summary.
+  requirementTagPattern: "^@?[A-Z][A-Z0-9]*-\\d+$"
 };
 
 // src/templates/sections.ts
@@ -10560,6 +10563,14 @@ var ReporterOptionsSchema = external_exports.object({
   remoteHistory: external_exports.boolean().default(false),
   flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
   slowTestThreshold: external_exports.number().int().min(0, "slowTestThreshold must be 0 or greater").optional().default(DEFAULT_OPTIONS.slowTestThreshold),
+  requirementTagPattern: external_exports.string().refine((v) => {
+    try {
+      new RegExp(v);
+      return true;
+    } catch {
+      return false;
+    }
+  }, "requirementTagPattern must be a valid regular expression").optional().default(DEFAULT_OPTIONS.requirementTagPattern),
   failureAnalysis: failureAnalysisConfigSchema,
   capture: captureConfigSchema,
   live: liveConfigSchema,
@@ -12639,6 +12650,7 @@ var PAGE_CONTENT_HEIGHT_PX = (A4_HEIGHT_MM - 2 * PAGE_MARGIN_Y_MM) * PX_PER_MM;
 function isUnknownValue(v) {
   return !v || v === "unknown";
 }
+var NUMERIC_COLLATOR = new Intl.Collator(void 0, { numeric: true });
 var SLOW_MEDIAN_FACTOR = 2;
 function buildSuiteChartChunks(rows) {
   const chunks = [];
@@ -12688,17 +12700,22 @@ var TemplateEngine = class {
   setChartjsBundle(inline) {
     this.chartjsInline = inline;
   }
-  render(data, template, userSections, slowTestThreshold) {
+  render(data, template, opts = {}) {
     const layoutPath = path9.join(this.templatesDir, "layouts", `${template}.hbs`);
     if (!fs7.existsSync(layoutPath)) {
       throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
     }
     const layoutSource = fs7.readFileSync(layoutPath, "utf8");
     const compiledLayout = this.handlebars.compile(layoutSource);
-    const ctx = this.buildContext(data, template, userSections, slowTestThreshold);
+    const ctx = this.assembleContext(
+      data,
+      resolveSections(template, opts.sections),
+      this.readStyle(`${template}.css`),
+      opts
+    );
     return compiledLayout(ctx);
   }
-  renderFromPath(data, filePath, slowTestThreshold) {
+  renderFromPath(data, filePath, opts = {}) {
     if (!this.customTemplateCache.has(filePath)) {
       if (!fs7.existsSync(filePath)) {
         throw new Error(`[reportforge] Custom template not found: ${filePath}`);
@@ -12707,46 +12724,27 @@ var TemplateEngine = class {
       this.customTemplateCache.set(filePath, this.handlebars.compile(source));
     }
     const compiledFn = this.customTemplateCache.get(filePath);
-    return compiledFn(this.buildCustomContext(data, slowTestThreshold));
+    return compiledFn(this.assembleContext(data, allSectionsOn(), "", opts));
   }
-  buildCustomContext(data, slowTestThreshold) {
-    const sections = allSectionsOn();
-    const slow = this.buildSlowTests(data);
-    return {
-      ...data,
-      projects: this.enrichProjects(data, slow, sections, slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold),
-      options: deriveOptions(sections),
-      sections,
-      tagGroups: this.buildTagGroups(data),
-      slowTests: slow.ranked,
-      baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
-      templateCSS: "",
-      chartjsScript: this.buildChartjsScript(),
-      watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
-      releaseGateTally: buildFailureTally(data.analysis),
-      suiteChartLarge: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX,
-      suiteChartChunks: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX ? buildSuiteChartChunks(data.charts.suiteResults) : []
-    };
-  }
-  buildContext(data, template, userSections, slowTestThreshold) {
-    const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
-    const templateCSS = this.readStyle(`${template}.css`);
-    const sections = resolveSections(template, userSections);
+  assembleContext(data, sections, templateCSS, opts) {
     const options = deriveOptions(sections);
     const slow = this.buildSlowTests(data);
+    const tags = this.buildTagGroups(data, opts.requirementTagPattern);
     return {
       ...data,
       projects: this.enrichProjects(
         data,
         slow,
         sections,
-        slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
+        opts.slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
       ),
       options,
       sections,
-      tagGroups: this.buildTagGroups(data),
+      tagGroups: tags.all,
+      requirementTagGroups: tags.requirements,
+      categoryTagGroups: tags.categories,
       slowTests: slow.ranked,
-      baseCSS,
+      baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
       templateCSS,
       chartjsScript: this.buildChartjsScript(),
       watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
@@ -12758,7 +12756,7 @@ var TemplateEngine = class {
   buildChartjsScript() {
     return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
   }
-  buildTagGroups(data) {
+  buildTagGroups(data, requirementTagPattern) {
     const tagMap = /* @__PURE__ */ new Map();
     for (const project of data.projects) {
       for (const suite of this.flattenSuites(project.suites)) {
@@ -12773,11 +12771,20 @@ var TemplateEngine = class {
         }
       }
     }
-    return Array.from(tagMap.entries()).map(([tag, counts]) => ({
-      tag,
-      ...counts,
-      coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
-    }));
+    const regex = new RegExp(requirementTagPattern ?? DEFAULT_OPTIONS.requirementTagPattern);
+    const requirements = [];
+    const categories = [];
+    for (const [tag, counts] of tagMap) {
+      const row = {
+        tag,
+        ...counts,
+        coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
+      };
+      (regex.test(tag) ? requirements : categories).push(row);
+    }
+    requirements.sort((a, b) => NUMERIC_COLLATOR.compare(a.tag, b.tag));
+    categories.sort((a, b) => b.total - a.total || a.tag.localeCompare(b.tag));
+    return { all: [...requirements, ...categories], requirements, categories };
   }
   buildSlowTests(data) {
     const tests = [];
@@ -13534,7 +13541,12 @@ 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, options.sections, options.slowTestThreshold) : this.templateEngine.renderFromPath(renderData, source.absolutePath, options.slowTestThreshold);
+    const renderOpts = {
+      sections: options.sections,
+      slowTestThreshold: options.slowTestThreshold,
+      requirementTagPattern: options.requirementTagPattern
+    };
+    const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, renderOpts) : this.templateEngine.renderFromPath(renderData, source.absolutePath, renderOpts);
     const tempHtmlPath = await this.htmlWriter.write(html);
     const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
     try {
@@ -14402,7 +14414,7 @@ var PdfReporter = class {
     this.options = parseOptions(rawOptions);
     setLogLevel(this.options.logLevel);
     this.dataCollector = new DataCollector(this.options.capture);
-    this.version = true ? "0.21.0" : "0.x";
+    this.version = true ? "0.22.1" : "0.x";
     logger.info(`@reportforge/playwright-pdf v${this.version} initialised`);
     this.licenseClient = new LicenseClient({
       licenseKey: this.options.licenseKey,

package/dist/templates/partials/requirements-matrix.hbs

@@ -2,8 +2,10 @@
 <div class="section">
   <h2>Requirements Traceability</h2>
   <p style="font-size:10px;color:var(--text-3);margin-bottom:12px;">
-    Tests grouped by annotation tags. Add <code>@tag('REQ-001')</code> to link tests to requirements.
+    {{#if requirementTagGroups.length}}Tests grouped by requirement ID tags.{{else}}No requirement ID tags found.{{/if}}
+    Add <code>{ tag: '@REQ-001' }</code> to link tests to requirements.
   </p>
+  {{#if requirementTagGroups.length}}
   <table>
     <thead>
       <tr>
@@ -11,13 +13,13 @@
         <th style="width:60px;">Tests</th>
         <th style="width:60px;">Passed</th>
         <th style="width:60px;">Failed</th>
-        <th style="width:120px;">Coverage</th>
+        <th style="width:120px;">Pass Rate</th>
       </tr>
     </thead>
     <tbody>
-      {{#each tagGroups}}
+      {{#each requirementTagGroups}}
       <tr class="no-break">
-        <td><code style="font-size:9.5px;">{{tag}}</code></td>
+        <td><code class="req-matrix__tag" style="font-size:9.5px;">{{tag}}</code></td>
         <td>{{total}}</td>
         <td style="color:var(--pass);font-weight:600;">{{passed}}</td>
         <td style="color:{{#if failed}}var(--fail){{else}}var(--pass){{/if}};font-weight:600;">{{failed}}</td>
@@ -31,5 +33,19 @@
       {{/each}}
     </tbody>
   </table>
+  {{/if}}
+  {{#if categoryTagGroups.length}}
+  <div class="tag-summary no-break">
+    <div class="tag-summary__label">Tag Summary</div>
+    <div class="tag-summary__items">
+      {{#each categoryTagGroups}}
+      <span class="tag-summary__item{{#if failed}} tag-summary__item--fail{{/if}}">
+        <code class="tag-summary__tag">{{tag}}</code>
+        <span class="tag-summary__counts">{{passed}}/{{total}}</span>
+      </span>
+      {{/each}}
+    </div>
+  </div>
+  {{/if}}
 </div>
 {{/if}}

package/dist/templates/styles/base.css

@@ -891,6 +891,29 @@ code {
 .coverage-bar__fill--mid  { background: var(--timeout); }
 .coverage-bar__fill--high { background: var(--pass); }
 
+/* ── Requirements traceability: category tag summary ─────────────────────── */
+/* Non-requirement tags (suite-level categories like @regression) collapse
+   into one compact row list instead of repeating identical matrix rows. */
+.tag-summary {
+  margin-top: 10px; padding-top: 10px;
+  border-top: 1px solid var(--border);
+}
+.tag-summary__label {
+  font-family: 'Inter', system-ui, sans-serif; font-weight: 600;
+  font-size: 8.5px; letter-spacing: 0.8px; text-transform: uppercase;
+  color: var(--text-3); margin-bottom: 4px;
+}
+.tag-summary__items { max-width: 340px; }
+.tag-summary__item {
+  display: flex; justify-content: space-between; align-items: center;
+  padding: 3.5px 2px;
+  border-bottom: 1px solid var(--border);
+}
+.tag-summary__item:last-child { border-bottom: none; }
+.tag-summary__tag { font-size: 9.5px; color: var(--text-1); background: none; border: none; padding: 0; }
+.tag-summary__counts { font-size: 8.5px; font-weight: 600; color: var(--pass); }
+.tag-summary__item--fail .tag-summary__counts { color: var(--fail); }
+
 /* ── Environment table — full ci-environment mode (fullEnvironment), shared ─── */
 .env-table {
   background: var(--surface);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportforge/playwright-pdf",
-  "version": "0.21.0",
+  "version": "0.22.1",
   "description": "Playwright Test reporter that generates designed PDF reports: minimal, detailed, and executive templates with CI/CD integrations",
   "license": "Elastic-2.0",
   "author": "ReportForge",
@@ -51,7 +51,6 @@
     "dist",
     "ci-templates",
     "README.md",
-    "CHANGELOG.md",
     "LICENSE",
     "SECURITY.md"
   ],