@testpulse.run/playwright-console-reporter 0.2.3

package/README.md

@@ -0,0 +1,67 @@
+<p align="center">
+  <a href="https://testpulse.run">
+    <img src="https://testpulse.run/images/logo-testpulse.svg" alt="TestPulse.run" height="48">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://testpulse.run">testpulse.run</a>
+</p>
+
+# @testpulse.run/playwright-console-reporter
+
+Console reporter for Playwright built on the TestPulse reporter event pipeline.
+
+Use this package when you want a compact terminal reporter that prints test progress, stdout/stderr, failures, retries, and the final run summary.
+
+## Installation
+
+```sh
+npm install -D @testpulse.run/playwright-console-reporter @playwright/test
+```
+
+## Playwright Configuration
+
+```ts
+import { defineConfig } from "@playwright/test";
+
+export default defineConfig({
+  reporter: [["@testpulse.run/playwright-console-reporter"]]
+});
+```
+
+You can combine it with other reporters:
+
+```ts
+export default defineConfig({
+  reporter: [
+    ["@testpulse.run/playwright-console-reporter"],
+    ["html"]
+  ]
+});
+```
+
+## Options
+
+```ts
+export default defineConfig({
+  reporter: [
+    [
+      "@testpulse.run/playwright-console-reporter",
+      {
+        color: "auto",
+        verbose: false
+      }
+    ]
+  ]
+});
+```
+
+- `color`: `true`, `false`, or `"auto"`; defaults to automatic TTY detection.
+- `verbose`: prints test start lines in addition to completion lines.
+
+## Related Packages
+
+- `@testpulse.run/reporter`: sends Playwright events to TestPulse.
+- `@testpulse.run/playwright-jsonl-reporter`: writes Playwright events as JSONL.
+- `@testpulse.run/playwright-core`: lower-level reporter event adapter.

package/dist/index.cjs

