Package Exports

@serenity-js/console-reporter
@serenity-js/console-reporter/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@serenity-js/console-reporter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Serenity/JS

Serenity/JS is a framework designed to make acceptance and regression testing of modern full-stack applications faster, more collaborative and easier to scale.

Serenity/JS Console Reporter

@serenity-js/console-reporter module reports progress of your Serenity/JS tests to the terminal.

ConsoleReporter supports both colour and monochromatic output, as well as simple colour themes for terminals with dark and light backgrounds.

Installation

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

Learn more about Serenity/JS Console Reporter

Windows

If you're on Windows, consider using Windows Terminal instead of cmd.exe to benefit from the colour output.

Usage

To allow Serenity/JS to print the progress report to standard output, assign the ConsoleReporter to the Stage.

This can be done:

via playwright.config.ts, if you're using Serenity/JS with Playwright Test
via wdio.conf.ts, if you're using Serenity/JS with WebdriverIO
via protractor.conf.js, if you're using Serenity/JS with Protractor
or programmatically.

Usage with Playwright Test

Learn more about using Serenity/JS with Playwright Test.

// playwright.config.ts
import type { PlaywrightTestConfig } from '@serenity-js/playwright-test';

const config: PlaywrightTestConfig = {
    reporter: [
        [ '@serenity-js/playwright-test', {
            crew: [
                // console reporter with default settings
                '@serenity-js/console-reporter',
                
                // console reporter with a theme for 'dark', 'light' or 'mono' terminals
                // [ '@serenity-js/console-reporter', { theme: 'auto' } ]                
            ]
        }]
    ],

    // Other configuration omitted for brevity
    // For details, see https://playwright.dev/docs/test-configuration    
};

export default config;

Usage with WebdriverIO

Learn more about using Serenity/JS with WebdriverIO.

// wdio.conf.ts

import { WebdriverIOConfig } from '@serenity-js/webdriverio';

export const config: WebdriverIOConfig = {

    framework: '@serenity-js/webdriverio',

    serenity: {
        crew: [
            // console reporter with default settings
            '@serenity-js/console-reporter',

            // console reporter with a theme for 'dark', 'light' or 'mono' terminals
            // [ '@serenity-js/console-reporter', { theme: 'auto' } ]  
        ]
    },

    // Other configuration omitted for brevity
    // For details, see https://webdriver.io/docs/options
};

Usage with Protractor

Learn more about using Serenity/JS with Protractor.

// protractor.conf.js

exports.config = {

    framework:      'custom',
    frameworkPath:  require.resolve('@serenity-js/protractor/adapter'),

    serenity: {
        crew: [
            // console reporter with default settings
            '@serenity-js/console-reporter',

            // console reporter with a theme for 'dark', 'light' or 'mono' terminals
            // [ '@serenity-js/console-reporter', { theme: 'auto' } ]  
        ]
    },

    // ...
}

Programmatic configuration

Learn more about configuring Serenity/JS programmatically.

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

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

Colour Themes

Consult the API docs of the ConsoleReporter class to learn more about the supported colour themes.