๐ Getting Started ๐ Documentation โถ๏ธ Example ๐ Changelog
> [!TIP] > [BDD + MCP: Your thoughts?](https://github.com/vitalets/playwright-bdd/issues/321) ## Why BDD? In the era of AI, you can take [BDD](https://cucumber.io/docs/bdd/) approach to the next level: - ๐ค **Generate** feature files from raw business requirements. - โ **Refine** scenarios with colleagues or AI in plain human language. - ๐ **Automate** test execution using the Playwright runner. ## Why Playwright Runner? Both [Playwright](https://playwright.dev/) and [CucumberJS](https://github.com/cucumber/cucumber-js) have their own test runners. You can use the CucumberJS runner with [Playwright as a library](https://playwright.dev/docs/library) to execute BDD scenarios. This package offers **an alternative**: convert BDD scenarios into Playwright test files and run them as regular tests. You gain all the advantages of the Playwright runner: - Automatic browser initialization and cleanup - Auto-capture of screenshots, videos, and traces - Parallelization with sharding - Auto-waiting for page elements - Built-in visual comparison testing - Power of Playwright fixtures - [...and more](https://playwright.dev/docs/library#key-differences) ## How It Works
## Extras
Playwright-BDD has several unique features:
- ๐ฅ Advanced tagging [by path](https://vitalets.github.io/playwright-bdd/#/writing-features/tags-from-path) and [special tags](https://vitalets.github.io/playwright-bdd/#/writing-features/special-tags)
- ๐ฉ [Step decorators](https://vitalets.github.io/playwright-bdd/#/writing-steps/decorators) for class methods
- ๐ฏ [Scoped step definitions](https://vitalets.github.io/playwright-bdd/#/writing-steps/scoped)
- โจ [Exporting steps](https://vitalets.github.io/playwright-bdd/#/writing-features/chatgpt) for AI
- โป๏ธ [Re-usable step functions](https://vitalets.github.io/playwright-bdd/#/writing-steps/reusing-step-fn)
## Documentation
Check out the [documentation website](https://vitalets.github.io/playwright-bdd/#/).
## Examples
- Check out [`examples`](/examples) folder
- Clone the fully working repo: [playwright-bdd-example](https://github.com/vitalets/playwright-bdd-example)
## Playwright Versions Support
`playwright-bdd` supports all **non-deprecated** versions of Playwright. To check which Playwright versions are currently deprecated, run:
```bash
npm show @playwright/test@1 deprecated
```
## Feedback & Community
Feel free to report a bug, propose a feature or share your experience:
* [GitHub issues](https://github.com/vitalets/playwright-bdd/issues)
* [Playwright-BDD Discord](https://discord.gg/5rwa7TAGUr)
## Changelog
Check out the latest changes in the [CHANGELOG.md](https://github.com/vitalets/playwright-bdd/blob/main/CHANGELOG.md).
## ๐ Sponsors
Great thanks to the **amazing people and companies** already supporting Playwright-BDD! Your help keeps the project alive and growing:
