@flakiness/cucumberjs 1.0.1 → 1.1.1

package/README.md

@@ -55,7 +55,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 +86,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:
@@ -189,7 +194,10 @@ 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',
     endpoint: process.env.FLAKINESS_ENDPOINT,

package/lib/formatter.js

@@ -6,12 +6,18 @@ import {
   GitWorktree,
   RAMUtilization,
   ReportUtils,
+  showReportCommand,
   uploadReport,
   writeReport
 } from "@flakiness/sdk";
 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;
@@ -97,20 +103,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 defaultOutputFolder = path.join(this.cwd, "flakiness-report");
-    const folder = defaultOutputFolder === this._outputFolder ? "" : path.relative(this.cwd, this._outputFolder);
-    this.log(`
-To open last Flakiness report, run:
-
-  npx flakiness show ${folder}
-`);
   }
   async _collectSuites(worktree) {
     const suitesByKey = /* @__PURE__ */ new Map();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/cucumberjs",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/flakiness/cucumberjs.git"
@@ -21,12 +21,12 @@
   "type": "module",
   "dependencies": {
     "@flakiness/flakiness-report": "^0.28.0",
-    "@flakiness/sdk": "^2.2.2"
+    "@flakiness/sdk": "^2.4.0"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^12.7.0",
     "@cucumber/messages": "^32.2.0",
-    "@flakiness/cucumberjs": "1.0.0-alpha.1",
+    "@flakiness/cucumberjs": "1.0.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;AAiDjE,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;YAsDlB,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;AAuDjE,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"}