@@ -0,0 +1,242 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ConsoleReporter: () => ConsoleReporter,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_playwright_core = require("@testpulse.run/playwright-core");
+var import_playwright_events = require("@testpulse.run/playwright-events");
+
+// src/format.ts
+function createColorizer(enabled) {
+  const color = (code, value) => enabled ? `\x1B[${code}m${value}\x1B[0m` : value;
+  return {
+    green: (value) => color(32, value),
+    red: (value) => color(31, value),
+    yellow: (value) => color(33, value),
+    gray: (value) => color(90, value)
+  };
+}
+function formatTestTitle(test) {
+  const location = test.location ? `${test.location.file}:${test.location.line}:${test.location.column}` : "";
+  const path = test.titlePath.length > 0 ? test.titlePath : [test.title];
+  const title = path.filter(Boolean).join(" \u203A ");
+  return location ? `${location} \u203A ${title}` : title;
+}
+function formatDuration(durationMs) {
+  if (durationMs < 1e3) {
+    return `${Math.round(durationMs)}ms`;
+  }
+  return `${(durationMs / 1e3).toFixed(1)}s`;
+}
+function statusSymbol(status) {
+  switch (status) {
+    case "passed":
+      return "ok";
+    case "skipped":
+      return "-";
+    case "timedOut":
+      return "timeout";
+    case "interrupted":
+      return "interrupted";
+    case "failed":
+    default:
+      return "x";
+  }
+}
+function colorStatus(status, value, colors) {
+  switch (status) {
+    case "passed":
+      return colors.green(value);
+    case "skipped":
+      return colors.yellow(value);
+    case "failed":
+    case "timedOut":
+    case "interrupted":
+      return colors.red(value);
+  }
+}
+
+// src/index.ts
+var ConsoleReporter = class {
+  core;
+  events;
+  output;
+  errorOutput;
+  colors;
+  verbose;
+  totalTests = 0;
+  nextTestOrdinal = 1;
+  testOrdinals = /* @__PURE__ */ new Map();
+  outcomes = {
+    passed: 0,
+    failed: 0,
+    flaky: 0,
+    skipped: 0,
+    interrupted: 0,
+    timedOut: 0
+  };
+  suite;
+  config;
+  constructor(options = {}) {
+    this.output = options.output ?? process.stdout;
+    this.errorOutput = options.errorOutput ?? process.stderr;
+    this.verbose = options.verbose ?? false;
+    const shouldColor = options.color === true || options.color !== false && Boolean(this.output.isTTY);
+    this.colors = createColorizer(shouldColor);
+    const consolePlugin = {
+      name: "@testpulse.run/playwright-console-reporter",
+      RunStarted: (event) => this.onRunStarted(event),
+      TestStarted: (event) => this.onTestStarted(event),
+      StdOutReceived: (event) => this.onStdOutReceived(event),
+      StdErrReceived: (event) => this.onStdErrReceived(event),
+      RunFinished: (event) => this.onRunFinished(event)
+    };
+    const derivedPlugin = {
+      name: "@testpulse.run/playwright-console-reporter",
+      TestAttemptFinished: (event) => this.onTestAttemptFinished(event),
+      TestOutcomeResolved: (event) => this.onTestOutcomeResolved(event)
+    };
+    this.events = new import_playwright_events.PlaywrightEvents({ plugins: [derivedPlugin] });
+    this.core = new import_playwright_core.TestPulseReporterCore({ plugins: [this.events.asCorePlugin(), consolePlugin] });
+    this.events.setErrorSink(this.core);
+  }
+  printsToStdio() {
+    return true;
+  }
+  onBegin(config, suite) {
+    this.config = config;
+    this.suite = suite;
+    this.core.onBegin(config, suite);
+  }
+  onEnd(result) {
+    return this.core.onEnd(result);
+  }
+  onError(...args) {
+    this.core.onError(...args);
+  }
+  onTestBegin(...args) {
+    this.core.onTestBegin(...args);
+  }
+  onTestEnd(...args) {
+    this.core.onTestEnd(...args);
+  }
+  onStepBegin(...args) {
+    this.core.onStepBegin(...args);
+  }
+  onStepEnd(...args) {
+    this.core.onStepEnd(...args);
+  }
+  onStdOut(...args) {
+    this.core.onStdOut(...args);
+  }
+  onStdErr(...args) {
+    this.core.onStdErr(...args);
+  }
+  onRunStarted(event) {
+    this.totalTests = event.totalTests;
+    this.nextTestOrdinal = 1;
+    this.testOrdinals.clear();
+    this.outcomes = {
+      passed: 0,
+      failed: 0,
+      flaky: 0,
+      skipped: 0,
+      interrupted: 0,
+      timedOut: 0
+    };
+    const workers = this.config?.workers ?? 1;
+    this.writeLine(`Running ${event.totalTests} test${event.totalTests === 1 ? "" : "s"} using ${workers} worker${workers === 1 ? "" : "s"}`);
+  }
+  onTestStarted(event) {
+    if (!this.verbose) {
+      return;
+    }
+    this.writeLine(`[${this.getTestOrdinal(event.test.testId ?? event.titlePath.join(" \u203A "))}/${this.totalTests}] ${formatTestTitle(event.test)}`);
+  }
+  onTestAttemptFinished(event) {
+    const testOrdinal = this.getTestOrdinal(event.testId);
+    const marker = colorStatus(event.status, statusSymbol(event.status), this.colors);
+    const duration = this.colors.gray(formatDuration(event.attempt.durationMs));
+    const retry = event.retry > 0 ? this.colors.gray(` retry #${event.retry}`) : "";
+    this.writeLine(`${marker} ${testOrdinal} ${formatTestTitle(event.test)} (${duration})`);
+    if (retry) {
+      this.writeLine(`  ${retry}`);
+    }
+    if (event.attempt.errors[0]) {
+      this.writeLine(`  ${event.attempt.errors[0].message ?? String(event.attempt.errors[0])}`);
+    }
+  }
+  onTestOutcomeResolved(event) {
+    this.outcomes[event.outcome] += 1;
+  }
+  onStdOutReceived(event) {
+    this.output.write(event.text);
+  }
+  onStdErrReceived(event) {
+    this.errorOutput.write(event.text);
+  }
+  onRunFinished(event) {
+    const parts = [];
+    if (this.outcomes.failed > 0) {
+      parts.push(this.colors.red(`${this.outcomes.failed} failed`));
+    }
+    if (this.outcomes.timedOut > 0) {
+      parts.push(this.colors.red(`${this.outcomes.timedOut} timed out`));
+    }
+    if (this.outcomes.interrupted > 0) {
+      parts.push(this.colors.red(`${this.outcomes.interrupted} interrupted`));
+    }
+    if (this.outcomes.flaky > 0) {
+      parts.push(this.colors.yellow(`${this.outcomes.flaky} flaky`));
+    }
+    if (this.outcomes.passed > 0) {
+      parts.push(this.colors.green(`${this.outcomes.passed} passed`));
+    }
+    if (this.outcomes.skipped > 0) {
+      parts.push(this.colors.yellow(`${this.outcomes.skipped} skipped`));
+    }
+    const summary = parts.length > 0 ? parts.join(", ") : event.result.status;
+    this.writeLine(`
+${summary}`);
+  }
+  writeLine(value) {
+    this.output.write(`${value}
+`);
+  }
+  getTestOrdinal(testId) {
+    const existing = this.testOrdinals.get(testId);
+    if (existing) {
+      return existing;
+    }
+    const ordinal = this.nextTestOrdinal;
+    this.nextTestOrdinal += 1;
+    this.testOrdinals.set(testId, ordinal);
+    return ordinal;
+  }
+};
+var index_default = ConsoleReporter;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConsoleReporter
+});

