DevOps & Tooling · Codex, Cursor, Copilot coding agent
Playwright End-to-End Testing AGENTS.md
An AGENTS.md for Playwright End-to-End Testing: setup, commands and the checks coding agents should run before they finish.
- Path
- AGENTS.md
- Loads
- Repo root, nearest file wins
- Format
- Plain Markdown (.md)
- Used by
- Codex, Cursor, Copilot coding agent
What this file tells the agent
AGENTS.md is the file coding agents such as Codex, Cursor and Copilot's coding agent read for project instructions. This one gives them the Playwright End-to-End Testing setup, the commands to run and the conventions to keep.
- 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 AGENTS.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
Codex, Cursor, GitHub Copilot's coding agent and other agents read AGENTS.md when they start a task. For Claude Code, add @AGENTS.md to CLAUDE.md.
$ curl -fsSL "https://www.devscratchpad.tech/api/raw/agents-md/playwright-e2e" -o "AGENTS.md"
writes AGENTS.md
AGENTS.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
- What agents read AGENTS.md?
- OpenAI Codex, Cursor, GitHub Copilot's coding agent, Google Jules and many other agents read AGENTS.md from the repository root. Claude Code reads CLAUDE.md, which can import it with @AGENTS.md.
- How are verification gates enforced?
- AGENTS.md lists the commands that must pass, for example build and lint exiting 0. Agents that read it run them before they finish, but nothing enforces them outside your CI, so run the same checks there.