@reportforge/playwright-pdf 0.21.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -208,6 +208,7 @@ All options are the second element of the reporter tuple.
208
208
  | `remoteHistory` | `boolean` | `false` | Opt-in server-side trend store so the pass-rate trend survives ephemeral CI runners (the local history file is wiped with the workspace, leaving the chart stuck at one data point). One request per run over the existing license connection carrying aggregate numbers only — no test titles, no error text; the branch name is sent as a hash. Falls back to the local history file on any failure. See the History docs. |
209
209
  | `flakinessTopN` | `number` | `5` | Maximum flaky tests to show in the flakiness table (`detailed` template). Set to `0` to disable the table entirely. |
210
210
  | `slowTestThreshold` | `number` | `10` | Minimum timed-test count before `SLOW` badges appear in the suite breakdown: below this, every test is trivially the "slowest" so badges stay hidden. On larger runs only genuine outliers (at least 2× the median test duration) are badged, so the badge stays rare. Set to `0` to drop the run-size gate (outliers still required). |
211
+ | `requirementTagPattern` | `string` | `'^@?[A-Z][A-Z0-9]*-\\d+$'` | Regex deciding which tags count as requirement IDs in the Requirements Traceability section (`detailed` template). Matching tags (ticket shapes like `@ODP-5328`, `REQ-001`) get the traceability matrix; everything else (`@regression`, `@sanity`) collapses into a compact tag summary instead of repeating identical rows. Set to `''` to disable the split and list every tag in the matrix. |
211
212
  | `templatePath` | `string \| string[]` | n/a | 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. |
212
213
  | `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`, `briefBand`. Display modifiers: `passRate`, `fullEnvironment`, `retries`, `fullFailures`, `stackTraces`. See the Report Sections docs. |
213
214
  <!-- AUTOGEN:options-table END -->
