From e8bdb375b678b6988d67214003edd20b6a2f08b6 Mon Sep 17 00:00:00 2001
From: Tian Feng <tian.feng@saucelabs.com>
Date: Thu, 21 Nov 2024 22:48:56 -0800
Subject: [PATCH] add notes

---
 src/cucumber-runner.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/cucumber-runner.ts b/src/cucumber-runner.ts
index 5b3d7d7..40ce663 100644
--- a/src/cucumber-runner.ts
+++ b/src/cucumber-runner.ts
@@ -18,6 +18,11 @@ export function buildArgs(runCfg: CucumberRunnerConfig, cucumberBin: string) {
     '--force-exit',
     '--require-module',
     'ts-node/register',
+    // NOTE: Cucumber only supports a single stdout formatter. If multiple stdout
+    // formatters are specified, Cucumber will use the last one provided.
+    // To ensure the sauce test report file is always generated, redirect the output to
+    // sauce-test-report.json using the --format argument and specify the outputFile
+    // in --format-options simultaneously.
     '--format',
     '"@saucelabs/cucumber-reporter":"sauce-test-report.json"',
     '--format-options',