@wdio/reporter 9.32.0 → 10.0.0-alpha.149

package/AGENTS.md

@@ -0,0 +1,55 @@
+# @wdio/reporter
+
+Base class for reporters. Concrete reporters (`wdio-spec-reporter`,
+`wdio-junit-reporter`, …) extend this package.
+
+## When to edit which package
+
+| Change | Package |
+|--------|---------|
+| Runner events, output path, base lifecycle | `@wdio/reporter` |
+| Spec / JUnit / Allure / … formatting | that reporter package |
+| How the runner constructs reporters | `@wdio/runner` |
+
+## Commands
+
+```sh
+pnpm run test:package wdio-reporter
+pnpm run test:package wdio-spec-reporter
+pnpm run test:smoke customReporterString
+pnpm run test:smoke customReporterObject
+pnpm run test:smoke reporterTestrunner
+```
+
+User-facing reporter docs are the package `README.md`, ingested by
+`infra/docs/src/packagesDocs.ts`.
+
+## Guardrails
+
+- New reporters: `pnpm run create` and extend `@wdio/reporter`.
+- Do not reach into `@wdio/runner` internals from a reporter. Consume the
+  documented event API only.
+- Smoke tests are the right proof for constructor / CLI string vs object
+  config; unit tests are enough for formatting helpers.
+
+## Spec reporter test ownership
+
+`packages/wdio-spec-reporter/tests/index.test.ts` owns spec formatting.
+Assert the written report. Do not lock private flags or `printCurrentStats`
+call shape.
+
+- `showPreface: false`, `onlyFailures`, and `sauceLabsSharableLinks: false`
+  must attach suites before asserting `write()`. Sauce job links also need
+  `runnerStat.instanceOptions`. An empty `write()` call list does not prove
+  the option. Default preface text belongs to the existing `printReport`
+  snapshots.
+- Console-log filtering goes through the patched `stdout.write`. Assigning
+  `_consoleOutput` does not exercise the `mwebdriver` exclusion.
+- Realtime reporting is the `reporterRealTime` payload on `process.send`.
+  The unit-test env var `WDIO_UNIT_TESTS` suppresses that send, so a test
+  of the payload has to unset it and restore it.
+- `getHeaderDisplay` does not print spec paths.
+- Default symbols and pass/fail/skip colors belong to the printed report.
+  Custom `symbols` belong on that same report. Keep the multi-remote
+  instance name `"app"`: combo formatting throws if that name is read as
+  an app capability.

package/build/index.cjs

@@ -164,8 +164,7 @@ function createSupportsColor(stream, options = {}) {
   return translateLevel(level);
 }
 var supportsColor = {
-  stdout: createSupportsColor({ isTTY: import_node_tty.default.isatty(1) }),
-  stderr: createSupportsColor({ isTTY: import_node_tty.default.isatty(2) })
+  stdout: createSupportsColor({ isTTY: import_node_tty.default.isatty(1) })
 };
 var supportsColor_default = supportsColor;
 
@@ -209,15 +208,15 @@ function sanitizeCaps(caps) {
   let result;
   result = caps["appium:deviceName"] || caps.deviceName ? [
     sanitizeString(caps.platformName),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps["appium:deviceName"] || caps.deviceName),
     sanitizeString(caps["appium:platformVersion"]),
     sanitizeString(caps["appium:app"])
   ] : [
     sanitizeString(caps.browserName),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps.version || caps.browserVersion),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps.platform || caps.platformName),
     sanitizeString(caps["appium:app"])
   ];
@@ -459,7 +458,7 @@ var RunnerStats = class extends RunnableStats {
   config;
   specs;
   sessionId;
-  isMultiremote;
+  isMultiRemote;
   instanceOptions;
   retry;
   failures;
@@ -473,7 +472,7 @@ var RunnerStats = class extends RunnableStats {
     this.config = runner.config;
     this.specs = runner.specs;
     this.sessionId = runner.sessionId;
-    this.isMultiremote = runner.isMultiremote;
+    this.isMultiRemote = runner.isMultiRemote;
     this.instanceOptions = runner.instanceOptions;
     this.retry = runner.retry;
   }

package/build/index.js

@@ -124,8 +124,7 @@ function createSupportsColor(stream, options = {}) {
   return translateLevel(level);
 }
 var supportsColor = {
-  stdout: createSupportsColor({ isTTY: tty.isatty(1) }),
-  stderr: createSupportsColor({ isTTY: tty.isatty(2) })
+  stdout: createSupportsColor({ isTTY: tty.isatty(1) })
 };
 var supportsColor_default = supportsColor;
 
@@ -169,15 +168,15 @@ function sanitizeCaps(caps) {
   let result;
   result = caps["appium:deviceName"] || caps.deviceName ? [
     sanitizeString(caps.platformName),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps["appium:deviceName"] || caps.deviceName),
     sanitizeString(caps["appium:platformVersion"]),
     sanitizeString(caps["appium:app"])
   ] : [
     sanitizeString(caps.browserName),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps.version || caps.browserVersion),
-    // @ts-expect-error outdated JSONWP capabilities
+    // @ts-expect-error legacy capability names
     sanitizeString(caps.platform || caps.platformName),
     sanitizeString(caps["appium:app"])
   ];