package/dist/index.d.cts

@@ -0,0 +1,45 @@
+import { Reporter, FullConfig, Suite, FullResult } from '@playwright/test/reporter';
+import { TestPulseReporterCore } from '@testpulse.run/playwright-core';
+
+interface ConsoleReporterOptions {
+    output?: NodeJS.WritableStream;
+    errorOutput?: NodeJS.WritableStream;
+    color?: boolean | "auto";
+    verbose?: boolean;
+}
+declare class ConsoleReporter implements Reporter {
+    private readonly core;
+    private readonly events;
+    private readonly output;
+    private readonly errorOutput;
+    private readonly colors;
+    private readonly verbose;
+    private totalTests;
+    private nextTestOrdinal;
+    private readonly testOrdinals;
+    private outcomes;
+    private suite?;
+    private config?;
+    constructor(options?: ConsoleReporterOptions);
+    printsToStdio(): boolean;
+    onBegin(config: FullConfig, suite: Suite): void;
+    onEnd(result: FullResult): ReturnType<TestPulseReporterCore["onEnd"]>;
+    onError(...args: Parameters<TestPulseReporterCore["onError"]>): void;
+    onTestBegin(...args: Parameters<TestPulseReporterCore["onTestBegin"]>): void;
+    onTestEnd(...args: Parameters<TestPulseReporterCore["onTestEnd"]>): void;
+    onStepBegin(...args: Parameters<TestPulseReporterCore["onStepBegin"]>): void;
+    onStepEnd(...args: Parameters<TestPulseReporterCore["onStepEnd"]>): void;
+    onStdOut(...args: Parameters<TestPulseReporterCore["onStdOut"]>): void;
+    onStdErr(...args: Parameters<TestPulseReporterCore["onStdErr"]>): void;
+    private onRunStarted;
+    private onTestStarted;
+    private onTestAttemptFinished;
+    private onTestOutcomeResolved;
+    private onStdOutReceived;
+    private onStdErrReceived;
+    private onRunFinished;
+    private writeLine;
+    private getTestOrdinal;
+}
+
+export { ConsoleReporter, type ConsoleReporterOptions, ConsoleReporter as default };

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import { Reporter, FullConfig, Suite, FullResult } from '@playwright/test/reporter';
+import { TestPulseReporterCore } from '@testpulse.run/playwright-core';
+
+interface ConsoleReporterOptions {
+    output?: NodeJS.WritableStream;
+    errorOutput?: NodeJS.WritableStream;
+    color?: boolean | "auto";
+    verbose?: boolean;
+}
+declare class ConsoleReporter implements Reporter {
+    private readonly core;
+    private readonly events;
+    private readonly output;
+    private readonly errorOutput;
+    private readonly colors;
+    private readonly verbose;
+    private totalTests;
+    private nextTestOrdinal;
+    private readonly testOrdinals;
+    private outcomes;
+    private suite?;
+    private config?;
+    constructor(options?: ConsoleReporterOptions);
+    printsToStdio(): boolean;
+    onBegin(config: FullConfig, suite: Suite): void;
+    onEnd(result: FullResult): ReturnType<TestPulseReporterCore["onEnd"]>;
+    onError(...args: Parameters<TestPulseReporterCore["onError"]>): void;
+    onTestBegin(...args: Parameters<TestPulseReporterCore["onTestBegin"]>): void;
+    onTestEnd(...args: Parameters<TestPulseReporterCore["onTestEnd"]>): void;
+    onStepBegin(...args: Parameters<TestPulseReporterCore["onStepBegin"]>): void;
+    onStepEnd(...args: Parameters<TestPulseReporterCore["onStepEnd"]>): void;
+    onStdOut(...args: Parameters<TestPulseReporterCore["onStdOut"]>): void;
+    onStdErr(...args: Parameters<TestPulseReporterCore["onStdErr"]>): void;
+    private onRunStarted;
+    private onTestStarted;
+    private onTestAttemptFinished;
+    private onTestOutcomeResolved;
+    private onStdOutReceived;
+    private onStdErrReceived;
+    private onRunFinished;
+    private writeLine;
+    private getTestOrdinal;
+}
+
+export { ConsoleReporter, type ConsoleReporterOptions, ConsoleReporter as default };

