Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: add claude.md (#39599)
Pavel Feldmane1f9a0e4113d
diff --git a/.claude/skills/playwright-dev/SKILL.md b/.claude/skills/playwright-dev/SKILL.mdindex e169d33c7c..a6baca9057 100644--- a/.claude/skills/playwright-dev/SKILL.md+++ b/.claude/skills/playwright-dev/SKILL.md@@ -5,17 +5,11 @@ description: Explains how to develop Playwright - add APIs, MCP tools, CLI comma# Playwright Development Guide-## Table of Contents+See [CLAUDE.md](../../../CLAUDE.md) for monorepo structure, build/test/lint commands, and coding conventions.++## Detailed Guides- [Library Architecture](library.md) — client/server/dispatcher structure, protocol layer, DEPS rules- [Adding and Modifying APIs](api.md) — define API docs, implement client/server, add tests- [MCP Tools and CLI Commands](mcp-dev.md) — add MCP tools, CLI commands, config options- [Vendoring Dependencies](vendor.md) — bundle third-party npm packages into playwright-core or playwright-- [Uploading Fixes to GitHub](github.md) — branch naming, commit format, pushing fixes for issues--## Build-- Assume watch is running and everything is up to date.-- If not, run `npm run build`.--## Lint-- Run `npm run flint` to lint everything before commit.diff --git a/.claude/skills/playwright-dev/github.md b/.claude/skills/playwright-dev/github.mddeleted file mode 100644index ff59e14261..0000000000--- a/.claude/skills/playwright-dev/github.md+++ /dev/null@@ -1,56 +0,0 @@-# Uploading a Fix for a GitHub Issue--## Branch naming--Create a branch named after the issue number:--```-git checkout -b fix-39562-```--## Committing changes--Use conventional commit format with a scope:--- `fix(proxy): description` — bug fixes-- `feat(locator): description` — new features-- `chore(cli): description` — maintenance, refactoring, tests--The commit body must be a single line: `Fixes: https://github.com/microsoft/playwright/issues/39562`--Stage only the files related to the fix. Do not use `git add -A` or `git add .`.--```-git add src/server/proxy.ts tests/proxy.spec.ts-git commit -m "$(cat <<'EOF'-fix(proxy): handle SOCKS proxy authentication--Fixes: https://github.com/microsoft/playwright/issues/39562-EOF-)"-```--## Pushing--Push the branch to origin:--```-git push origin fix-39562-```--## Full example--For issue https://github.com/microsoft/playwright/issues/39562:--```bash-git checkout -b fix-39562-# ... make changes ...-git add <changed-files>-git commit -m "$(cat <<'EOF'-fix(proxy): handle SOCKS proxy authentication--Fixes: https://github.com/microsoft/playwright/issues/39562-EOF-)"-git push origin fix-39562-```diff --git a/CLAUDE.md b/CLAUDE.mdnew file mode 100644index 0000000000..d168ae9d1b--- /dev/null+++ b/CLAUDE.md@@ -0,0 +1,134 @@+### Monorepo Packages++| Package | npm name | Purpose |+|---------|----------|---------|+| `playwright-core` | `playwright-core` | Browser automation engine: client, server, dispatchers, protocol |+| `playwright` | `playwright` | Test runner + browser automation (public package) |+| `playwright-test` | `@playwright/test` | Test runner entry point |+| `playwright-client` | `@playwright/client` | Standalone client package |+| `protocol` | *(internal)* | RPC protocol definitions (`protocol.yml` → generated `channels.d.ts`) |++### Browser Packages++`playwright-chromium`, `playwright-firefox`, `playwright-webkit` — per-browser distributions.+`playwright-browser-chromium`, `playwright-browser-firefox`, `playwright-browser-webkit` — binary packages.++### Tooling Packages++| Package | Purpose |+|---------|---------|+| `html-reporter` | HTML test report viewer |+| `trace-viewer` | Trace viewer UI |+| `recorder` | Test recorder |+| `web` | Shared web UI components |+| `injected` | Scripts injected into browser pages |++### Component Testing++`playwright-ct-core`, `playwright-ct-react`, `playwright-ct-vue`++### Key Directories++| Directory | Purpose |+|-----------|---------|+| `tests/` | All test suites (page, library, playwright-test, mcp, components, etc.) |+| `docs/src/` | API documentation — **source of truth** for public TypeScript types |+| `docs/src/api/` | Per-class API reference (`class-page.md`, `class-locator.md`, etc.) |+| `utils/` | Build scripts, code generation, linting, doc tools |+| `browser_patches/` | Browser engine patches |++## Build++```bash+npm run build # Full build+npm run watch # Watch mode (recommended during development)+```++Assume watch is running and code is up to date. Generated files (types, channels, validators) are produced by watch automatically.++## Lint++```bash+npm run flint+```++Runs all lint checks in parallel: eslint, tsc, doclint, check-deps, generate_channels, generate_types, lint-tests, test-types, lint-packages, code-snippet linting.++**Always run `flint` before committing.** Do not use `tsc --noEmit` or individual lint commands separately.++## Test Commands++| Command | Scope |+|---------|-------|+| `npm run ctest <filter>` | Chromium only library tests — **use during development** |+| `npm run test <filter> -- --project=<chromium,firefix,webkit>` | All library / per project |+| `npm run ttest <filter>` | Test runner (`tests/playwright-test/`) |+| `npm run ctest-mcp <filter>` | Chromium only MCP tools (`tests/mcp/`) |+| `npm run test-mcp <filter> -- --project=<chromium,firefox,webkit>` | MCP tools (`tests/mcp/`) |+++### Filtering++```bash+npm run ctest tests/page/locator-click.spec.ts # Specific file+npm run ctest tests/page/locator-click.spec.ts:12 # Specific location+npm run ctest -- --grep "should click" # By test name+npm run ctest-mcp snapshot # By file name part+```++### Test Directories and Fixtures++| Directory | Import | Key Fixtures | What to Test |+|-----------|--------|--------------|--------------|+| `tests/page/` | `import { test, expect } from './pageTest'` | `page`, `server`, `browserName` | User interactions: click, fill, navigate, locators, assertions |+| `tests/library/` | `import { browserTest, expect } from '../config/browserTest'` | `browser`, `context`, `browserType` | Browser/context lifecycle, cookies, permissions, browser-specific features |+| `tests/playwright-test/` | `import { test, expect } from './playwright-test-fixtures'` | test runner fixtures | Test runner: reporters, config, annotations, retries |+| `tests/mcp/` | `import { test, expect } from './fixtures'` | `client`, `server` | MCP tools via `client.callTool()` |++**Decision rule**: Does the test need `browser`/`browserType`/`context` → `tests/library/`. Just needs `page` + `server` → `tests/page/`.++## DEPS System++Import boundaries are enforced via `DEPS.list` files (52+ across the repo), checked by `npm run flint`.++**Key rule**: Client code NEVER imports server code. Server code NEVER imports client code. Communication is only through the protocol.+When creating or moving files, update the relevant `DEPS.list` to declare allowed imports. Files marked `"strict"` can only import what is explicitly listed.++## Commit Convention++Semantic commit messages: `label(scope): description`++Labels: `fix`, `feat`, `chore`, `docs`, `test`, `devops`++```bash+git checkout -b fix-39562+# ... make changes ...+git add <changed-files>+git commit -m "$(cat <<'EOF'+fix(proxy): handle SOCKS proxy authentication++Fixes: https://github.com/microsoft/playwright/issues/39562+EOF+)"+git push origin fix-39562+gh pr create --repo microsoft/playwright --head username:fix-39562 \+ --title "fix(proxy): handle SOCKS proxy authentication" \+ --body "$(cat <<'EOF'+## Summary+- <describe the change>++Fixes https://github.com/microsoft/playwright/issues/39562+EOF+)"+```++Branch naming for issue fixes: `fix-<issue-number>`++## Development Guides++Detailed guides for common development tasks:++- **[Architecture: Client, Server, and Dispatchers](.claude/skills/playwright-dev/library.md)** — package layout, protocol layer, ChannelOwner/SdkObject/Dispatcher base classes, DEPS rules, end-to-end RPC flow, object lifecycle+- **[Adding and Modifying APIs](.claude/skills/playwright-dev/api.md)** — 6-step process: define docs → implement client → define protocol → implement dispatcher → implement server → write tests+- **[MCP Tools and CLI Commands](.claude/skills/playwright-dev/mcp-dev.md)** — `defineTool()`/`defineTabTool()`, tool capabilities, CLI `declareCommand()`, config options, testing with MCP fixtures+- **[Vendoring Dependencies](.claude/skills/playwright-dev/vendor.md)** — bundle architecture, esbuild setup, typed wrappers, adding deps to existing bundles