Console Reporter

ConsoleReporter, available as part of the @serenity-js/console-reporter module, writes text-based reports to your computer terminal.

The reporter supports colour schemes for both light and dark terminals.

Report produced by `ConsoleReporter`
Example report produced by ConsoleReporter

Installation

To install the module, run the following command in your computer terminal:

npm install --save-dev @serenity-js/{core,console-reporter}

Integration

ConsoleReporter listens to DomainEvents emitted by Actors and Serenity/JS test runner adapters.

graph TB A(["fas:fa-users Actors"]) TRA(["fas:fa-plug Serenity/JS test runner adapter"]) S["Serenity"] CR["ConsoleReporter"] T["fas:fa-terminal text report"] TRA -- notifies --> S A -- notify --> S S -- notifies --> CR CR -- prints --> T subgraph "core" S end subgraph "console-reporter" CR end class A socket class TRA socket click A "/handbook/design/actors.html" click S "/modules/core/class/src/Serenity.ts~Serenity.html" click CR "/modules/console-reporter"

Usage

To use the ConsoleReporter, register it as one of the StageCrewMembers:

import { configure } from '@serenity-js/core';
import { ConsoleReporter } from '@serenity-js/console-reporter';

configure({
    crew: [
        ConsoleReporter.forDarkTerminals(),
    ],
});

To learn more about the available configuration options, consult the ConsoleReporter API docs and its test suite.

You might also want to explore the example projects.

Love Serenity/JS? Spread the word on Twitter and LinkedIn!

Found a typo? You can fix it yourself or raise a ticket on GitHub.

If you'd like to help us bring more great tools and content to the Open-Source Community, become a GitHub Sponsor of Serenity/JS for as little as the cost of a cup of coffee.

Sponsor