DevOps & Tooling · Claude Code
Playwright End-to-End Testing CLAUDE.md
A CLAUDE.md for Playwright End-to-End Testing projects: build and test commands, conventions and the boundaries Claude Code should keep.
- Path
- CLAUDE.md
- Loads
- Every session
- Format
- Project memory (.md)
- Used by
- Claude Code
What this file tells the agent
Claude Code reads CLAUDE.md at the start of every session. Writing down the Playwright End-to-End Testing build and test commands, conventions and architectural boundaries there means it does not have to guess them.
- Strictly ban hardcoded delays (page.waitForTimeout()); rely exclusively on Playwright web-first auto-waiting assertions (expect(locator).toBeVisible()).
- Prioritize user-facing accessible locators: page.getByRole(), page.getByLabel(), and page.getByTestId(); never write fragile CSS selectors or brittle XPaths.
- Encapsulate multi-step interactions inside modular Page Object Models (POM) with typed parameters.
- Ensure total test isolation: authenticate via storage state (storageState) instead of repeating manual UI logins in every test.
- Configure trace viewer and video capture on first retry (trace: 'on-first-retry') for painless CI debugging.
Code to avoid, and what to write instead
The rule steers the agent away from the left and toward the right.
// Flaky: Brittle selectors, arbitrary sleep timeouts, and no auto-waiting
test("bad test", async ({ page }) => {
await page.goto("/catalog");
await page.click("div.col-md-4 > button:nth-child(2)"); // Breaks on minor CSS tweak!
await page.waitForTimeout(5000); // Flaky anti-pattern!
const text = await page.innerText("#cart-total");
expect(text).toBe("1");
});import { test, expect } from "@playwright/test";
test.describe("Checkout Flow", () => {
test("allows user to complete cart purchase", async ({ page }) => {
await page.goto("/catalog");
// Accessible, user-facing locators
await page.getByRole("button", { name: "Add to Cart" }).first().click();
await page.getByRole("link", { name: "Cart (1)" }).click();
// Auto-waiting assertions
await expect(page.getByRole("heading", { name: "Your Shopping Cart" })).toBeVisible();
await page.getByRole("button", { name: "Proceed to Checkout" }).click();
await expect(page).toHaveURL(/.*checkout/);
});
});Install it in one command
- 01
Go to your project root
The file goes at CLAUDE.md, relative to the root.
- 02
Download the file
Run the command on the right. It downloads this preset and writes the file.
- 03
Make sure it gets used
Claude Code reads CLAUDE.md at the start of every session. Run /memory to see which files it loaded.
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/claude-md/playwright-e2e" -o "CLAUDE.md"
writes CLAUDE.md
CLAUDE.md
To write the file from your own code instead, use Read your code or Convert Legacy Rules in the editor above.
More for Playwright End-to-End Testing
Questions
- Where does CLAUDE.md belong?
- At your repository root. Claude Code reads it at the start of each session.
- Can I combine CLAUDE.md with Cursor rules?
- Yes. CLAUDE.md is read by Claude Code; Cursor reads .cursor/rules/*.mdc, scoped by globs. Keep the shared conventions the same in both.