archive-gh-me/vitest
1
0
Fork 0
mirror of https://github.com/vitest-dev/vitest.git synced 2025-12-08 18:26:03 +00:00
Code Issues Projects Releases Wiki Activity
vitest/CONTRIBUTING.md
Tony Gorez 2521f4d46a
docs: add vscode debugger documentation (#94) 
Co-authored-by: Michel EDIGHOFFER <edimitchel@gmail.com>
Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>
2021-12-13 03:03:17 +08:00

1.4 KiB
Raw Blame History

Vitest Contributing Guide

Hi! We are really excited that you are interested in contributing to vitest. Before submitting your contribution, please make sure to take a moment and read through the following guide:

Right access (temporary)

Please, arise your hand with a comment in this issue to get the permission.

Repo Setup

The vitest repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be pnpm.

To develop and test vitest package:

  1. Run pnpm i in vitest's root folder

  2. Run pnpm run dev to build sources in watch mode

  3. Run

  • pnpm run test to run core tests
  • pnpm run test:all to run all the suite

Debugger

VS Code

If you want to use break point and explore code execution you can use the "Run and debug" feature from vscode.

  1. Add a debugger statement where you want to stop the code execution.

  2. Click on the "Run and Debug" icon in the activity bar of the editor.

  3. Click on the "Javascript Debug Terminal" button.

  4. It will open a terminal, then type the test command: pnpm run test

  5. The execution will stop and you'll use the Debug toolbar to continue, step over, restart the process...