Serenity/JS reporting module that produces detailed Serenity BDD test reports and living documentation, enhancing transparency and traceability of test results
npm install @serenity-js/serenity-bdd@serenity-js/serenity-bdd
enables Serenity BDD reports and living documentation for your Serenity/JS test suites.
- Generates rich HTML and JSON reports
- Integrates with Cucumber, Mocha, Jasmine, Playwright, and WebdriverIO
- Supports tags, screenshots, and step-level reporting
``sh`
npm install --save-dev @serenity-js/core @serenity-js/serenity-bdd
See the Serenity/JS Installation Guide.
`typescript
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.
See the Serenity BDD Reporter Configuration Guide
and best practices.
- API Reference
- Screenplay Pattern Guide
- Serenity/JS Project Templates
- More examples and reference implementations
- Tutorial: First Web Scenario
- Tutorial: First API Scenario
Contributions of all kinds are welcome! Get started with
the Contributing Guide.
- 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!
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 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.