@@ -419,7 +418,7 @@ var RunnerStats = class extends RunnableStats {
   config;
   specs;
   sessionId;
-  isMultiremote;
+  isMultiRemote;
   instanceOptions;
   retry;
   failures;
@@ -433,7 +432,7 @@ var RunnerStats = class extends RunnableStats {
     this.config = runner.config;
     this.specs = runner.specs;
     this.sessionId = runner.sessionId;
-    this.isMultiremote = runner.isMultiremote;
+    this.isMultiRemote = runner.isMultiRemote;
     this.instanceOptions = runner.instanceOptions;
     this.retry = runner.retry;
   }

package/build/stats/runner.d.ts

@@ -11,7 +11,7 @@ export default class RunnerStats extends RunnableStats {
     config: Options.Testrunner;
     specs: string[];
     sessionId: string;
-    isMultiremote: boolean;
+    isMultiRemote: boolean;
     instanceOptions: Record<string, Options.WebdriverIO>;
     retry?: number;
     failures?: number;

package/build/supportsColor.d.ts

@@ -3,24 +3,6 @@
  *
  * This file was imported due to lacking support of CJS environments in the original package.
  */
-interface Options {
-    /**
-     * By default it is `true`, which instructs `supportsColor()` to sniff `process.argv`
-     * for the multitude of `--color` flags (see _Info_ below).
-     * If `false`, then `process.argv` is not considered when determining color support.
-     * @default true
-     */
-    sniffFlags?: boolean | undefined;
-    isTTY?: boolean | undefined;
-}
-export declare function createSupportsColor(stream: {
-    isTTY?: boolean;
-}, options?: Options): false | {
-    level: number;
-    hasBasic: boolean;
-    has256: boolean;
-    has16m: boolean;
-};
 declare const supportsColor: {
     stdout: boolean | {
         level: number;
@@ -28,12 +10,6 @@ declare const supportsColor: {
         has256: boolean;
         has16m: boolean;
     };
-    stderr: boolean | {
-        level: number;
-        hasBasic: boolean;
-        has256: boolean;
-        has16m: boolean;
-    };
 };
 export default supportsColor;
 //# sourceMappingURL=supportsColor.d.ts.map

package/build/supportsColor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"supportsColor.d.ts","sourceRoot":"","sources":["../src/supportsColor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAeH,UAAU,OAAO;IACb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AA4JD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,EAAE,OAAO,GAAE,OAAY;;;;;EAOrF;AAED,QAAA,MAAM,aAAa;;;;;;;;;;;;;CAGlB,CAAA;AAED,eAAe,aAAa,CAAA"}
+{"version":3,"file":"supportsColor.d.ts","sourceRoot":"","sources":["../src/supportsColor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA6LH,QAAA,MAAM,aAAa;;;;;;;CAElB,CAAA;AAED,eAAe,aAAa,CAAA"}

package/build/types.d.ts

@@ -18,12 +18,6 @@ export interface BeforeCommandArgs extends CommandArgs {
 }
 export interface AfterCommandArgs extends CommandArgs {
     result: unknown;
-    /**
-     * @deprecated Use `command` instead, moreover since the `onAfterCommand` was never called in the case of custom commands, it was breaking reports, and we do not emit this one in the fix!
-     *
-     * custom commands also send along the command name
-     */
-    name?: string;
 }
 export interface Argument {
     rows?: {

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,IAAI,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACjD,MAAM,EAAE,OAAO,CAAA;IAEf;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,EAAE,CAAA;KAClB,EAAE,CAAA;CACN"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,GAAG;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IAClD,IAAI,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACjD,MAAM,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,EAAE,CAAA;KAClB,EAAE,CAAA;CACN"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wdio/reporter",
-  "version": "9.32.0",
+  "version": "10.0.0-alpha.149+ce13bea83",
   "description": "A WebdriverIO utility to help reporting all events",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-reporter",
   "license": "MIT",
   "engines": {
-    "node": ">=18.20.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",
@@ -35,20 +35,18 @@
       "require": "./build/index.cjs"
     }
   },
-  "typeScriptVersion": "3.8.3",
+  "typeScriptVersion": "6.0.3",
   "dependencies": {
-    "@types/node": "^20.1.0",
-    "@wdio/logger": "9.29.1",
-    "@wdio/types": "9.32.0",
-    "diff": "^8.0.2",
+    "@types/node": "^22.20.4",
+    "@wdio/types": "10.0.0-alpha.149+ce13bea83",
+    "diff": "^8.0.4",
     "object-inspect": "^1.12.0"
   },
   "devDependencies": {
     "@types/diff": "^8.0.0",
     "@types/object-inspect": "^1.8.1",
-    "@types/supports-color": "^8.1.1",
     "@types/tmp": "^0.2.3",
-    "tmp": "^0.2.1"
+    "tmp": "^0.2.7"
   },
-  "gitHead": "5c2a318d9a5e8424a2f2de95df9374b89bda7936"
+  "gitHead": "ce13bea839fb037eceda429dbf94cd387b7c3584"
 }