@serenity-js/console-reporter

Serenity/JS

Serenity/JS is an innovative open-source framework designed to make acceptance and regression testing of complex software systems faster, more collaborative and easier to scale.

⭐️ Get started with Serenity/JS!

• Serenity/JS web testing tutorial
• Serenity/JS Handbook and Getting Started guides
• API documentation
• Serenity/JS Project Templates on GitHub

👋 Join the Serenity/JS Community!

• Meet other Serenity/JS developers and maintainers on the Serenity/JS Community chat channel,
• Find answers to your Serenity/JS questions on the Serenity/JS Forum,
• Learn how to contribute to Serenity/JS,
• Support the project and gain access to Serenity/JS Playbooks by becoming a Serenity/JS GitHub Sponsor!

Serenity/JS Console Reporter

@serenity-js/console-reporter writes text-based reports to your computer terminal.

Installation

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

To learn more about Serenity/JS and how to use it on your project, follow the Serenity/JS Getting Started guide.

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.

📣 Stay up to date

New features, tutorials, and demos are coming soon! Follow Serenity/JS on LinkedIn, subscribe to Serenity/JS channel on YouTube and join the Serenity/JS Community Chat to stay up to date! Please also make sure to star ⭐️ Serenity/JS on GitHub to help others discover the framework!

💛 Support Serenity/JS

If you appreciate all the effort that goes into making sophisticated tools easy to work with, please support our work and become a Serenity/JS GitHub Sponsor today!