# AGENTS.md

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API. 

## Setup

```
npm ci
```

## Commands

```
npm run build    # produce a build
npm run test     # run the test suite, must pass before any commit
npm run lint     # lint
npm run ctest
npm run ftest
npm run wtest
npm run wvtest
npm run atest
```

## Layout

- `packages/`        782 source files
- `tests/`           654 source files
- `utils/`           71 source files
- `browser_patches/` 52 source files
- `examples/`        40 source files

## Conventions

- Tests live alongside the code they cover, following `docs/src/images/getting-started/record-new-test.png`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/copilot-setup-steps.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/playwright-client/types/types.d.ts` is 1105KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.