@probitas/reporter

Test result reporting and formatting for Probitas.

This package provides multiple reporter implementations for formatting and displaying test execution results. All reporters implement the Reporter interface from @probitas/runner and can be passed to ScenarioRunner.run().

Links

• GitHub Repository
• @probitas/probitas - Main package (recommended for most users)

Related Packages

Package	Description
@probitas/runner	Uses reporters for output
@probitas/cli	CLI that uses these reporters
@probitas/logger	Logging used during execution

Available Reporters

• ListReporter - Detailed hierarchical output showing scenario and step names
• DotReporter - Compact single-character output (. for pass, F for fail)
• TapReporter - TAP (Test Anything Protocol) format for CI integration
• JsonReporter - JSON output for machine-readable results

Base Class

• BaseReporter - Abstract base class with common functionality:
  • Output stream management (defaults to stderr)
  • Serialized write operations for concurrent scenarios
  • Customizable color themes (use noColor option to disable)

Theming

• Theme - Interface defining semantic color functions
• defaultTheme - Default colored theme
• noColorTheme - Theme without ANSI color codes

Configuration Types

• ReporterOptions - Options for reporter initialization
• ThemeFunction - Type for theme color functions

deno add jsr:@probitas/reporter

class DotReporter implements Reporter

new DotReporter(_: unknown)

onScenarioEnd(): unknown

onRunEnd(): unknown

class JSONReporter implements Reporter

new JSONReporter(_: unknown)

onRunStart(): unknown

onRunEnd(): unknown

onScenarioStart(): unknown

onScenarioEnd(): unknown

onStepStart(): unknown

onStepEnd(): unknown

class ListReporter implements Reporter

const reporter = new ListReporter();
const runner = new Runner(reporter);
const result = await runner.run(scenarios);

// Output:
// ✓ Login scenario > Step that passes  (test.ts:15) [10.000ms]
// ✓ Login scenario > Another step  (test.ts:20) [5.000ms]
// ✗ Payment scenario > Process payment  (test.ts:50) [25.000ms]
//   Error: Insufficient funds
//   at checkout (test.ts:52)
//
// Summary
//   ✓ 1 scenarios passed
//   ✗ 1 scenarios failed

new ListReporter(_: unknown)

onStepEnd(): unknown

onRunEnd(): unknown

class TAPReporter implements Reporter

new TAPReporter(_: unknown)

onRunStart(): unknown

onStepEnd(): unknown

onRunEnd(): unknown

interface DotReporterOptions extends WriterOptions

interface JSONReporterOptions extends WriterOptions

interface ListReporterOptions extends WriterOptions

interface ReporterOptions

const reporter = new ListReporter({
  output: Deno.stdout.writable
});

const file = await Deno.open("results.txt", { write: true });
const reporter = new ListReporter({
  output: file.writable
});

interface TAPReporterOptions extends WriterOptions

interface Theme

const myTheme: Theme = {
  success: (t) => chalk.green(t),
  failure: (t) => chalk.red.bold(t),
  skip: (t) => chalk.yellow(t),
  dim: (t) => chalk.gray(t),
  title: (t) => chalk.bold(t),
  info: (t) => chalk.cyan(t),
  warning: (t) => chalk.yellow(t)
};

type ThemeFunction = (text: string) => unknown

const colorTheme: Theme

const defaultTheme: unknown

const noColorTheme: Theme