package/dist/index.js

@@ -0,0 +1,221 @@
+// src/index.ts
+import {
+  TestPulseReporterCore
+} from "@testpulse.run/playwright-core";
+import {
+  PlaywrightEvents
+} from "@testpulse.run/playwright-events";
+
+// src/format.ts
+function createColorizer(enabled) {
+  const color = (code, value) => enabled ? `\x1B[${code}m${value}\x1B[0m` : value;
+  return {
+    green: (value) => color(32, value),
+    red: (value) => color(31, value),
+    yellow: (value) => color(33, value),
+    gray: (value) => color(90, value)
+  };
+}
+function formatTestTitle(test) {
+  const location = test.location ? `${test.location.file}:${test.location.line}:${test.location.column}` : "";
+  const path = test.titlePath.length > 0 ? test.titlePath : [test.title];
+  const title = path.filter(Boolean).join(" \u203A ");
+  return location ? `${location} \u203A ${title}` : title;
+}
+function formatDuration(durationMs) {
+  if (durationMs < 1e3) {
+    return `${Math.round(durationMs)}ms`;
+  }
+  return `${(durationMs / 1e3).toFixed(1)}s`;
+}
+function statusSymbol(status) {
+  switch (status) {
+    case "passed":
+      return "ok";
+    case "skipped":
+      return "-";
+    case "timedOut":
+      return "timeout";
+    case "interrupted":
+      return "interrupted";
+    case "failed":
+    default:
+      return "x";
+  }
+}
+function colorStatus(status, value, colors) {
+  switch (status) {
+    case "passed":
+      return colors.green(value);
+    case "skipped":
+      return colors.yellow(value);
+    case "failed":
+    case "timedOut":
+    case "interrupted":
+      return colors.red(value);
+  }
+}
+
+// src/index.ts
+var ConsoleReporter = class {
+  core;
+  events;
+  output;
+  errorOutput;
+  colors;
+  verbose;
+  totalTests = 0;
+  nextTestOrdinal = 1;
+  testOrdinals = /* @__PURE__ */ new Map();
+  outcomes = {
+    passed: 0,
+    failed: 0,
+    flaky: 0,
+    skipped: 0,
+    interrupted: 0,
+    timedOut: 0
+  };
+  suite;
+  config;
+  constructor(options = {}) {
+    this.output = options.output ?? process.stdout;
+    this.errorOutput = options.errorOutput ?? process.stderr;
+    this.verbose = options.verbose ?? false;
+    const shouldColor = options.color === true || options.color !== false && Boolean(this.output.isTTY);
+    this.colors = createColorizer(shouldColor);
+    const consolePlugin = {
+      name: "@testpulse.run/playwright-console-reporter",
+      RunStarted: (event) => this.onRunStarted(event),
+      TestStarted: (event) => this.onTestStarted(event),
+      StdOutReceived: (event) => this.onStdOutReceived(event),
+      StdErrReceived: (event) => this.onStdErrReceived(event),
+      RunFinished: (event) => this.onRunFinished(event)
+    };
+    const derivedPlugin = {
+      name: "@testpulse.run/playwright-console-reporter",
+      TestAttemptFinished: (event) => this.onTestAttemptFinished(event),
+      TestOutcomeResolved: (event) => this.onTestOutcomeResolved(event)
+    };
+    this.events = new PlaywrightEvents({ plugins: [derivedPlugin] });
+    this.core = new TestPulseReporterCore({ plugins: [this.events.asCorePlugin(), consolePlugin] });
+    this.events.setErrorSink(this.core);
+  }
+  printsToStdio() {
+    return true;
+  }
+  onBegin(config, suite) {
+    this.config = config;
+    this.suite = suite;
+    this.core.onBegin(config, suite);
+  }
+  onEnd(result) {
+    return this.core.onEnd(result);
+  }
+  onError(...args) {
+    this.core.onError(...args);
+  }
+  onTestBegin(...args) {
+    this.core.onTestBegin(...args);
+  }
+  onTestEnd(...args) {
+    this.core.onTestEnd(...args);
+  }
+  onStepBegin(...args) {
+    this.core.onStepBegin(...args);
+  }
+  onStepEnd(...args) {
+    this.core.onStepEnd(...args);
+  }
+  onStdOut(...args) {
+    this.core.onStdOut(...args);
+  }
+  onStdErr(...args) {
+    this.core.onStdErr(...args);
+  }
+  onRunStarted(event) {
+    this.totalTests = event.totalTests;
+    this.nextTestOrdinal = 1;
+    this.testOrdinals.clear();
+    this.outcomes = {
+      passed: 0,
+      failed: 0,
+      flaky: 0,
+      skipped: 0,
+      interrupted: 0,
+      timedOut: 0
+    };
+    const workers = this.config?.workers ?? 1;
+    this.writeLine(`Running ${event.totalTests} test${event.totalTests === 1 ? "" : "s"} using ${workers} worker${workers === 1 ? "" : "s"}`);
+  }
+  onTestStarted(event) {
+    if (!this.verbose) {
+      return;
+    }
+    this.writeLine(`[${this.getTestOrdinal(event.test.testId ?? event.titlePath.join(" \u203A "))}/${this.totalTests}] ${formatTestTitle(event.test)}`);
+  }
+  onTestAttemptFinished(event) {
+    const testOrdinal = this.getTestOrdinal(event.testId);
+    const marker = colorStatus(event.status, statusSymbol(event.status), this.colors);
+    const duration = this.colors.gray(formatDuration(event.attempt.durationMs));
+    const retry = event.retry > 0 ? this.colors.gray(` retry #${event.retry}`) : "";
+    this.writeLine(`${marker} ${testOrdinal} ${formatTestTitle(event.test)} (${duration})`);
+    if (retry) {
+      this.writeLine(`  ${retry}`);
+    }
+    if (event.attempt.errors[0]) {
+      this.writeLine(`  ${event.attempt.errors[0].message ?? String(event.attempt.errors[0])}`);
+    }
+  }
+  onTestOutcomeResolved(event) {
+    this.outcomes[event.outcome] += 1;
+  }
+  onStdOutReceived(event) {
+    this.output.write(event.text);
+  }
+  onStdErrReceived(event) {
+    this.errorOutput.write(event.text);
+  }
+  onRunFinished(event) {
+    const parts = [];
+    if (this.outcomes.failed > 0) {
+      parts.push(this.colors.red(`${this.outcomes.failed} failed`));
+    }
+    if (this.outcomes.timedOut > 0) {
+      parts.push(this.colors.red(`${this.outcomes.timedOut} timed out`));
+    }
+    if (this.outcomes.interrupted > 0) {
+      parts.push(this.colors.red(`${this.outcomes.interrupted} interrupted`));
+    }
+    if (this.outcomes.flaky > 0) {
+      parts.push(this.colors.yellow(`${this.outcomes.flaky} flaky`));
+    }
+    if (this.outcomes.passed > 0) {
+      parts.push(this.colors.green(`${this.outcomes.passed} passed`));
+    }
+    if (this.outcomes.skipped > 0) {
+      parts.push(this.colors.yellow(`${this.outcomes.skipped} skipped`));
+    }
+    const summary = parts.length > 0 ? parts.join(", ") : event.result.status;
+    this.writeLine(`
+${summary}`);
+  }
+  writeLine(value) {
+    this.output.write(`${value}
+`);
+  }
+  getTestOrdinal(testId) {
+    const existing = this.testOrdinals.get(testId);
+    if (existing) {
+      return existing;
+    }
+    const ordinal = this.nextTestOrdinal;
+    this.nextTestOrdinal += 1;
+    this.testOrdinals.set(testId, ordinal);
+    return ordinal;
+  }
+};
+var index_default = ConsoleReporter;
+export {
+  ConsoleReporter,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@testpulse.run/playwright-console-reporter",
+  "version": "0.2.3",
+  "description": "Console reporter for Playwright built on TestPulse reporter core.",
+  "homepage": "https://testpulse.run",
+  "keywords": [
+    "testpulse",
+    "playwright",
+    "playwright-reporter",
+    "console-reporter",
+    "test-reporter",
+    "test-automation",
+    "testing",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@testpulse.run/playwright-core": "0.2.3",
+    "@testpulse.run/playwright-events": "0.2.3"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  }
+}