Skip to main content
Version: 1.x

Class: ComplianceReporter

Defined in: src/reporters/compliance-reporter.ts:154

Playwright reporter that writes a per-test compliance summary to disk.

Example​

// Instantiate directly (Playwright does this via config)
const reporter = new ComplianceReporter({ outputDir: 'reports' });

Implements​

  • Reporter

Constructors​

Constructor​

new ComplianceReporter(options?): ComplianceReporter

Defined in: src/reporters/compliance-reporter.ts:158

Parameters​

options?​

ComplianceReporterOptions

Returns​

ComplianceReporter

Methods​

onBegin()​

onBegin(_config, _suite): void

Defined in: src/reporters/compliance-reporter.ts:164

Called when the test run begins. No-op for this reporter.

Parameters​

_config​

FullConfig

_suite​

Suite

Returns​

void

Implementation of​

Reporter.onBegin

onEnd()​

onEnd(_result): Promise<void>

Defined in: src/reporters/compliance-reporter.ts:206

Called after all tests have finished. Writes the compliance report JSON.

Parameters​

_result​

FullResult

Returns​

Promise<void>

Implementation of​

Reporter.onEnd

onTestEnd()​

onTestEnd(test, result): void

Defined in: src/reporters/compliance-reporter.ts:178

Called after each individual test finishes.

Parameters​

test​

TestCase

The finished test case.

result​

TestResult

The test result containing step data.

Returns​

void

Remarks​

Iterates over result.steps and classifies each step as either a Praman step or a raw Playwright step based on its title.

Implementation of​

Reporter.onTestEnd

printsToStdio()​

printsToStdio(): boolean

Defined in: src/reporters/compliance-reporter.ts:221

Indicates whether this reporter prints to stdout/stderr.

Returns​

boolean

false — this reporter writes only to a JSON file.

Implementation of​

Reporter.printsToStdio