Repository navigation
Home
Live Test Runner is a VS Code extension that reruns the tests affected by each save and shows the results in the editor, for Jest, Vitest, Angular and pytest.
The docs come in three kinds. Pick the one for your question:
| I want to know… | Read |
|---|---|
| What a feature does, in plain language | Features |
| What a feature must do, and how that is checked | Requirements |
| How it is built, to change or fix it | Development |
| How to use it day to day | The user guide |
What each feature is for, how it behaves, and its limits. No code knowledge needed.
- Test runs: Start, batches that fit your machine, hanging tests, Stop
-
Test Explorer and editor: every test listed before it runs; icons, durations,
▶ Runin the editor - On-save reruns: save a file, only the affected tests run
- Results panel: results, console output and failures per test
- Coverage: bars on every line, and the tests that ran it
-
Debugging:
▷ Debugone test with breakpoints - Monorepos and mixed frameworks: many projects in one window, Jest + Vitest + pytest side by side
- AI assistants: Copilot, Cursor and terminal agents read live results and rerun tests themselves
What the extension must do, each requirement linked to the tests that check it.
- Project-wide requirements: rules every feature follows (zero config, never touch the user's project, the resource budget…)
- Test runs · Test Explorer and editor · On-save reruns · Results panel · Coverage · Debugging · Monorepos and mixed frameworks · AI assistants
Requirements marked
How the code is organised and how to work on it.
- Developer guide: setup, build, logging, adding a framework, tests, releases
- Architecture: packages, data model, execution flow, key decisions
- Feature designs:
- Framework feature matrix: what each framework supports
- AI context: a dense summary of the codebase for AI coding assistants
The docs describe the code as it is. A change isn't finished until its docs match it, in the same pull request:
| You change… | Update |
|---|---|
| What users see a feature do (behaviour, UI, a limit) |
docs/features/<feature>.md, the user guide (docs/live-test-runner-guide.html), both changelogs |
| What a feature must do, or a test that checks it |
docs/requirements/<feature>.md: add or edit the row; when you add a test for a |
| How a feature is built (key files, flow, a design decision) |
docs/development/design/<feature>.md; docs/development/architecture.md when the big picture changes |
| A setting or command | The feature page's settings table, the guide's settings or commands table, packages/vscode-extension/README.md
|
| A project-wide rule |
docs/requirements/project-rules.md and CLAUDE.md
|
| A new feature | All three pages (copy an existing set as the template), and list them in docs/README.md
|
| A removed feature | Delete its pages and every link to them |
Before opening the pull request, run node scripts/build-wiki.js --check. It fails on a broken link, and the PR checks run it too.
- Report a bug or ask for a feature on GitHub Issues
- Contributing guide · Code of Conduct · Security policy · Changelog
These pages are kept in the repository under docs/ and copied to the Wiki on every release. To change a page, open a pull request that edits the file in docs/.
Source: docs/README.md. This Wiki is generated from the repository; to change a page, open a pull request that edits its file in docs/.
Features
- Test runs
- Test Explorer and editor
- On-save reruns
- Results panel
- Coverage
- Debugging
- Monorepos and mixed frameworks
- AI assistants
Requirements
- Project-wide requirements
- Test runs: requirements
- Test Explorer and editor: requirements
- On-save reruns: requirements
- Results panel: requirements
- Coverage: requirements
- Debugging: requirements
- Monorepos and mixed frameworks: requirements
- AI assistants: requirements
Development
- Developer Guide
- Architecture
- Framework feature matrix
- AI context
- Feature designs
Generated from docs/. Edits made here are overwritten: change a page with a pull request.