# vscode-customized-jest-runner

> Simple way to run or debug a single (or multiple) tests from context-menu

Latest version **0.5.55** (published 2022-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install vscode-customized-jest-runner
pnpm add vscode-customized-jest-runner
yarn add vscode-customized-jest-runner
bun add vscode-customized-jest-runner
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.55 |
| Published | 2022-05-08 |
| First published | 2022-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | baymax |
| Maintainers | gqzhang5 |

## Links

- npm: https://www.npmjs.com/package/vscode-customized-jest-runner
- Repository: https://github.com/heiseshandian/vscode-customized-jest-runner
- Homepage: https://github.com/heiseshandian/vscode-customized-jest-runner#readme
- Issues: https://github.com/heiseshandian/vscode-customized-jest-runner/issues
- npm.io page: https://npm.io/package/vscode-customized-jest-runner

## Dependencies (1)

- [jest-editor-support](https://npm.io/package/jest-editor-support.md) ^30.0.2

## Recent versions

- 0.5.55 (latest) — 2022-05-08
- 0.5.54 — 2022-05-08
- 0.5.48 — 2022-03-11
- 0.5.47 — 2022-03-11

## README

# vscode-customized-jest-runner

A customized version of [vscode-jest-runner](https://github.com/firsttris/vscode-jest-runner).

## configs

![Change Configs as below](https://github.com/heiseshandian/vscode-customized-jest-runner/raw/master/public/configs.png)

## Supports

- yarn & vscode workspaces (monorepo)
- dynamic jest config resolution
- yarn 2 pnp
- CRA & and similar abstractions

![Extension Example](https://github.com/heiseshandian/vscode-customized-jest-runner/raw/master/public/vscode-jest.gif)

## 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.runOptions                                                           | Add CLI Options to the Jest Command (e.g. `"jestrunner.runOptions": ["--coverage", "--colors"]`) https://jestjs.io/docs/en/cli   |
| jestrunner.jestCommand                                                          | Define an alternative Jest command (e.g. for Create React App and similar abstractions)                                          |
| jestrunner.disableCodeLens                                                      | Disable CodeLens feature                                                                                                         |
| jestrunner.codeLensSelector                                                     | CodeLens will be shown on files matching this pattern (default \*_/_.{test,spec}.{js,jsx,ts,tsx})                                |
| jestrunner.codeLens                                                             | Choose which CodeLens to enable, default to `["run", "debug"]`                                                                   |
| jestrunner.enableYarnPnpSupport Enable if you are using Yarn 2 with Plug'n'Play |
| jestrunner.yarnPnpCommand                                                       | Command for debugging with Plug'n'Play defaults to yarn-*.*js                                                                    |
| jestrunner.projectPath                                                          | Absolute path to project directory (e.g. /home/me/project/sub-folder)                                                            |
| jestrunner.changeDirectoryToWorkspaceRoot                                       | Changes directory to workspace root before executing the test                                                                    |
| jestrunner.preserveEditorFocus                                                  | Preserve focus on your editor instead of focusing the terminal on test run                                                       |

## Shortcuts

click File -> Preferences -> Keyboard Shortcuts -> "{}" (top right)
the json config file will open
add this:

```javascript
{
  "key": "alt+1",
  "command": "extension.runJest"
},
{
  "key": "alt+2",
  "command": "extension.debugJest"
},
{
  "key": "alt+3",
  "command": "extension.watchJest"
},
```

## Want to start contributing features?

[Some open topics get you started](https://github.com/firsttris/vscode-jest-runner/issues)

## Steps to run in development mode

- npm install
- Go to Menu "Run" => "Start Debugging"

Another vscode instance will open with the just compiled extension installed.

## Notes from contributors

- Babel compile Issue when starting Debug in JSX/TSX,

  - check the post of @Dot-H https://github.com/firsttris/vscode-jest-runner/issues/136
  - https://github.com/firsttris/vscode-jest-runner/issues/174

- 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](https://jestjs.io/docs/en/configuration)

- If Breakspoints are not working properly, try adding this to vscode config:

```javascript
"jestrunner.debugOptions": {
    "args": ["--no-cache"],
    "sourcemaps": "inline",
    "disableOptimisticBPs": true,
}
```

---
_Source: https://npm.io/package/vscode-customized-jest-runner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._