vitest-dev / vitest-dev/vscode

Update README

Open
#338 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
TypeScript
Stars
924
Forks
122
Avg merge
1d 14h
Merged PRs (30d)
6

Description

Clear and concise description of the problem

Our current README doesn't provide enough information on how to work with the extension.

Suggested solution

Add several new sections:

  • How to run a test
  • How to enable/disable continuous mode and its benefits
  • How to run code with coverage. Mention that coverage is disabled unless you specifically press the coverage button
  • How to debug a test. Mention that if debugging multiple tests, they will not be running in parallel
    • How to use breakpoints/debugger statement
  • How to work with test filters (like @open)
  • Explain how the extension finds test files (scans for configs and starts new Vitest process for every config)
  • Explain how the extension collects tests (it runs Vitest in collect mode, so it can take a while if your tests have a lot of imports)
  • Available configuration with description and examples (maybe in a table form?)

I would also like to rewrite the introduction section:

  • Remove the current GIF since it uses the previous extension.
  • Remove the VSCode + Vitest logo as it takes a lot of space for nothing

It should look something like this:

# Vitest for VS Code

<!-- short description about what this is -->
<!-- table of content -->
<!-- small promo image showing a test file -->

## Requirements

<!-- list of requirements -->

## Feature 1
## Feature 2
...

All screenshots need to use the same project that should be pushed to the repository so we can reshoot it if needed. All screenshots need to have the same VS Code theme. Ideally, screenshots should have a border with a shadow (like on Mac OS) - this is just my preference 😄

Alternative

No response

Additional context

No response

Validations

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current README and the extension behavior described in the issue. Update the README with the requested usage, debugging, filtering, test-discovery, collection, and configuration sections, and replace the outdated introduction and screenshots. Done means the documented workflows and configuration examples are complete and the screenshots use one consistent project and VS Code theme.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.