@@ -442,7 +443,7 @@ reporter: [['@reportforge/playwright-pdf', {
442
443
  | `summary` | KPI strip (total · passed · failed · timed-out · skipped · flaky), verdict, duration, pass rate, flaky callout |
443
444
  | `charts` | Pass-rate doughnut + stacked suite-results bar |
444
445
  | `trend` | Pass-rate trend line, run-history table, and flakiness table (rendered inside `charts`) |
445
- | `requirementsMatrix` | Tests grouped by `@tag('REQ-…')` with coverage bars (requirements traceability) |
446
+ | `requirementsMatrix` | Requirement-ID tags as a traceability matrix with pass-rate bars, plus a category tag summary |
446
447
  | `ciEnvironment` | Branch, commit, browsers, CI provider, OS, Node, Playwright, projects, workers |
447
448
  | `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) |
448
449
  | `failureDeepDive` | Inline failure detail under each failed test in the breakdown: error message, stack trace, screenshot, retry history |
@@ -639,14 +640,14 @@ Full lifecycle + offline failure modes: [reportforge.org/docs/licensing](https:/
639
640
 
640
641
  ## Requirements Traceability
641
642
 
642
- The `detailed` template generates a requirements matrix from test tags. Tag tests to link them to requirements:
643
+ The `detailed` template generates a requirements matrix from test tags. Tag tests with ticket-shaped IDs to link them to requirements:
643
644
 
644
645
  ```ts
645
- test('@REQ-101 user can login', async ({ page }) => { /* ... */ });
646
- test.describe('@FEAT-payment', () => { /* ... */ });
646
+ test('user can login', { tag: ['@REQ-101', '@smoke'] }, async ({ page }) => { /* ... */ });
647
+ test.describe('payment', { tag: '@PAY-204' }, () => { /* ... */ });
647
648
  ```
648
649
 
649
- The matrix rolls tests up per tag with pass count, fail count, and coverage percentage.
650
+ Tags matching `requirementTagPattern` (default: ticket shapes like `@REQ-101`, `@ODP-5328`, `JIRA-42`) each get a matrix row — test count, pass/fail counts, and a pass-rate bar — sorted by ID. Category tags (`@smoke`, `@regression`) collapse into a compact tag summary below the matrix instead of repeating one near-identical row per tag. Set `requirementTagPattern: ''` to disable the split and list every tag in the matrix.
650
651
 
651
652
  ---
652
653
 
package/dist/cli/index.js CHANGED
@@ -95,7 +95,7 @@ var init_stats_utils = __esm({
95
95
  });
96
96
 
97
97
  // src/demo/fixture.ts
98
- function makeTest(id, title, status, duration, retries = 0) {
98
+ function makeTest(id, title, status, duration, retries = 0, tags = []) {
99
99
  return {
100
100
  id,
101
101
  title,
@@ -103,7 +103,7 @@ function makeTest(id, title, status, duration, retries = 0) {
103
103
  status,
104
104
  duration,
105
105
  retryCount: retries,
106
- tags: [],
106
+ tags,
107
107
  annotations: []
108
108
  };
109
109
  }
@@ -381,20 +381,20 @@ var init_fixture = __esm({
381
381
  machineLimit: 25
382
382
  };
383
383
  DEMO_AUTH_TESTS = [
384
- makeTest("auth-1", "should login with valid credentials", "passed", 1240),
385
- makeTest("auth-2", "should show error for wrong password", "passed", 890),
386
- makeTest("auth-3", "should require email confirmation", "passed", 1100),
387
- makeTest("auth-4", "should handle session timeout gracefully", "flaky", 3200, 1),
388
- makeTest("auth-5", "should block brute-force attempts after 5 tries", "failed", 15e3, 2),
389
- makeTest("auth-6", "should logout and clear session cookies", "passed", 780)
384
+ makeTest("auth-1", "should login with valid credentials", "passed", 1240, 0, ["@auth", "@smoke", "@SHOP-1201"]),
385
+ makeTest("auth-2", "should show error for wrong password", "passed", 890, 0, ["@auth", "@smoke", "@SHOP-1201"]),
386
+ makeTest("auth-3", "should require email confirmation", "passed", 1100, 0, ["@auth", "@regression", "@SHOP-1188"]),
387
+ makeTest("auth-4", "should handle session timeout gracefully", "flaky", 3200, 1, ["@auth", "@regression"]),
388
+ makeTest("auth-5", "should block brute-force attempts after 5 tries", "failed", 15e3, 2, ["@auth", "@regression", "@SHOP-1349"]),
389
+ makeTest("auth-6", "should logout and clear session cookies", "passed", 780, 0, ["@auth", "@smoke"])
390
390
  ];
391
391
  DEMO_CHECKOUT_TESTS = [
392
- makeTest("co-1", "should add product to cart", "passed", 1050),
393
- makeTest("co-2", "should apply valid promo code", "passed", 2100),
394
- makeTest("co-3", "should reject expired promo code", "failed", 8e3, 2),
395
- makeTest("co-4", "should calculate shipping by region", "passed", 1800),
396
- makeTest("co-5", "should complete Stripe checkout", "passed", 4200),
397
- makeTest("co-6", "should send order confirmation email", "skipped", 0)
392
+ makeTest("co-1", "should add product to cart", "passed", 1050, 0, ["@checkout", "@smoke", "@SHOP-1042"]),
393
+ makeTest("co-2", "should apply valid promo code", "passed", 2100, 0, ["@checkout", "@regression", "@SHOP-1277"]),
394
+ makeTest("co-3", "should reject expired promo code", "failed", 8e3, 2, ["@checkout", "@regression", "@SHOP-1277"]),
395
+ makeTest("co-4", "should calculate shipping by region", "passed", 1800, 0, ["@checkout", "@regression"]),
396
+ makeTest("co-5", "should complete Stripe checkout", "passed", 4200, 0, ["@checkout", "@smoke", "@SHOP-1042"]),
397
+ makeTest("co-6", "should send order confirmation email", "skipped", 0, 0, ["@checkout"])
398
398
  ];
399
399
  DEMO_CATALOG_TESTS = [
400
400
  makeTest("cat-1", "should display product grid with filters", "passed", 980),
@@ -6362,7 +6362,10 @@ var init_defaults = __esm({
6362
6362
  historySize: 10,
6363
6363
  showTrend: true,
6364
6364
  flakinessTopN: 5,
6365
- slowTestThreshold: 10
6365
+ slowTestThreshold: 10,
6366
+ // Ticket-ID shape: @ODP-5328, REQ-001, JIRA-123. Tags matching this land in
6367
+ // the Requirements Traceability matrix; the rest fall to the tag summary.
6368
+ requirementTagPattern: "^@?[A-Z][A-Z0-9]*-\\d+$"
6366
6369
  };
6367
6370
  }
6368
6371
  });
@@ -6620,7 +6623,7 @@ function deriveOptions(s) {
6620
6623
  showFullFailures: s.fullFailures
6621
6624
  };
6622
6625
  }
6623
- var import_handlebars, import_fs, import_path, A4_HEIGHT_MM, PAGE_MARGIN_Y_MM, PX_PER_MM, SUITE_CHART_SMALL_MAX, SUITE_CHART_ROWS_PER_CANVAS, SUITE_CHART_ROW_PX, SUITE_CHART_PAD_PX, PAGE_CONTENT_HEIGHT_PX, SLOW_MEDIAN_FACTOR, TemplateEngine;
6626
+ var import_handlebars, import_fs, import_path, A4_HEIGHT_MM, PAGE_MARGIN_Y_MM, PX_PER_MM, SUITE_CHART_SMALL_MAX, SUITE_CHART_ROWS_PER_CANVAS, SUITE_CHART_ROW_PX, SUITE_CHART_PAD_PX, PAGE_CONTENT_HEIGHT_PX, NUMERIC_COLLATOR, SLOW_MEDIAN_FACTOR, TemplateEngine;
6624
6627
  var init_engine = __esm({
6625
6628
  "src/templates/engine.ts"() {
6626
6629
  "use strict";
@@ -6640,6 +6643,7 @@ var init_engine = __esm({
6640
6643
  SUITE_CHART_ROW_PX = 18;
6641
6644
  SUITE_CHART_PAD_PX = 56;
6642
6645
  PAGE_CONTENT_HEIGHT_PX = (A4_HEIGHT_MM - 2 * PAGE_MARGIN_Y_MM) * PX_PER_MM;
6646
+ NUMERIC_COLLATOR = new Intl.Collator(void 0, { numeric: true });
6643
6647
  SLOW_MEDIAN_FACTOR = 2;
6644
6648
  TemplateEngine = class {
6645
6649
  constructor() {
@@ -6666,17 +6670,22 @@ var init_engine = __esm({
6666
6670
  setChartjsBundle(inline) {
6667
6671
  this.chartjsInline = inline;
6668
6672
  }
6669
- render(data, template, userSections, slowTestThreshold) {
6673
+ render(data, template, opts = {}) {
6670
6674
  const layoutPath = import_path.default.join(this.templatesDir, "layouts", `${template}.hbs`);
6671
6675
  if (!import_fs.default.existsSync(layoutPath)) {
6672
6676
  throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
6673
6677
  }
6674
6678
  const layoutSource = import_fs.default.readFileSync(layoutPath, "utf8");
6675
6679
  const compiledLayout = this.handlebars.compile(layoutSource);
6676
- const ctx = this.buildContext(data, template, userSections, slowTestThreshold);
6680
+ const ctx = this.assembleContext(
6681
+ data,
6682
+ resolveSections(template, opts.sections),
6683
+ this.readStyle(`${template}.css`),
6684
+ opts
6685
+ );
6677
6686
  return compiledLayout(ctx);
6678
6687
  }
6679
- renderFromPath(data, filePath, slowTestThreshold) {
6688
+ renderFromPath(data, filePath, opts = {}) {
6680
6689
  if (!this.customTemplateCache.has(filePath)) {
6681
6690
  if (!import_fs.default.existsSync(filePath)) {
6682
6691
  throw new Error(`[reportforge] Custom template not found: ${filePath}`);
@@ -6685,46 +6694,27 @@ var init_engine = __esm({
6685
6694
  this.customTemplateCache.set(filePath, this.handlebars.compile(source));
6686
6695
  }
6687
6696
  const compiledFn = this.customTemplateCache.get(filePath);
6688
- return compiledFn(this.buildCustomContext(data, slowTestThreshold));
6697
+ return compiledFn(this.assembleContext(data, allSectionsOn(), "", opts));
6689
6698
  }
6690
- buildCustomContext(data, slowTestThreshold) {
6691
- const sections = allSectionsOn();
6692
- const slow = this.buildSlowTests(data);
6693
- return {
6694
- ...data,
6695
- projects: this.enrichProjects(data, slow, sections, slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold),
6696
- options: deriveOptions(sections),
6697
- sections,
6698
- tagGroups: this.buildTagGroups(data),
6699
- slowTests: slow.ranked,
6700
- baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
6701
- templateCSS: "",
6702
- chartjsScript: this.buildChartjsScript(),
6703
- watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
6704
- releaseGateTally: buildFailureTally(data.analysis),
6705
- suiteChartLarge: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX,
6706
- suiteChartChunks: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX ? buildSuiteChartChunks(data.charts.suiteResults) : []
6707
- };
6708
- }
6709
- buildContext(data, template, userSections, slowTestThreshold) {
6710
- const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
6711
- const templateCSS = this.readStyle(`${template}.css`);
6712
- const sections = resolveSections(template, userSections);
6699
+ assembleContext(data, sections, templateCSS, opts) {
6713
6700
  const options = deriveOptions(sections);
6714
6701
  const slow = this.buildSlowTests(data);
6702
+ const tags = this.buildTagGroups(data, opts.requirementTagPattern);
6715
6703
  return {
6716
6704
  ...data,
6717
6705
  projects: this.enrichProjects(
6718
6706
  data,
6719
6707
  slow,
6720
6708
  sections,
6721
- slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
6709
+ opts.slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
6722
6710
  ),
6723
6711
  options,
6724
6712
  sections,
6725
- tagGroups: this.buildTagGroups(data),
6713
+ tagGroups: tags.all,
6714
+ requirementTagGroups: tags.requirements,
6715
+ categoryTagGroups: tags.categories,
6726
6716
  slowTests: slow.ranked,
6727
- baseCSS,
6717
+ baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
6728
6718
  templateCSS,
6729
6719
  chartjsScript: this.buildChartjsScript(),
6730
6720
  watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
@@ -6736,7 +6726,7 @@ var init_engine = __esm({
6736
6726
  buildChartjsScript() {
6737
6727
  return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
6738
6728
  }
6739
- buildTagGroups(data) {
6729
+ buildTagGroups(data, requirementTagPattern) {
6740
6730
  const tagMap = /* @__PURE__ */ new Map();
6741
6731
  for (const project of data.projects) {
6742
6732
  for (const suite of this.flattenSuites(project.suites)) {
@@ -6751,11 +6741,20 @@ var init_engine = __esm({
6751
6741
  }
6752
6742
  }
6753
6743
  }
6754
- return Array.from(tagMap.entries()).map(([tag, counts]) => ({
6755
- tag,
6756
- ...counts,
6757
- coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
6758
- }));
6744
+ const regex = new RegExp(requirementTagPattern ?? DEFAULT_OPTIONS.requirementTagPattern);
6745
+ const requirements = [];
6746
+ const categories = [];
6747
+ for (const [tag, counts] of tagMap) {
6748
+ const row = {
6749
+ tag,
6750
+ ...counts,
6751
+ coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
6752
+ };
6753
+ (regex.test(tag) ? requirements : categories).push(row);
6754
+ }
6755
+ requirements.sort((a, b) => NUMERIC_COLLATOR.compare(a.tag, b.tag));
6756
+ categories.sort((a, b) => b.total - a.total || a.tag.localeCompare(b.tag));
6757
+ return { all: [...requirements, ...categories], requirements, categories };
6759
6758
  }
6760
6759
  buildSlowTests(data) {
6761
6760
  const tests = [];
@@ -7858,7 +7857,12 @@ var init_PdfGenerator = __esm({
7858
7857
  }
7859
7858
  const templateLabel = source.kind === "builtin" ? source.id : source.label;
7860
7859
  logger.info(`Rendering template: ${templateLabel}`);
7861
- const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, options.sections, options.slowTestThreshold) : this.templateEngine.renderFromPath(renderData, source.absolutePath, options.slowTestThreshold);
7860
+ const renderOpts = {
7861
+ sections: options.sections,
7862
+ slowTestThreshold: options.slowTestThreshold,
7863
+ requirementTagPattern: options.requirementTagPattern
7864
+ };
7865
+ const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, renderOpts) : this.templateEngine.renderFromPath(renderData, source.absolutePath, renderOpts);
7862
7866
  const tempHtmlPath = await this.htmlWriter.write(html);
7863
7867
  const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
7864
7868
  try {
@@ -12133,6 +12137,14 @@ var init_schema = __esm({
12133
12137
  remoteHistory: external_exports.boolean().default(false),
12134
12138
  flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
12135
12139
  slowTestThreshold: external_exports.number().int().min(0, "slowTestThreshold must be 0 or greater").optional().default(DEFAULT_OPTIONS.slowTestThreshold),
12140
+ requirementTagPattern: external_exports.string().refine((v) => {
12141
+ try {
12142
+ new RegExp(v);
12143
+ return true;
12144
+ } catch {
12145
+ return false;
12146
+ }
12147
+ }, "requirementTagPattern must be a valid regular expression").optional().default(DEFAULT_OPTIONS.requirementTagPattern),
12136
12148
  failureAnalysis: failureAnalysisConfigSchema,
12137
12149
  capture: captureConfigSchema,
12138
12150
  live: liveConfigSchema,
package/dist/index.d.mts CHANGED
@@ -357,6 +357,17 @@ interface ReporterOptions {
357
357
  * @default 10
358
358
  */
359
359
  slowTestThreshold?: number;
360
+ /**
361
+ * Regex (string) deciding which tags count as requirement IDs in the
362
+ * Requirements Traceability section. Matching tags get the traceability
363
+ * matrix; the rest collapse into a compact tag summary, so suite-level
364
+ * category tags (`@regression`, `@sanity`) no longer repeat identical
365
+ * rows. The default matches ticket-ID shapes such as `@ODP-5328`,
366
+ * `REQ-001`, or `JIRA-123` (uppercase key, dash, digits). Set to `''` to
367
+ * disable the split and list every tag in the matrix (legacy behavior).
368
+ * @default '^@?[A-Z][A-Z0-9]*-\\d+$'
369
+ */
370
+ requirementTagPattern?: string;
360
371
  /**
361
372
  * Path to a custom Handlebars (.hbs) template file. When set, takes
362
373
  * precedence over `template`. Relative paths resolve from `process.cwd()`.
package/dist/index.d.ts CHANGED
@@ -357,6 +357,17 @@ interface ReporterOptions {
357
357
  * @default 10
358
358
  */
359
359
  slowTestThreshold?: number;
360
+ /**
361
+ * Regex (string) deciding which tags count as requirement IDs in the
362
+ * Requirements Traceability section. Matching tags get the traceability
363
+ * matrix; the rest collapse into a compact tag summary, so suite-level
364
+ * category tags (`@regression`, `@sanity`) no longer repeat identical
365
+ * rows. The default matches ticket-ID shapes such as `@ODP-5328`,
366
+ * `REQ-001`, or `JIRA-123` (uppercase key, dash, digits). Set to `''` to
367
+ * disable the split and list every tag in the matrix (legacy behavior).
368
+ * @default '^@?[A-Z][A-Z0-9]*-\\d+$'
369
+ */
370
+ requirementTagPattern?: string;
360
371
  /**
361
372
  * Path to a custom Handlebars (.hbs) template file. When set, takes
362
373
  * precedence over `template`. Relative paths resolve from `process.cwd()`.
package/dist/index.js CHANGED
@@ -10330,7 +10330,10 @@ var DEFAULT_OPTIONS = {
10330
10330
  historySize: 10,
10331
10331
  showTrend: true,
10332
10332
  flakinessTopN: 5,
10333
- slowTestThreshold: 10
10333
+ slowTestThreshold: 10,
10334
+ // Ticket-ID shape: @ODP-5328, REQ-001, JIRA-123. Tags matching this land in
10335
+ // the Requirements Traceability matrix; the rest fall to the tag summary.
10336
+ requirementTagPattern: "^@?[A-Z][A-Z0-9]*-\\d+$"
10334
10337
  };
10335
10338
 
10336
10339
  // src/templates/sections.ts
@@ -10559,6 +10562,14 @@ var ReporterOptionsSchema = external_exports.object({
10559
10562
  remoteHistory: external_exports.boolean().default(false),
10560
10563
  flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
10561
10564
  slowTestThreshold: external_exports.number().int().min(0, "slowTestThreshold must be 0 or greater").optional().default(DEFAULT_OPTIONS.slowTestThreshold),
10565
+ requirementTagPattern: external_exports.string().refine((v) => {
10566
+ try {
10567
+ new RegExp(v);
10568
+ return true;
10569
+ } catch {
10570
+ return false;
10571
+ }
10572
+ }, "requirementTagPattern must be a valid regular expression").optional().default(DEFAULT_OPTIONS.requirementTagPattern),
10562
10573
  failureAnalysis: failureAnalysisConfigSchema,
10563
10574
  capture: captureConfigSchema,
10564
10575
  live: liveConfigSchema,
@@ -12638,6 +12649,7 @@ var PAGE_CONTENT_HEIGHT_PX = (A4_HEIGHT_MM - 2 * PAGE_MARGIN_Y_MM) * PX_PER_MM;
12638
12649
  function isUnknownValue(v) {
12639
12650
  return !v || v === "unknown";
12640
12651
  }
12652
+ var NUMERIC_COLLATOR = new Intl.Collator(void 0, { numeric: true });
12641
12653
  var SLOW_MEDIAN_FACTOR = 2;
12642
12654
  function buildSuiteChartChunks(rows) {
12643
12655
  const chunks = [];
@@ -12687,17 +12699,22 @@ var TemplateEngine = class {
12687
12699
  setChartjsBundle(inline) {
12688
12700
  this.chartjsInline = inline;
12689
12701
  }
12690
- render(data, template, userSections, slowTestThreshold) {
12702
+ render(data, template, opts = {}) {
12691
12703
  const layoutPath = import_path3.default.join(this.templatesDir, "layouts", `${template}.hbs`);
12692
12704
  if (!import_fs4.default.existsSync(layoutPath)) {
12693
12705
  throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
12694
12706
  }
12695
12707
  const layoutSource = import_fs4.default.readFileSync(layoutPath, "utf8");
12696
12708
  const compiledLayout = this.handlebars.compile(layoutSource);
12697
- const ctx = this.buildContext(data, template, userSections, slowTestThreshold);
12709
+ const ctx = this.assembleContext(
12710
+ data,
12711
+ resolveSections(template, opts.sections),
12712
+ this.readStyle(`${template}.css`),
12713
+ opts
12714
+ );
12698
12715
  return compiledLayout(ctx);
12699
12716
  }
12700
- renderFromPath(data, filePath, slowTestThreshold) {
12717
+ renderFromPath(data, filePath, opts = {}) {
12701
12718
  if (!this.customTemplateCache.has(filePath)) {
12702
12719
  if (!import_fs4.default.existsSync(filePath)) {
12703
12720
  throw new Error(`[reportforge] Custom template not found: ${filePath}`);
@@ -12706,46 +12723,27 @@ var TemplateEngine = class {
12706
12723
  this.customTemplateCache.set(filePath, this.handlebars.compile(source));
12707
12724
  }
12708
12725
  const compiledFn = this.customTemplateCache.get(filePath);
12709
- return compiledFn(this.buildCustomContext(data, slowTestThreshold));
12726
+ return compiledFn(this.assembleContext(data, allSectionsOn(), "", opts));
12710
12727
  }
12711
- buildCustomContext(data, slowTestThreshold) {
12712
- const sections = allSectionsOn();
12713
- const slow = this.buildSlowTests(data);
12714
- return {
12715
- ...data,
12716
- projects: this.enrichProjects(data, slow, sections, slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold),
12717
- options: deriveOptions(sections),
12718
- sections,
12719
- tagGroups: this.buildTagGroups(data),
12720
- slowTests: slow.ranked,
12721
- baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
12722
- templateCSS: "",
12723
- chartjsScript: this.buildChartjsScript(),
12724
- watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
12725
- releaseGateTally: buildFailureTally(data.analysis),
12726
- suiteChartLarge: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX,
12727
- suiteChartChunks: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX ? buildSuiteChartChunks(data.charts.suiteResults) : []
12728
- };
12729
- }
12730
- buildContext(data, template, userSections, slowTestThreshold) {
12731
- const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
12732
- const templateCSS = this.readStyle(`${template}.css`);
12733
- const sections = resolveSections(template, userSections);
12728
+ assembleContext(data, sections, templateCSS, opts) {
12734
12729
  const options = deriveOptions(sections);
12735
12730
  const slow = this.buildSlowTests(data);
12731
+ const tags = this.buildTagGroups(data, opts.requirementTagPattern);
12736
12732
  return {
12737
12733
  ...data,
12738
12734
  projects: this.enrichProjects(
12739
12735
  data,
12740
12736
  slow,
12741
12737
  sections,
12742
- slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
12738
+ opts.slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
12743
12739
  ),
12744
12740
  options,
12745
12741
  sections,
12746
- tagGroups: this.buildTagGroups(data),
12742
+ tagGroups: tags.all,
12743
+ requirementTagGroups: tags.requirements,
12744
+ categoryTagGroups: tags.categories,
12747
12745
  slowTests: slow.ranked,
12748
- baseCSS,
12746
+ baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
12749
12747
  templateCSS,
12750
12748
  chartjsScript: this.buildChartjsScript(),
12751
12749
  watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
@@ -12757,7 +12755,7 @@ var TemplateEngine = class {
12757
12755
  buildChartjsScript() {
12758
12756
  return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
12759
12757
  }
12760
- buildTagGroups(data) {
12758
+ buildTagGroups(data, requirementTagPattern) {
12761
12759
  const tagMap = /* @__PURE__ */ new Map();
12762
12760
  for (const project of data.projects) {
12763
12761
  for (const suite of this.flattenSuites(project.suites)) {
@@ -12772,11 +12770,20 @@ var TemplateEngine = class {
12772
12770
  }
12773
12771
  }
12774
12772
  }
12775
- return Array.from(tagMap.entries()).map(([tag, counts]) => ({
12776
- tag,
12777
- ...counts,
12778
- coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
12779
- }));
12773
+ const regex = new RegExp(requirementTagPattern ?? DEFAULT_OPTIONS.requirementTagPattern);
12774
+ const requirements = [];
12775
+ const categories = [];
12776
+ for (const [tag, counts] of tagMap) {
12777
+ const row = {
12778
+ tag,
12779
+ ...counts,
12780
+ coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
12781
+ };
12782
+ (regex.test(tag) ? requirements : categories).push(row);
12783
+ }
12784
+ requirements.sort((a, b) => NUMERIC_COLLATOR.compare(a.tag, b.tag));
12785
+ categories.sort((a, b) => b.total - a.total || a.tag.localeCompare(b.tag));
12786
+ return { all: [...requirements, ...categories], requirements, categories };
12780
12787
  }
12781
12788
  buildSlowTests(data) {
12782
12789
  const tests = [];
@@ -13533,7 +13540,12 @@ var PdfGenerator = class {
13533
13540
  }
13534
13541
  const templateLabel = source.kind === "builtin" ? source.id : source.label;
13535
13542
  logger.info(`Rendering template: ${templateLabel}`);
13536
- const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, options.sections, options.slowTestThreshold) : this.templateEngine.renderFromPath(renderData, source.absolutePath, options.slowTestThreshold);
13543
+ const renderOpts = {
13544
+ sections: options.sections,
13545
+ slowTestThreshold: options.slowTestThreshold,
13546
+ requirementTagPattern: options.requirementTagPattern
13547
+ };
13548
+ const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, renderOpts) : this.templateEngine.renderFromPath(renderData, source.absolutePath, renderOpts);
13537
13549
  const tempHtmlPath = await this.htmlWriter.write(html);
13538
13550
  const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
13539
13551
  try {
@@ -14401,7 +14413,7 @@ var PdfReporter = class {
14401
14413
  this.options = parseOptions(rawOptions);
14402
14414
  setLogLevel(this.options.logLevel);
14403
14415
  this.dataCollector = new DataCollector(this.options.capture);
14404
- this.version = true ? "0.21.0" : "0.x";
14416
+ this.version = true ? "0.22.0" : "0.x";
14405
14417
  logger.info(`@reportforge/playwright-pdf v${this.version} initialised`);
14406
14418
  this.licenseClient = new LicenseClient({
14407
14419
  licenseKey: this.options.licenseKey,
package/dist/index.mjs CHANGED
@@ -10331,7 +10331,10 @@ var DEFAULT_OPTIONS = {
10331
10331
  historySize: 10,
10332
10332
  showTrend: true,
10333
10333
  flakinessTopN: 5,
10334
- slowTestThreshold: 10
10334
+ slowTestThreshold: 10,
10335
+ // Ticket-ID shape: @ODP-5328, REQ-001, JIRA-123. Tags matching this land in
10336
+ // the Requirements Traceability matrix; the rest fall to the tag summary.
10337
+ requirementTagPattern: "^@?[A-Z][A-Z0-9]*-\\d+$"
10335
10338
  };
10336
10339
 
10337
10340
  // src/templates/sections.ts
@@ -10560,6 +10563,14 @@ var ReporterOptionsSchema = external_exports.object({
10560
10563
  remoteHistory: external_exports.boolean().default(false),
10561
10564
  flakinessTopN: external_exports.number().int().min(0, "flakinessTopN must be 0 or greater").optional().default(DEFAULT_OPTIONS.flakinessTopN),
10562
10565
  slowTestThreshold: external_exports.number().int().min(0, "slowTestThreshold must be 0 or greater").optional().default(DEFAULT_OPTIONS.slowTestThreshold),
10566
+ requirementTagPattern: external_exports.string().refine((v) => {
10567
+ try {
10568
+ new RegExp(v);
10569
+ return true;
10570
+ } catch {
10571
+ return false;
10572
+ }
10573
+ }, "requirementTagPattern must be a valid regular expression").optional().default(DEFAULT_OPTIONS.requirementTagPattern),
10563
10574
  failureAnalysis: failureAnalysisConfigSchema,
10564
10575
  capture: captureConfigSchema,
10565
10576
  live: liveConfigSchema,
@@ -12639,6 +12650,7 @@ var PAGE_CONTENT_HEIGHT_PX = (A4_HEIGHT_MM - 2 * PAGE_MARGIN_Y_MM) * PX_PER_MM;
12639
12650
  function isUnknownValue(v) {
12640
12651
  return !v || v === "unknown";
12641
12652
  }
12653
+ var NUMERIC_COLLATOR = new Intl.Collator(void 0, { numeric: true });
12642
12654
  var SLOW_MEDIAN_FACTOR = 2;
12643
12655
  function buildSuiteChartChunks(rows) {
12644
12656
  const chunks = [];
@@ -12688,17 +12700,22 @@ var TemplateEngine = class {
12688
12700
  setChartjsBundle(inline) {
12689
12701
  this.chartjsInline = inline;
12690
12702
  }
12691
- render(data, template, userSections, slowTestThreshold) {
12703
+ render(data, template, opts = {}) {
12692
12704
  const layoutPath = path9.join(this.templatesDir, "layouts", `${template}.hbs`);
12693
12705
  if (!fs7.existsSync(layoutPath)) {
12694
12706
  throw new Error(`[reportforge] Template layout not found: ${layoutPath}`);
12695
12707
  }
12696
12708
  const layoutSource = fs7.readFileSync(layoutPath, "utf8");
12697
12709
  const compiledLayout = this.handlebars.compile(layoutSource);
12698
- const ctx = this.buildContext(data, template, userSections, slowTestThreshold);
12710
+ const ctx = this.assembleContext(
12711
+ data,
12712
+ resolveSections(template, opts.sections),
12713
+ this.readStyle(`${template}.css`),
12714
+ opts
12715
+ );
12699
12716
  return compiledLayout(ctx);
12700
12717
  }
12701
- renderFromPath(data, filePath, slowTestThreshold) {
12718
+ renderFromPath(data, filePath, opts = {}) {
12702
12719
  if (!this.customTemplateCache.has(filePath)) {
12703
12720
  if (!fs7.existsSync(filePath)) {
12704
12721
  throw new Error(`[reportforge] Custom template not found: ${filePath}`);
@@ -12707,46 +12724,27 @@ var TemplateEngine = class {
12707
12724
  this.customTemplateCache.set(filePath, this.handlebars.compile(source));
12708
12725
  }
12709
12726
  const compiledFn = this.customTemplateCache.get(filePath);
12710
- return compiledFn(this.buildCustomContext(data, slowTestThreshold));
12727
+ return compiledFn(this.assembleContext(data, allSectionsOn(), "", opts));
12711
12728
  }
12712
- buildCustomContext(data, slowTestThreshold) {
12713
- const sections = allSectionsOn();
12714
- const slow = this.buildSlowTests(data);
12715
- return {
12716
- ...data,
12717
- projects: this.enrichProjects(data, slow, sections, slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold),
12718
- options: deriveOptions(sections),
12719
- sections,
12720
- tagGroups: this.buildTagGroups(data),
12721
- slowTests: slow.ranked,
12722
- baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
12723
- templateCSS: "",
12724
- chartjsScript: this.buildChartjsScript(),
12725
- watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
12726
- releaseGateTally: buildFailureTally(data.analysis),
12727
- suiteChartLarge: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX,
12728
- suiteChartChunks: data.charts.suiteResults.length > SUITE_CHART_SMALL_MAX ? buildSuiteChartChunks(data.charts.suiteResults) : []
12729
- };
12730
- }
12731
- buildContext(data, template, userSections, slowTestThreshold) {
12732
- const baseCSS = this.fontsBundleCss + "\n" + this.readStyle("base.css");
12733
- const templateCSS = this.readStyle(`${template}.css`);
12734
- const sections = resolveSections(template, userSections);
12729
+ assembleContext(data, sections, templateCSS, opts) {
12735
12730
  const options = deriveOptions(sections);
12736
12731
  const slow = this.buildSlowTests(data);
12732
+ const tags = this.buildTagGroups(data, opts.requirementTagPattern);
12737
12733
  return {
12738
12734
  ...data,
12739
12735
  projects: this.enrichProjects(
12740
12736
  data,
12741
12737
  slow,
12742
12738
  sections,
12743
- slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
12739
+ opts.slowTestThreshold ?? DEFAULT_OPTIONS.slowTestThreshold
12744
12740
  ),
12745
12741
  options,
12746
12742
  sections,
12747
- tagGroups: this.buildTagGroups(data),
12743
+ tagGroups: tags.all,
12744
+ requirementTagGroups: tags.requirements,
12745
+ categoryTagGroups: tags.categories,
12748
12746
  slowTests: slow.ranked,
12749
- baseCSS,
12747
+ baseCSS: this.fontsBundleCss + "\n" + this.readStyle("base.css"),
12750
12748
  templateCSS,
12751
12749
  chartjsScript: this.buildChartjsScript(),
12752
12750
  watermarkPageHeightPx: PAGE_CONTENT_HEIGHT_PX,
@@ -12758,7 +12756,7 @@ var TemplateEngine = class {
12758
12756
  buildChartjsScript() {
12759
12757
  return this.chartjsInline ? `<script>${this.chartjsInline}</script>` : "<!-- Chart.js not bundled; charts disabled --><script>window.__chartsReady=true;</script>";
12760
12758
  }
12761
- buildTagGroups(data) {
12759
+ buildTagGroups(data, requirementTagPattern) {
12762
12760
  const tagMap = /* @__PURE__ */ new Map();
12763
12761
  for (const project of data.projects) {
12764
12762
  for (const suite of this.flattenSuites(project.suites)) {
@@ -12773,11 +12771,20 @@ var TemplateEngine = class {
12773
12771
  }
12774
12772
  }
12775
12773
  }
12776
- return Array.from(tagMap.entries()).map(([tag, counts]) => ({
12777
- tag,
12778
- ...counts,
12779
- coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
12780
- }));
12774
+ const regex = new RegExp(requirementTagPattern ?? DEFAULT_OPTIONS.requirementTagPattern);
12775
+ const requirements = [];
12776
+ const categories = [];
12777
+ for (const [tag, counts] of tagMap) {
12778
+ const row = {
12779
+ tag,
12780
+ ...counts,
12781
+ coveragePct: counts.total > 0 ? Math.round(counts.passed / counts.total * 100) : 0
12782
+ };
12783
+ (regex.test(tag) ? requirements : categories).push(row);
12784
+ }
12785
+ requirements.sort((a, b) => NUMERIC_COLLATOR.compare(a.tag, b.tag));
12786
+ categories.sort((a, b) => b.total - a.total || a.tag.localeCompare(b.tag));
12787
+ return { all: [...requirements, ...categories], requirements, categories };
12781
12788
  }
12782
12789
  buildSlowTests(data) {
12783
12790
  const tests = [];
@@ -13534,7 +13541,12 @@ var PdfGenerator = class {
13534
13541
  }
13535
13542
  const templateLabel = source.kind === "builtin" ? source.id : source.label;
13536
13543
  logger.info(`Rendering template: ${templateLabel}`);
13537
- const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, options.sections, options.slowTestThreshold) : this.templateEngine.renderFromPath(renderData, source.absolutePath, options.slowTestThreshold);
13544
+ const renderOpts = {
13545
+ sections: options.sections,
13546
+ slowTestThreshold: options.slowTestThreshold,
13547
+ requirementTagPattern: options.requirementTagPattern
13548
+ };
13549
+ const html = source.kind === "builtin" ? this.templateEngine.render(renderData, source.id, renderOpts) : this.templateEngine.renderFromPath(renderData, source.absolutePath, renderOpts);
13538
13550
  const tempHtmlPath = await this.htmlWriter.write(html);
13539
13551
  const fileUrl = this.htmlWriter.toFileUrl(tempHtmlPath);
13540
13552
  try {
@@ -14402,7 +14414,7 @@ var PdfReporter = class {
14402
14414
  this.options = parseOptions(rawOptions);
14403
14415
  setLogLevel(this.options.logLevel);
14404
14416
  this.dataCollector = new DataCollector(this.options.capture);
14405
- this.version = true ? "0.21.0" : "0.x";
14417
+ this.version = true ? "0.22.0" : "0.x";
14406
14418
  logger.info(`@reportforge/playwright-pdf v${this.version} initialised`);
14407
14419
  this.licenseClient = new LicenseClient({
14408
14420
  licenseKey: this.options.licenseKey,
@@ -2,8 +2,10 @@
2
2
  <div class="section">
3
3
  <h2>Requirements Traceability</h2>
4
4
  <p style="font-size:10px;color:var(--text-3);margin-bottom:12px;">
5
- Tests grouped by annotation tags. Add <code>@tag('REQ-001')</code> to link tests to requirements.
5
+ {{#if requirementTagGroups.length}}Tests grouped by requirement ID tags.{{else}}No requirement ID tags found.{{/if}}
6
+ Add <code>{ tag: '@REQ-001' }</code> to link tests to requirements.
6
7
  </p>
8
+ {{#if requirementTagGroups.length}}
7
9
  <table>
8
10
  <thead>
9
11
  <tr>
@@ -11,13 +13,13 @@
11
13
  <th style="width:60px;">Tests</th>
12
14
  <th style="width:60px;">Passed</th>
13
15
  <th style="width:60px;">Failed</th>
14
- <th style="width:120px;">Coverage</th>
16
+ <th style="width:120px;">Pass Rate</th>
15
17
  </tr>
16
18
  </thead>
17
19
  <tbody>
18
- {{#each tagGroups}}
20
+ {{#each requirementTagGroups}}
19
21
  <tr class="no-break">
20
- <td><code style="font-size:9.5px;">{{tag}}</code></td>
22
+ <td><code class="req-matrix__tag" style="font-size:9.5px;">{{tag}}</code></td>
21
23
  <td>{{total}}</td>
22
24
  <td style="color:var(--pass);font-weight:600;">{{passed}}</td>
23
25
  <td style="color:{{#if failed}}var(--fail){{else}}var(--pass){{/if}};font-weight:600;">{{failed}}</td>
@@ -31,5 +33,19 @@
31
33
  {{/each}}
32
34
  </tbody>
33
35
  </table>
36
+ {{/if}}
37
+ {{#if categoryTagGroups.length}}
38
+ <div class="tag-summary no-break">
39
+ <div class="tag-summary__label">Tag Summary</div>
40
+ <div class="tag-summary__items">
41
+ {{#each categoryTagGroups}}
42
+ <span class="tag-summary__item{{#if failed}} tag-summary__item--fail{{/if}}">
43
+ <code class="tag-summary__tag">{{tag}}</code>
44
+ <span class="tag-summary__counts">{{passed}}/{{total}}</span>
45
+ </span>
46
+ {{/each}}
47
+ </div>
48
+ </div>
49
+ {{/if}}
34
50
  </div>
35
51
  {{/if}}
@@ -891,6 +891,29 @@ code {
891
891
  .coverage-bar__fill--mid { background: var(--timeout); }
892
892
  .coverage-bar__fill--high { background: var(--pass); }
893
893
 
894
+ /* ── Requirements traceability: category tag summary ─────────────────────── */
895
+ /* Non-requirement tags (suite-level categories like @regression) collapse
896
+ into one compact row list instead of repeating identical matrix rows. */
897
+ .tag-summary {
898
+ margin-top: 10px; padding-top: 10px;
899
+ border-top: 1px solid var(--border);
900
+ }
901
+ .tag-summary__label {
902
+ font-family: 'Inter', system-ui, sans-serif; font-weight: 600;
903
+ font-size: 8.5px; letter-spacing: 0.8px; text-transform: uppercase;
904
+ color: var(--text-3); margin-bottom: 4px;
905
+ }
906
+ .tag-summary__items { max-width: 340px; }
907
+ .tag-summary__item {
908
+ display: flex; justify-content: space-between; align-items: center;
909
+ padding: 3.5px 2px;
910
+ border-bottom: 1px solid var(--border);
911
+ }
912
+ .tag-summary__item:last-child { border-bottom: none; }
913
+ .tag-summary__tag { font-size: 9.5px; color: var(--text-1); background: none; border: none; padding: 0; }
914
+ .tag-summary__counts { font-size: 8.5px; font-weight: 600; color: var(--pass); }
915
+ .tag-summary__item--fail .tag-summary__counts { color: var(--fail); }
916
+
894
917
  /* ── Environment table — full ci-environment mode (fullEnvironment), shared ─── */
895
918
  .env-table {
896
919
  background: var(--surface);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reportforge/playwright-pdf",
3
- "version": "0.21.0",
3
+ "version": "0.22.0",
4
4
  "description": "Playwright Test reporter that generates designed PDF reports: minimal, detailed, and executive templates with CI/CD integrations",
5
5
  "license": "Elastic-2.0",
6
6
  "author": "ReportForge",