vscode-jest-runner
Visual Studio Code Marketplace
Go to Marketplace
The Aim
Simple way to run or debug a single or multiple Jest-Tests from context menu.
As it is possible in IntelliJ / Webstorm
Features
Run your Jest Tests from context-menu
- right click your test and select Run Jest from context menu
- to run a test in debug mode use Debug Jest
- run previous test from command palette (strg+shift+p)
Requirements
- Have a valid Jest config
- Have Jest installed globally or as project dependency
Extension Settings
Jest Runner will work out of the box, with a valid Jest config.
If you have a custom setup use the following options to configure Jest Runner:
| Command |
Description |
| jestrunner.configPath |
Jest config path (relative to ${workFolder} e.g. jest-config.json) |
| jestrunner.jestPath |
Absolute path to jest bin file (e.g. /usr/lib/node_modules/jest/bin/jest.js) |
| jestrunner.debugOptions |
Add or overwrite vscode debug configurations (only in debug mode) (e.g. "jestrunner.debugOptions": { "args": ["--no-cache"] }) |
| jestrunner.jestCommand |
Define an alternative Jest command (e.g. for Create React App and similar abstractions) |
Shortcuts
click File -> Preferences -> Keyboard Shortcuts -> "{}" (top right)
the json config file will open
add this:
{
"key": "alt+1",
"command": "extension.runJest"
},
{
"key": "alt+2",
"command": "extension.debugJest"
},
Want to start contributing features?
Some open topics get you started:
- Test cases with overlapping names are run accidentally
- Add Command to update a single snapshot test
- Ability to pass command line arguments to Jest (already implemented jestrunner.debugOptions, need the same for run with jestrunner.runOptions).
- Show vscode-jest-runner context menu items only while in a test file e.g. test.(js|ts). Currently its shown, no matter which file.
Notes
By default Jest finds its config from the "jest" attribute in your package.json or if you export an object module.export = {} in a jest.config.js file in your project root directory.
Read More: Configuring Jest Docs
If Breakspoints are not working properly, try adding this to vscode config:
"jestrunner.debugOptions": {
"args": ["--no-cache"],
"sourcemaps": "inline",
"disableOptimisticBPs": true,
}
