Skip to content
github-actions[bot] edited this page Nov 19, 2026 · 4 revisions

Live Test Runner documentation

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

Features

What each feature is for, how it behaves, and its limits. No code knowledge needed.

Requirements

What the extension must do, each requirement linked to the tests that check it.

Requirements marked ⚠️ have no automated test yet.

Development

How the code is organised and how to work on it.

Keeping these docs current

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 ⚠️ row, name it and drop the ⚠️
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.

Contributing

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/.

Clone this wiki locally