Playwright Pro
Production-grade Playwright testing toolkit for AI coding agents.
Available Commands
When installed as a Claude Code plugin, these are available as /pw: commands:
| Command |
What it does |
/pw:init |
Set up Playwright — detects framework, generates config, CI, first test |
/pw:generate <spec> |
Generate tests from user story, URL, or component |
/pw:review |
Review tests for anti-patterns and coverage gaps |
/pw:fix <test> |
Diagnose and fix failing or flaky tests |
/pw:migrate |
Migrate from Cypress or Selenium to Playwright |
/pw:coverage |
Analyze what's tested vs. what's missing |
/pw:testrail |
Sync with TestRail — read cases, push results |
/pw:browserstack |
Run on BrowserStack, pull cross-browser reports |
/pw:report |
Generate test report in your preferred format |
Quick Start Workflow
The recommended sequence for most projects:
1. /pw:init → scaffolds config, CI pipeline, and a first smoke test
2. /pw:generate → generates tests from your spec or URL
3. /pw:review → validates quality and flags anti-patterns ← always run after generate
4. /pw:fix <test> → diagnoses and repairs any failing/flaky tests ← run when CI turns red
Validation checkpoints:
- After
/pw:generate — always run /pw:review before committing; it catches locator anti-patterns and missing assertions automatically.
- After
/pw:fix — re-run the full suite locally (npx playwright test) to confirm the fix doesn't introduce regressions.
- After
/pw:migrate — run /pw:coverage to confirm parity with the old suite before decommissioning Cypress/Selenium tests.
Example: Generate → Review → Fix
# 1. Generate tests from a user story
/pw:generate "As a user I can log in with email and password"
# Generated: tests/auth/login.spec.ts
# → Playwright Pro creates the file using the auth template.
# 2. Review the generated tests
/pw:review tests/auth/login.spec.ts
# → Flags: one test used page.locator('input[type=password]') — suggests getByLabel('Password')
# → Fix applied automatically.
# 3. Run locally to confirm
npx playwright test tests/auth/login.spec.ts --headed
# 4. If a test is flaky in CI, diagnose it
/pw:fix tests/auth/login.spec.ts
# → Identifies missing web-first assertion; replaces waitForTimeout(2000) with expect(locator).toBeVisible()
Golden Rules
getByRole() over CSS/XPath — resilient to markup changes- Never
page.waitForTimeout() — use web-first assertions
expect(locator) auto-retries; expect(await locator.textContent()) does not- Isolate every test — no shared state between tests
baseURL in config — zero hardcoded URLs- Retries:
2 in CI, 0 locally
- Traces:
'on-first-retry' — rich debugging without slowdown
- Fixtures over globals —
test.extend() for shared state
- One behavior per test — multiple related assertions are fine
- Mock external services only — never mock your own app
Locator Priority
1. getByRole() — buttons, links, headings, form elements
2. getByLabel() — form fields with labels
3. getByText() — non-interactive text
4. getByPlaceholder() — inputs with placeholder
5. getByTestId() — when no semantic option exists
6. page.locator() — CSS/XPath as last resort
What's Included
- 9 skills with detailed step-by-step instructions
- 3 specialized agents: test-architect, test-debugger, migration-planner
- 55 test templates: auth, CRUD, checkout, search, forms, dashboard, settings, onboarding, notifications, API, accessibility
- 2 MCP servers (TypeScript): TestRail and BrowserStack integrations
- Smart hooks: auto-validate test quality, auto-detect Playwright projects
- 6 reference docs: golden rules, locators, assertions, fixtures, pitfalls, flaky tests
- Migration guides: Cypress and Selenium mapping tables
Integration Setup
TestRail (Optional)
export TESTRAIL_URL="https://your-instance.testrail.io"
export TESTRAIL_USER="your@email.com"
export TESTRAIL_API_KEY="your-api-key"
BrowserStack (Optional)
export BROWSERSTACK_USERNAME="your-username"
export BROWSERSTACK_ACCESS_KEY="your-access-key"
Quick Reference
See reference/ directory for:
golden-rules.md — The 10 non-negotiable ruleslocators.md — Complete locator priority with cheat sheetassertions.md — Web-first assertions referencefixtures.md — Custom fixtures and storageState patternscommon-pitfalls.md — Top 10 mistakes and fixesflaky-tests.md — Diagnosis commands and quick fixes
See templates/README.md for the full template index.
1---2name: playwright-pro3description: Generate, review, fix, and migrate Playwright end-to-end tests with templates, CI integration, and optional TestRail/BrowserStack sync.4---56# Playwright Pro78Production-grade Playwright testing toolkit for AI coding agents.910## Available Commands1112When installed as a Claude Code plugin, these are available as `/pw:` commands:1314| Command | What it does |15|---|---|16| `/pw:init` | Set up Playwright — detects framework, generates config, CI, first test |17| `/pw:generate <spec>` | Generate tests from user story, URL, or component |18| `/pw:review` | Review tests for anti-patterns and coverage gaps |19| `/pw:fix <test>` | Diagnose and fix failing or flaky tests |20| `/pw:migrate` | Migrate from Cypress or Selenium to Playwright |21| `/pw:coverage` | Analyze what's tested vs. what's missing |22| `/pw:testrail` | Sync with TestRail — read cases, push results |23| `/pw:browserstack` | Run on BrowserStack, pull cross-browser reports |24| `/pw:report` | Generate test report in your preferred format |2526## Quick Start Workflow2728The recommended sequence for most projects:2930```311. /pw:init → scaffolds config, CI pipeline, and a first smoke test322. /pw:generate → generates tests from your spec or URL333. /pw:review → validates quality and flags anti-patterns ← always run after generate344. /pw:fix <test> → diagnoses and repairs any failing/flaky tests ← run when CI turns red35```3637**Validation checkpoints:**38- After `/pw:generate` — always run `/pw:review` before committing; it catches locator anti-patterns and missing assertions automatically.39- After `/pw:fix` — re-run the full suite locally (`npx playwright test`) to confirm the fix doesn't introduce regressions.40- After `/pw:migrate` — run `/pw:coverage` to confirm parity with the old suite before decommissioning Cypress/Selenium tests.4142### Example: Generate → Review → Fix4344```bash45# 1. Generate tests from a user story46/pw:generate "As a user I can log in with email and password"4748# Generated: tests/auth/login.spec.ts49# → Playwright Pro creates the file using the auth template.5051# 2. Review the generated tests52/pw:review tests/auth/login.spec.ts5354# → Flags: one test used page.locator('input[type=password]') — suggests getByLabel('Password')55# → Fix applied automatically.5657# 3. Run locally to confirm58npx playwright test tests/auth/login.spec.ts --headed5960# 4. If a test is flaky in CI, diagnose it61/pw:fix tests/auth/login.spec.ts62# → Identifies missing web-first assertion; replaces waitForTimeout(2000) with expect(locator).toBeVisible()63```6465## Golden Rules66671. `getByRole()` over CSS/XPath — resilient to markup changes682. Never `page.waitForTimeout()` — use web-first assertions693. `expect(locator)` auto-retries; `expect(await locator.textContent())` does not704. Isolate every test — no shared state between tests715. `baseURL` in config — zero hardcoded URLs726. Retries: `2` in CI, `0` locally737. Traces: `'on-first-retry'` — rich debugging without slowdown748. Fixtures over globals — `test.extend()` for shared state759. One behavior per test — multiple related assertions are fine7610. Mock external services only — never mock your own app7778## Locator Priority7980```811. getByRole() — buttons, links, headings, form elements822. getByLabel() — form fields with labels833. getByText() — non-interactive text844. getByPlaceholder() — inputs with placeholder855. getByTestId() — when no semantic option exists866. page.locator() — CSS/XPath as last resort87```8889## What's Included9091- **9 skills** with detailed step-by-step instructions92- **3 specialized agents**: test-architect, test-debugger, migration-planner93- **55 test templates**: auth, CRUD, checkout, search, forms, dashboard, settings, onboarding, notifications, API, accessibility94- **2 MCP servers** (TypeScript): TestRail and BrowserStack integrations95- **Smart hooks**: auto-validate test quality, auto-detect Playwright projects96- **6 reference docs**: golden rules, locators, assertions, fixtures, pitfalls, flaky tests97- **Migration guides**: Cypress and Selenium mapping tables9899## Integration Setup100101### TestRail (Optional)102```bash103export TESTRAIL_URL="https://your-instance.testrail.io"104export TESTRAIL_USER="your@email.com"105export TESTRAIL_API_KEY="your-api-key"106```107108### BrowserStack (Optional)109```bash110export BROWSERSTACK_USERNAME="your-username"111export BROWSERSTACK_ACCESS_KEY="your-access-key"112```113114## Quick Reference115116See `reference/` directory for:117- `golden-rules.md` — The 10 non-negotiable rules118- `locators.md` — Complete locator priority with cheat sheet119- `assertions.md` — Web-first assertions reference120- `fixtures.md` — Custom fixtures and storageState patterns121- `common-pitfalls.md` — Top 10 mistakes and fixes122- `flaky-tests.md` — Diagnosis commands and quick fixes123124See `templates/README.md` for the full template index.
Alireza Rezvani