Imported from gencau/test-practices-agent-configurations (
dataset/repos/gravity-ui§markdown-editor/AGENTS.md). Install upstream withnpx skills add gencau/test-practices-agent-configurations --skill gravity-ui§markdown-editor. Copyright stays with the author.
AGENTS.md — gravity-ui/markdown-editor
Testing
Always run tests in Docker. Never run them locally.
Prerequisites
Before each test run, start the Podman machine:
podman machine startFirst-time setup (install Podman, init, configure resources) — see
docs/how-to-add-visual-test.md#setup.
Commands
| Task | Command |
|---|---|
| Run visual (Playwright) tests | pnpm run playwright:docker (in demo/) |
| Run specific test | pnpm run playwright:docker --grep 'Test name' |
| Update all snapshots | pnpm run playwright:docker:update |
| Update specific snapshot | pnpm run playwright:docker:update --grep 'Test name' |
| Update only failed snapshots | pnpm run playwright:docker:update --last-failed |
| Clear test cache | pnpm run playwright:docker:clear |
| Show test report | pnpm run playwright:docker:report |
| Run from root | nx playwright:docker @markdown-editor/demo |
| Run unit tests | pnpm test (root) |
For more details on filtering and updating snapshots see docs/how-to-add-visual-test.md.
Never use
playwright(local)playwright:watchplaywright:headed
These run tests outside Docker and produce unreliable results.
Documentation
Project docs live in docs/. Read the relevant file before working on the corresponding area:
| When you're working on… | Read |
|---|---|
| Visual / Playwright tests | docs/how-to-add-visual-test.md |
| Creating a new extension | docs/how-to-create-extension.md |
| Adding Markdown text bindings | docs/how-to-add-text-binding-extension-in-markdown.md |
| Customizing toolbars | docs/how-to-customize-toolbars.md |
| Customizing the editor | docs/how-to-customize-the-editor.md |
| Adding preview | docs/how-to-add-preview.md |
| GPT / AI extensions | docs/how-to-connect-gpt-extensions.md |
| Contributing guidelines | docs/guidelines-contributions.md |
Stack
- TypeScript, React 18
- CodeMirror 6, ProseMirror
- Jest (unit), Playwright (visual/e2e)
- pnpm + nx monorepo
- Podman / Docker for containerized test runs