reporting-labs 0.4.2 → 0.5.0

package/README.md

@@ -46,13 +46,25 @@ Your other reporters (list, html, blob...) keep working as before.
 
 ```bash
 npx playwright test
-open reporting-labs/index.html
 ```
 
+The report opens in your browser when something failed (`open: 'always'` to open every time, `'never'` to stay quiet). It is at `reporting-labs/index.html`.
+
 Done. Everything below is optional.
 
 > **In a hurry?** Skip the config file and pass options inline: `reporter: [['reporting-labs', { title: 'My app' }]]`.
 
+## See everything the report can do
+
+Every card and tab is switched on. What you see depends on what your tests give it:
+
+1. **Add `meta()` to your tests** and the report ranks failures by priority, groups them by owner and feature, and links to your stories. See [the helpers](#add-details-to-your-tests-3-small-helpers).
+2. **Run the suite twice** and the Trend chart, "new vs known" failures, flaky dots and "Got slower" appear. History is kept in `reporting-labs.history.json`.
+3. **Turn on Playwright's `screenshot`, `video` and `trace`** in `playwright.config.ts` and they show up on every failed test.
+4. **Have more than one Playwright project** (say chromium and webkit) and you get a feature × project heatmap.
+
+The report tells you about these itself: a card that has nothing to show yet explains what to do.
+
 ## Add details to your tests (3 small helpers)
 
 The report already shows steps, screenshots, videos, traces and errors on its own. Three small helpers add the rest. Import them from `reporting-labs` and call them inside a test.
@@ -73,6 +85,7 @@ One line per test. With this the report can rank failures by priority, group the
 - Known keys: `priority`, `severity`, `owner`, `feature`, `epic`, `story`, `issue`, `component`, `team`. Any other key you pass is shown too.
 - Your Playwright tags like `@sanity` or `@regression` stay as they are and still show on the test.
 - To make story and epic keys clickable, set `links` in the config: `links: { story: 'https://yourteam.atlassian.net/browse/{id}' }`.
+- Forgot one? After every run the console lists the tests that have no `meta()`, with file and line. Turn it off with `warnMissingMeta: false`.
 - `priority`, `severity`, `feature` and `owner` each get a tab in the Breakdown chart and a filter on the Tests page. Want the same for your own key, say `meta({ team: 'web' })`? Add it to `dimensions` in the config: `dimensions: ['priority', 'severity', 'feature', 'owner', 'team']`.
 
 ### `log()`: a line in the report
@@ -287,6 +300,8 @@ Every option is optional. `npx reporting-labs init` writes them all, with commen
 | `embedVideos` | `false` | Videos inside the HTML too (bigger file, no folder issues) |
 | `embedFonts` | `true` | Bundle the fonts (~140 KB) so it looks the same offline |
 | `announce` | `true` | Print the report path after the run |
+| `open` | `'on-failure'` | Open the report in the browser after the run: `'on-failure'`, `'always'` or `'never'`. Never opens in CI |
+| `warnMissingMeta` | `true` | After the run, list the tests that have no `meta()` in the console, so nobody on the team forgets |
 
 If your reporter list differs between CI and local, add the same line to both:
 

package/bin/config-template.txt

@@ -3,6 +3,9 @@ import type { ReportingLabsOptions } from 'reporting-labs';
 
 // reportingLabs configuration.
 // Every option is optional. Lines that start with // show the default; uncomment and change what you need.
+// All cards and tabs are on by default. What the report shows depends on your tests: add meta() for
+// priorities and owners, run the suite twice for trends and flaky detection, and keep Playwright's
+// screenshot / video / trace settings on. A card with nothing to show yet tells you what to do.
 // Docs: https://github.com/naveenautomationlabs/reporting-labs#options
 
 const config: ReportingLabsOptions = {
@@ -32,6 +35,8 @@ const config: ReportingLabsOptions = {
   // embedLimit: 2 * 1024 * 1024,                     // attachments bigger than this (bytes) are copied as files
   // embedVideos: false,                              // true = videos inside the HTML too (bigger file, no folder issues)
   // announce: true,                                  // print the report path after the run
+  // open: 'on-failure',                              // open the report in the browser: 'on-failure' | 'always' | 'never'; never in CI
+  // warnMissingMeta: true,                           // after the run, list tests that have no meta() in the console
 
   // ── Test details ─────────────────────────────────────────────────────────────
   // Values come from meta({ priority, severity, owner, feature, epic, story, ... }) in your tests.

package/dist/reporter.d.ts

@@ -20,6 +20,10 @@ export default class ReportingLabsReporter implements Reporter {
     private pushOutput;
     onBegin(config: FullConfig, suite: Suite): void;
     onEnd(result: FullResult): Promise<void>;
+    /** One short list of tests that carry no meta() at all, so the whole team keeps the report useful. */
+    private printMissingMeta;
+    /** Open the report in the default browser, like Playwright's HTML reporter. Never in CI. */
+    private maybeOpen;
     /** Videos and traces are finalized asynchronously by the runner; wait until every file-backed attachment stops growing. */
     private settleAttachmentFiles;
     /** Runtime facts for the Environment card: Playwright, Node, OS, browsers, CI job, git commit. */

package/dist/reporter.js

@@ -204,8 +204,46 @@ class ReportingLabsReporter {
         fs.writeFileSync(file, (0, template_1.renderHtml)(data), 'utf8');
         if (this.options.announce !== false) {
             const rel = path.relative(process.cwd(), file);
-            console.log(`\n  reporting-labs: report written to ${rel}\n`);
+            console.log(`\n  reporting-labs: report written to ${rel}`);
+            this.printMissingMeta(tests);
+            console.log('');
         }
+        this.maybeOpen(file, result);
+    }
+    /** One short list of tests that carry no meta() at all, so the whole team keeps the report useful. */
+    printMissingMeta(tests) {
+        if (this.options.warnMissingMeta === false)
+            return;
+        const seen = new Set();
+        const missing = tests.filter(t => Object.keys(t.meta).length === 0 && !seen.has(t.file + ':' + t.line) && seen.add(t.file + ':' + t.line));
+        if (!missing.length)
+            return;
+        const total = new Set(tests.map(t => t.file + ':' + t.line)).size;
+        console.log(`  reporting-labs: ${missing.length} of ${total} tests have no meta()`);
+        const show = missing.slice(0, 15);
+        const w = Math.max(...show.map(t => (t.file + ':' + t.line).length));
+        for (const t of show)
+            console.log(`    ${(t.file + ':' + t.line).padEnd(w)}  ${t.title}`);
+        if (missing.length > show.length)
+            console.log(`    … and ${missing.length - show.length} more`);
+        console.log("    Add meta({ priority: 'P1', owner: 'name', feature: 'area' }) at the top of the test. Set warnMissingMeta: false to hide this.");
+    }
+    /** Open the report in the default browser, like Playwright's HTML reporter. Never in CI. */
+    maybeOpen(file, result) {
+        const mode = this.options.open ?? 'on-failure';
+        if (mode === 'never' || process.env.CI)
+            return;
+        if (mode === 'on-failure' && result.status === 'passed')
+            return;
+        try {
+            const cmd = process.platform === 'darwin' ? ['open', [file]]
+                : process.platform === 'win32' ? ['cmd', ['/c', 'start', '', file]]
+                    : ['xdg-open', [file]];
+            const child = (0, child_process_1.spawn)(cmd[0], [...cmd[1]], { detached: true, stdio: 'ignore' });
+            child.on('error', () => { });
+            child.unref();
+        }
+        catch { /* ignore */ }
     }
     // ---- helpers -------------------------------------------------------------
     /** Videos and traces are finalized asynchronously by the runner; wait until every file-backed attachment stops growing. */

package/dist/template.js

@@ -268,6 +268,7 @@ a{color:var(--accent)}
 .item .tt .n{font-size:13px;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}
 .item .d{font:11px var(--mono);color:var(--ink-3);margin-top:3px}
 .empty{padding:40px 20px;text-align:center;color:var(--ink-3)}
+.nudge{font-size:var(--fs-s);color:var(--ink-2);background:var(--surface-2);border:1px dashed var(--line);border-radius:var(--radius);padding:10px 12px;margin-bottom:10px;line-height:1.5} .nudge code{font-family:var(--mono);font-size:12px} .nudge b{color:var(--ink)}
 
 /* ---------- detail ---------- */
 .detail{background:var(--surface);border:1px solid var(--line);border-radius:var(--radius);padding:22px;min-width:0}
@@ -872,6 +873,7 @@ function summary(){
   if(W.skipped!==false) { const sc=skippedCard(); if(sc) g.push(sc); }
   if(W.environment!==false) { const ec=envCard(); if(ec) g.push(ec); }
   if(data.history.length>1) g.push(h('div',{class:'card w12'}, h('h2',{},'Trend', h('span',{class:'hint'},'last '+data.history.length+' runs')), trend()));
+  else if(data.history.length===1) g.push(h('div',{class:'card w12'}, h('h2',{},'Trend', h('span',{class:'hint'},'from the second run')), h('div',{class:'nudge'}, h('b',{},'First run recorded.'),' Run the suite once more and this card shows the pass-rate trend, and every failure gets "new this run" or "failing since #…", last-10-runs dots, a Flakiest tests card and a Got slower tab. History lives in ',h('code',{},data.historyFile||'reporting-labs.history.json'),', commit it or cache it in CI.')));
   const ge=data.globalErrors||[], go=data.globalOutput||[];
   if(ge.length||go.some(x=>x.stream==='err')) g.unshift(h('div',{class:'card w12 fail-rail'}, h('h2',{}, ge.length? ge.length+' error'+(ge.length>1?'s':'')+' outside tests' : 'Output outside tests', h('span',{class:'hint'},'spec files that failed to load, global setup, worker crashes')),
     ...ge.map(errorView), go.length? h('details',{class:'errfull'}, h('summary',{},'Console output outside tests ('+go.length+' chunks)'), h('pre',{class:'txt'}, go.map(x=>(x.stream==='err'?'[stderr] ':'')+x.text).join(''))) : null));
@@ -1137,10 +1139,11 @@ function breakdown(){
   if(data.options.widgets.tags&&data.tests.some(t=>t.tags.length)) tabs.push(['tags','Tags',tagsChart]);
   if(data.projects.length>1&&DIMS.length) tabs.push(['heat','Heatmap',heatmap]);
   if(!tabs.length) return h('div',{class:'empty'},'Add meta({ priority, severity, owner, feature }) to your tests to see breakdowns here.');
+  const nudge=!DIMS.length? h('div',{class:'nudge'}, h('b',{},'Tip:'),' add ',h('code',{},"meta({ priority: 'P1', severity: 'major', owner: 'priya', feature: 'checkout' })"),' at the top of a test and this card gains Priority, Severity, Feature and Owner tabs, the failures get ranked, and owners get their own rollup.') : null;
   let cur=tabs[0][0]; const bar=h('div',{class:'bk-tabs'}), body=h('div',{});
   const render=()=>{ body.innerHTML=''; body.append(tabs.find(t=>t[0]===cur)[2]()); bar.querySelectorAll('button').forEach(b=>b.setAttribute('aria-selected',b.dataset.k===cur)); };
   for(const [k,l] of tabs) bar.append(h('button',{'data-k':k,onclick:()=>{cur=k;render();}},l));
-  render(); return h('div',{}, bar, body);
+  render(); return h('div',{}, nudge, bar, body);
 }
 function errorSignature(msg){
   return (msg||'').split('\n')[0].replace(/\d+(\.\d+)?(ms|s)\b/g,'N').replace(/\b\d{2,}\b/g,'N').replace(/["'][^"']{0,60}["']/g,'"…"').replace(/\s+/g,' ').trim().slice(0,160);

package/dist/types.d.ts

@@ -58,6 +58,10 @@ export interface ReportingLabsOptions {
     embedFonts?: boolean;
     /** Print report path to the console after the run. Default: true */
     announce?: boolean;
+    /** After the run, list the tests that have no meta() in the console. Default: true */
+    warnMissingMeta?: boolean;
+    /** Open the report in the browser after the run: 'on-failure' (default), 'always' or 'never'. Never opens in CI. */
+    open?: 'on-failure' | 'always' | 'never';
     /** Company / project block in the header. */
     project?: {
         name?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reporting-labs",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "description": "reportingLabs – beautiful, customizable single-file HTML test reports. One line of config. Playwright adapter included, more runners on the way.",
   "keywords": [
     "test-report",