-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmod.ts
More file actions
69 lines (67 loc) · 2.07 KB
/
mod.ts
File metadata and controls
69 lines (67 loc) · 2.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/**
* Test result reporting and formatting for Probitas.
*
* This package provides multiple reporter implementations for formatting and
* displaying test execution results. All reporters implement the {@linkcode Reporter}
* interface from `@probitas/runner` and can be passed to `ScenarioRunner.run()`.
*
* ## Links
*
* - [GitHub Repository](https://github.com/probitas-test/probitas)
* - [@probitas/probitas](https://jsr.io/@probitas/probitas) - Main package (recommended for most users)
*
* ## Related Packages
*
* | Package | Description |
* |---------|-------------|
* | [@probitas/runner](https://jsr.io/@probitas/runner) | Uses reporters for output |
* | [@probitas/cli](https://jsr.io/@probitas/cli) | CLI that uses these reporters |
* | [@probitas/logger](https://jsr.io/@probitas/logger) | Logging used during execution |
*
* ## Available Reporters
*
* - {@linkcode ListReporter} - Detailed hierarchical output showing scenario and step names
* - {@linkcode JSONReporter} - JSON output for machine-readable results
*
* @example Using ListReporter (default for CLI)
* ```ts
* import { ListReporter } from "@probitas/reporter";
*
* const reporter = new ListReporter();
* void reporter;
*
* // Output example when used with ScenarioRunner:
* // ● User Registration
* // ✓ Create user (15ms)
* // ✓ Verify email (23ms)
* // ● API Integration
* // ✓ Authenticate (45ms)
* // ✗ Fetch data (102ms)
* // Error: Connection timeout
* ```
*
* @example Using JSONReporter for programmatic analysis
* ```ts
* import { JSONReporter } from "@probitas/reporter";
*
* const reporter = new JSONReporter();
* void reporter;
*
* // Output: JSON object with full run details
* ```
*
* @example Configuring reporter options
* ```ts
* import { ListReporter } from "@probitas/reporter";
*
* const reporter = new ListReporter({
* output: Deno.stdout.writable, // Write to stdout instead of stderr
* });
* void reporter;
* ```
*
* @module
*/
export * from "./list_reporter.ts";
export * from "./json_reporter.ts";
export type * from "./types.ts";