@flakiness/cucumberjs 1.1.0 → 1.2.0

package/README.md

@@ -30,6 +30,7 @@ A custom CucumberJS formatter that generates Flakiness Reports from your Cucumbe
   - [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)
@@ -55,7 +56,10 @@ Add the formatter to your `cucumber.mjs`:
 export default {
   paths: ['features/**/*.feature'],
   import: ['features/support/**/*.ts'],
-  format: ['@flakiness/cucumberjs', 'progress'],
+  format: [
+    'progress',
+    ['@flakiness/cucumberjs', '.flakiness/cucumber-formatter.log'],
+  ],
   formatOptions: {
     flakinessProject: 'my-org/my-project',
   },
@@ -83,6 +87,8 @@ Reports are automatically uploaded to Flakiness.io after test completion. Authen
 
 If upload fails, the report is still available locally in the output folder.
 
+If you combine this formatter with a progress formatter, keep the progress formatter on `stdout` and redirect `@flakiness/cucumberjs` to a file as shown above. Upload status messages are printed to `stderr`, so the uploaded report URL stays visible in the terminal.
+
 ## Viewing Reports
 
 After test execution, you can view the report using:
@@ -137,6 +143,18 @@ formatOptions: {
 }
 ```
 
+### `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, or auto-detects from the CI environment if not set.
+
+```javascript
+formatOptions: {
+  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.
@@ -189,9 +207,13 @@ Here's a complete example with all options:
 export default {
   paths: ['features/**/*.feature'],
   import: ['features/support/**/*.ts'],
-  format: ['@flakiness/cucumberjs', 'progress'],
+  format: [
+    'progress',
+    ['@flakiness/cucumberjs', '.flakiness/cucumber-formatter.log'],
+  ],
   formatOptions: {
     flakinessProject: 'my-org/my-project',
+    title: 'My Test Run',
     endpoint: process.env.FLAKINESS_ENDPOINT,
     token: process.env.FLAKINESS_ACCESS_TOKEN,
     outputFolder: './flakiness-report',

package/lib/formatter.js

@@ -13,6 +13,11 @@ import {
 import fs from "node:fs";
 import path from "node:path";
 const CUCUMBER_LOG_MEDIA_TYPE = "text/x.cucumber.log+plain";
+const STDERR_LOGGER = {
+  log: (...args) => console.error(...args),
+  warn: (...args) => console.error(...args),
+  error: (...args) => console.error(...args)
+};
 class FlakinessCucumberFormatter extends Formatter {
   static documentation = "Generates a Flakiness report for a CucumberJS run.";
   _config;
@@ -80,6 +85,7 @@ class FlakinessCucumberFormatter extends Formatter {
       return;
     }
     const { attachments, suites } = await this._collectSuites(worktree);
+    const title = this._config.title ?? process.env.FLAKINESS_TITLE ?? CIUtils.runTitle();
     const report = ReportUtils.normalizeReport({
       category: "cucumberjs",
       commitId,
@@ -90,6 +96,7 @@ class FlakinessCucumberFormatter extends Formatter {
         })
       ],
       flakinessProject: this._config.flakinessProject,
+      title,
       suites,
       startTimestamp: this._startTimestamp,
       url: CIUtils.runUrl()
@@ -98,19 +105,20 @@ class FlakinessCucumberFormatter extends Formatter {
     this._cpuUtilization.enrich(report);
     this._ramUtilization.enrich(report);
     await writeReport(report, attachments, this._outputFolder);
+    const command = showReportCommand(this._outputFolder);
+    console.error(`
+To open last Flakiness report, run:
+
+  ${command}
+`);
     const disableUpload = this._config.disableUpload ?? envBool("FLAKINESS_DISABLE_UPLOAD");
     if (!disableUpload) {
       await uploadReport(report, attachments, {
         flakinessAccessToken: this._config.token,
-        flakinessEndpoint: this._config.endpoint
+        flakinessEndpoint: this._config.endpoint,
+        logger: STDERR_LOGGER
       });
     }
-    const command = showReportCommand(this._outputFolder);
-    this.log(`
-To open last Flakiness report, run:
-
-  ${command}
-`);
   }
   async _collectSuites(worktree) {
     const suitesByKey = /* @__PURE__ */ new Map();
@@ -193,6 +201,7 @@ function parseFormatterConfig(parsedArgvOptions) {
     endpoint: typeof parsedArgvOptions.endpoint === "string" ? parsedArgvOptions.endpoint : void 0,
     flakinessProject: typeof parsedArgvOptions.flakinessProject === "string" ? parsedArgvOptions.flakinessProject : void 0,
     outputFolder: typeof parsedArgvOptions.outputFolder === "string" ? parsedArgvOptions.outputFolder : void 0,
+    title: typeof parsedArgvOptions.title === "string" ? parsedArgvOptions.title : void 0,
     token: typeof parsedArgvOptions.token === "string" ? parsedArgvOptions.token : void 0
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/cucumberjs",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/flakiness/cucumberjs.git"
@@ -20,13 +20,13 @@
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.28.0",
-    "@flakiness/sdk": "^2.4.0"
+    "@flakiness/flakiness-report": "^0.29.0",
+    "@flakiness/sdk": "^2.5.0"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^12.7.0",
     "@cucumber/messages": "^32.2.0",
-    "@flakiness/cucumberjs": "1.0.1",
+    "@flakiness/cucumberjs": "1.1.1",
     "@types/node": "^25.5.0",
     "c8": "^11.0.0",
     "esbuild": "^0.27.4",

package/types/src/formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAoB,MAAM,oBAAoB,CAAC;AAkDjE,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;IAC/D,MAAM,CAAC,aAAa,SAAwD;IAE5E,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAoC;IAC3D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,oBAAoB,CAAsC;IAClE,OAAO,CAAC,qBAAqB,CAAuC;gBAExD,OAAO,EAAE,iBAAiB;IA0BtC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAIZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAaxC,OAAO,CAAC,aAAa;YAMP,kBAAkB;YAqDlB,cAAc;CA4F7B"}
+{"version":3,"file":"formatter.d.ts","sourceRoot":"","sources":["../../src/formatter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAoB,MAAM,oBAAoB,CAAC;AAwDjE,MAAM,CAAC,OAAO,OAAO,0BAA2B,SAAQ,SAAS;IAC/D,MAAM,CAAC,aAAa,SAAwD;IAE5E,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAoC;IAC3D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,OAAO,CAAC,gBAAgB,CAAuB;IAC/C,OAAO,CAAC,oBAAoB,CAAsC;IAClE,OAAO,CAAC,qBAAqB,CAAuC;gBAExD,OAAO,EAAE,iBAAiB;IA0BtC,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAIZ,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAaxC,OAAO,CAAC,aAAa;YAMP,kBAAkB;YAuDlB,cAAc;CA4F7B"}