Serenity BDD

@serenity-js/serenity-bdd enables Serenity BDD reports and living documentation for your Serenity/JS test suites.

Features

• Generates rich HTML and JSON reports
• Integrates with Cucumber, Mocha, Jasmine, Playwright, and WebdriverIO
• Supports tags, screenshots, and step-level reporting

Installation

npm install --save-dev @serenity-js/core @serenity-js/serenity-bdd

See the Serenity/JS Installation Guide.

Quick Start

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

configure({
    crew: [
        [ '@serenity-js/serenity-bdd', {
            specDirectory: './spec',
            reporter: {
                includeAbilityDetails: true,
            },
        } ],
        [ '@serenity-js/core:ArtifactArchiver', {
            outputDirectory: './target/site/serenity'
        } ],
    ]
})

Explore practical examples and in-depth explanations in the Serenity/JS Handbook.

Configuration

See the Serenity BDD Reporter Configuration Guide and best practices.

Documentation

• API Reference
• Screenplay Pattern Guide
• Serenity/JS Project Templates
• More examples and reference implementations
• Tutorial: First Web Scenario
• Tutorial: First API Scenario

Contributing

Contributions of all kinds are welcome! Get started with the Contributing Guide.

Community

• Community Chat
• Discussions Forum
  • Visit the 💡How to... ? section for answers to common questions

If you enjoy using Serenity/JS, make sure to star ⭐️ Serenity/JS on GitHub to help others discover the framework!

License

The Serenity/JS code base is licensed under the Apache-2.0 license, while its documentation and the Serenity/JS Handbook are licensed under the Creative Commons BY-NC-SA 4.0 International.

See the Serenity/JS License.

Support

Support ongoing development through GitHub Sponsors. Sponsors gain access to Serenity/JS Playbooks and priority help in the Discussions Forum.

For corporate sponsorship or commercial support, please contact Jan Molak.

.