Repository navigation
Test Explorer and editor requirements
github-actions[bot] edited this page Nov 14, 2026
·
3 revisions
What the feature must do, and how we check it does. For the plain-language description see Test Explorer and editor; for how it is built see the design. The project-wide requirements apply too.
| # | The extension must… | Checked by |
|---|---|---|
| E1 | List every test file, suite and test before any test runs, without running the framework's tests |
pytest-full-run, mixed-js-python; unit: testDiscovery, pythonDiscovery
|
| E2 | Support any nesting depth of describe blocks and classes |
unit: testDiscovery, resultStore
|
| E3 | Show dynamic tests (test.each, template-literal names, parametrize) as a template that fills in with the real cases after a run, and keep the template when it has no cases |
basic-full-run; unit: testDiscovery, testNames
|
| E4 | Update the tree when a test file is created, changed or deleted |
basic-on-save (deleting a test file lowers the total) |
| E5 | Cache the parsed tree per project, keyed by file modification time, and re-read only changed files | |
| E6 | Add the files the framework's config runs even when no testFilePatterns pattern matches, and show files the framework never runs as excluded, not as failed or running |
basic-full-run |
| E7 | Show skipped and todo tests as skipped, each with its own icon (a todo is not drawn like a skipped test, a skipped test not like one never run) |
basic-full-run, vitest-full-run; unit: resultStore
|
| E8 | Show a status icon in the gutter and the duration after each test line, coloured by durationThresholds
|
unit: duration
|
| E9 | Offer ▶ Run, ▷ Debug and ◈ Results above each test and group; ▶ Run runs exactly that scope, with or without a session |
basic-scoped-run, vitest-scoped-run, pytest-scoped-run
|
| E10 | Show Total, Passed, Failed and, only while tests run, Running; filter the tree by a card or the status dropdown |
basic-running-count; unit: statusFilter
|
| E11 | Keep the summary total equal to the number of tests in the tree |
basic-full-run; unit: resultStore
|
| E12 | Use the framework's own line numbers for a test once it has run | |
| E13 | Show a failed test's message after the line where it failed (in the test, and the source line it was thrown from), for Jest, Vitest and pytest; the hover has the whole message, Show diff (when both values are known), Open in Results and Dismiss |
failure-on-line, vitest-full-run, pytest-full-run; unit: failureInfo
|
| E15 | Update snapshot (Jest, Vitest): offer it on a snapshot failure; ask in a modal dialog naming the file before anything is written, and write nothing on no; then rerun only that test with the framework's update flag, so only its snapshot changes (other tests' snapshots stay; ones no test uses any more are removed, as -u does, and the dialog says so); detect inline snapshots for Vitest too (from the failing line); refuse while that file has unsaved changes |
snapshot-update, vitest-snapshot-update; unit: failureInfo
|
| E14 | Hide a failure message on a line edited since the run, and a dismissed one until its test runs again; showFailuresInEditor turns them off |
failure-on-line |
| E16 | Keep the test lists light during a large run: a file that starts or finishes redraws only its own row (found by an index, not a search of the list), starts are sent with results at most every 50 ms (a single test's rerun at once; none after Stop), and rows off screen are not laid out | unit: webviewBatching; measured by scripts/perf-measure.js (VS Code renderer CPU) |
| # | Requirement |
|---|---|
| Q1 | Discovery never blocks the editor: files are parsed in small batches with a yield between them. |
| Q2 | Reopening a project with a warm cache only checks file times; it doesn't parse unchanged files. |
- Finding tests whose names exist only at runtime (a loop that builds
it()calls from data) before they run. They appear after the first run.
Source: docs/requirements/test-explorer.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.