@flakiness/playwright 1.3.3 → 1.5.0

package/README.md

@@ -17,6 +17,7 @@ A custom Playwright test reporter that generates Flakiness Reports from your Pla
   - [CI Integration](#ci-integration)
 - [Configuration Options](#configuration-options)
   - [`flakinessProject?: string`](#flakinessproject-string)
+  - [`title?: string`](#title-string)
   - [`endpoint?: string`](#endpoint-string)
   - [`token?: string`](#token-string)
   - [`outputFolder?: string`](#outputfolder-string)
@@ -145,6 +146,16 @@ reporter: [
 ]
 ```
 
+### `title?: string`
+
+Optional human-readable report title. Typically used to name a CI run, matrix shard, or other execution group. Defaults to the `FLAKINESS_TITLE` environment variable if set, or is auto-detected from the CI environment (e.g. GitHub Actions workflow name).
+
+```typescript
+reporter: [
+  ['@flakiness/playwright', { title: 'Shard 1/4 — Linux Chrome' }]
+]
+```
+
 ### `endpoint?: string`
 
 Custom Flakiness.io endpoint URL for uploading reports. Defaults to the `FLAKINESS_ENDPOINT` environment variable, or `https://flakiness.io` if not set.
@@ -222,6 +233,7 @@ The reporter respects the following environment variables:
 - **`FLAKINESS_ACCESS_TOKEN`**: Access token for Flakiness.io uploads (equivalent to `token` option)
 - **`FLAKINESS_ENDPOINT`**: Custom Flakiness.io endpoint URL (equivalent to `endpoint` option)
 - **`FLAKINESS_OUTPUT_DIR`**: Output directory for reports (equivalent to `outputFolder` option)
+- **`FLAKINESS_TITLE`**: Report title (equivalent to `title` option)
 - **`FLAKINESS_DISABLE_UPLOAD`**: When set, disables report upload (equivalent to `disableUpload` option)
 
 
@@ -237,6 +249,7 @@ export default defineConfig({
   reporter: [
     ['@flakiness/playwright', {
       flakinessProject: 'my-org/my-project',
+      title: 'My Test Run',
       endpoint: process.env.FLAKINESS_ENDPOINT,
       token: process.env.FLAKINESS_ACCESS_TOKEN,
       outputFolder: './flakiness-report',
@@ -248,4 +261,3 @@ export default defineConfig({
   // ... rest of your config
 });
 ```
-

package/lib/playwright-test.js

@@ -3,16 +3,18 @@ import {
   GitWorktree,
   ReportUtils,
   showReport,
+  showReportCommand,
   CPUUtilization,
   RAMUtilization,
   uploadReport,
   writeReport
 } from "@flakiness/sdk";
-import chalk from "chalk";
-import fs from "fs";
-import path from "path";
-const warn = (txt) => console.warn(chalk.yellow(`[flakiness.io] ${txt}`));
-const err = (txt) => console.error(chalk.red(`[flakiness.io] ${txt}`));
+import fs from "node:fs";
+import path from "node:path";
+import * as nodeUtil from "node:util";
+const styleText = (format, text) => nodeUtil.styleText?.(format, text) ?? text;
+const warn = (txt) => console.warn(styleText("yellow", `[flakiness.io] ${txt}`));
+const err = (txt) => console.error(styleText("red", `[flakiness.io] ${txt}`));
 const log = (txt) => console.log(`[flakiness.io] ${txt}`);
 function parseDurationMS(value) {
   if (isNaN(value))
@@ -228,8 +230,10 @@ class FlakinessReporter {
     const environments = [...environmentsMap.values()];
     for (let envIdx = 0; envIdx < environments.length; ++envIdx)
       context.project2environmentIdx.set(this._config.projects[envIdx], envIdx);
+    const title = this._options.title ?? process.env.FLAKINESS_TITLE ?? CIUtils.runTitle();
     const report = ReportUtils.normalizeReport({
       flakinessProject: this._options.flakinessProject,
+      title,
       category: "playwright",
       commitId,
       relatedCommitIds: [],
@@ -265,12 +269,11 @@ class FlakinessReporter {
     if (shouldOpen) {
       await showReport(this._outputFolder);
     } else {
-      const defaultOutputFolder = path.join(process.cwd(), "flakiness-report");
-      const folder = defaultOutputFolder === this._outputFolder ? "" : path.relative(process.cwd(), this._outputFolder);
+      const command = showReportCommand(this._outputFolder);
       console.log(`
 To open last Flakiness report, run:
 
-  ${chalk.cyan(`npx flakiness show ${folder}`)}
+  ${styleText("cyan", command)}
       `);
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/playwright",
-  "version": "1.3.3",
+  "version": "1.5.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -37,9 +37,8 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.28.0",
-    "@flakiness/sdk": "2.2.2",
-    "chalk": "^5.6.2"
+    "@flakiness/flakiness-report": "^0.29.0",
+    "@flakiness/sdk": "2.5.0"
   },
   "scripts": {
     "build": "kubik build.mts",

package/types/src/playwright-test.d.ts

@@ -15,6 +15,7 @@ export default class FlakinessReporter implements Reporter {
     private _telemetryTimer?;
     constructor(_options?: {
         flakinessProject?: string;
+        title?: string;
         endpoint?: string;
         token?: string;
         outputFolder?: string;

package/types/src/playwright-test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playwright-test.d.ts","sourceRoot":"","sources":["../../src/playwright-test.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACV,UAAU,EAEV,UAAU,EAEV,QAAQ,EACR,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAEvC,MAAM,2BAA2B,CAAC;AA6BnC,KAAK,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,QAAQ;IAgB5C,OAAO,CAAC,QAAQ;IAf5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,mBAAmB,CAAmB;IAE9C,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,OAAO,CAAC,CAAY;IAC5B,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAa;IAE7B,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAErB,QAAQ,GAAE;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,aAAa,CAAC,EAAE,OAAO,CAAC;KACpB;IAON,OAAO,CAAC,aAAa;IAMrB,aAAa,IAAI,OAAO;IAIxB,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAKxC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI/B,WAAW,CAAC,IAAI,EAAE,QAAQ;IAG1B,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;YAM9B,WAAW;YAsBX,SAAS;YAWT,eAAe;IAmD7B,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,cAAc;IAUhB,KAAK,CAAC,MAAM,EAAE,UAAU;IAkGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA6B9B"}
+{"version":3,"file":"playwright-test.d.ts","sourceRoot":"","sources":["../../src/playwright-test.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACV,UAAU,EAEV,UAAU,EAEV,QAAQ,EACR,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAEvC,MAAM,2BAA2B,CAAC;AAgCnC,KAAK,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,QAAQ;IAgB5C,OAAO,CAAC,QAAQ;IAf5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,mBAAmB,CAAmB;IAE9C,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,OAAO,CAAC,CAAY;IAC5B,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAa;IAE7B,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAErB,QAAQ,GAAE;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,aAAa,CAAC,EAAE,OAAO,CAAC;KACpB;IAON,OAAO,CAAC,aAAa;IAMrB,aAAa,IAAI,OAAO;IAIxB,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAKxC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI/B,WAAW,CAAC,IAAI,EAAE,QAAQ;IAG1B,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;YAM9B,WAAW;YAsBX,SAAS;YAWT,eAAe;IAmD7B,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,cAAc;IAUhB,KAAK,CAAC,MAAM,EAAE,UAAU;IAoGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA4B9B"}