cucumber-playwright or playwright test for BDD?

cucumber-playwright uses Cucumber-js for strict BDD with Gherkin syntax, while Playwright Test is a native runner. Choose cucumber-playwright if you need BDD workflows, but be aware of configuration differences for features like parallel runs, as noted in the README.

How to debug cucumber-playwright tests in VSCode?

Open the feature file in VSCode, select the debug option from the debugger, and set breakpoints in your step definitions. You can also use the 'Then debug' step in your feature to pause execution during a run for interactive debugging.

Does cucumber-playwright support parallel test execution?

Yes, parallel execution is possible through Cucumber-js profiles, but the README notes that it may require different configuration compared to Playwright Test's built-in parallelism, adding complexity.

How to generate Allure reports with cucumber-playwright?

Run tests with the environment variable USE_ALLURE=1, then use the command 'npm run allure' to generate and view the detailed Allure report, which includes attachments like last good images for failed tests.

Can I use Page Object Model in cucumber-playwright?

The author is not fond of POM, but you can implement it by referring to a provided PR in the repository. It's not the default or recommended approach, so teams used to POM might find it lacking.

cucumber-playwright — E2E Test Starter Repository

What is cucumber-playwright?

cucumber-playwright is a starter repository that provides a pre-configured template for writing end-to-end tests using Cucumber for behavior-driven development and Playwright for browser automation. It solves the problem of setting up a modern E2E testing stack with TypeScript, reporting, and debugging tools, enabling teams to quickly adopt BDD practices.

Target Audience

Developers and QA engineers who need to implement BDD-style end-to-end tests with Playwright and TypeScript, particularly those looking for a ready-to-use starter template.

Value Proposition

It offers a streamlined, opinionated setup that integrates Cucumber and Playwright with TypeScript, avoiding complex patterns like Page Object Model while providing robust reporting, debugging, and multi-browser support out of the box.

Overview

cucumber-playwright is a starter template for creating end-to-end (E2E) tests that combine Cucumber for behavior-driven development (BDD) and Playwright for browser automation. It provides a pre-configured TypeScript environment to help teams quickly set up and maintain test suites with modern tooling.

Key Features

TypeScript Setup — Includes ESLint, TypeScript, and Prettier for writing type-safe steps with consistent formatting.
Playwright Integration — Launches Playwright browsers, contexts, and pages per scenario, supporting Chromium, Firefox, and WebKit.
Video Recording & Reporting — Records test runs with video, attaches last good images to reports, and supports Allure and HTML reporting.
Debugging Utilities — Provides CLI and VSCode debugging options, including headful mode, API debugging, and step debugging with breakpoints.
Scenario Management — Allows ignoring scenarios via tags, checking step usage, and running single features or scenarios.

Philosophy

The project emphasizes a streamlined setup for BDD-style E2E testing, avoiding over-engineering like the Page Object Model in favor of a more JavaScript-friendly approach.

cucumber-playwright

What is cucumber-playwright?

Overview

Key Features

Philosophy

Related Projects

Found a gem we're missing?

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions