reporting-labs 0.4.3 → 0.5.0

package/README.md

@@ -46,9 +46,10 @@ 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' }]]`.
@@ -84,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
@@ -298,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

@@ -35,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/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.3",
+  "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",