Skip to content

Commit

Permalink
V4.6.0 (#872)
Browse files Browse the repository at this point in the history
  • Loading branch information
connectdotz committed May 26, 2022
1 parent 1432104 commit 8589744
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 23 deletions.
38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
---
## Getting Started

The extension should work out-of-the-box for most common jest projects. To get started:
This extension supports full [jest](https://jestjs.io/) features in vscode environment to make testing more intuitive and fun. It should work out-of-the-box for most common jest projects. To get started:

1. Setup [jest](https://jestjs.io/docs/getting-started) in your project if you haven't.
2. [install](#installation) **"Jest"** extension in vscode.
Expand All @@ -28,17 +28,17 @@ Happy testing!
---

## Release Notes
### Pre-Release: [v4.5.0](https://github.com/jest-community/vscode-jest/releases/tag/v4.5.0) <!-- omit in toc -->
### Stable: [v4.6.0](https://github.com/jest-community/vscode-jest/releases/tag/v4.6.0) <!-- omit in toc -->

<details>
- added a new setting ["jest.showTerminalOnLaunch"](#showTerminalOnLaunch) to control if test explorer terminal should be automatically opened upon launch. Default is true.
- refactor README

<summary>features</summary>

- adding a new setting `jest.showTerminalOnLaunch` to control if test explorer terminal should be automatically opened upon launch. Default is true.

</details>
### Previous Releases <!-- omit in toc -->

### Stable: [v4.4.0](https://github.com/jest-community/vscode-jest/releases/tag/v4.4.0) <!-- omit in toc -->
<details>

<summary>4.4.0</summary>

Interactive run has been extended to watch mode in v4.4.0. Users in watch mode can now run any test/folder/workspace interactively just like with non-watch mode.

Expand Down Expand Up @@ -93,11 +93,10 @@ Other features:
- enhance run/debug tests with quotes in the name.
- update documentations and a few bug fixes.

</details>

More details see [v4.4.0 release](https://github.com/jest-community/vscode-jest/releases/tag/v4.4.0)

### Previous Releases <!-- omit in toc -->
</details>


<details>

Expand Down Expand Up @@ -182,11 +181,6 @@ Content
- [License](#license)

---





## Features

* Starts Jest automatically when you're in a root folder project with Jest installed.
Expand Down Expand Up @@ -280,13 +274,14 @@ Code coverage can be triggered via [Command Palette](https://code.visualstudio.c
![status-bar-modes](images/status-bar-watch-coverage.png)

<details>

<summary>How to read coverage scheme and customize it</summary>

In addition to the coverage summary that is shown on the top of the file, each line will be marked by its coverage status according to the coverage formatter configured. There are 3 types of coverage you might see in your source code, distinguished by colors:

- "covered": if the code is covered. Marked as <span style="color:green">"green"</span> by default.
- "not-covered": if the code is not covered. Marked as <span style="color:red">"red"</span> by default.
- "partially-covered": Usually this mean the branch (such as if, switch statements) only partially tested. Marked as <span style="color:yellow">"yellow"</span> by default.
- "covered": if the code is covered. Either not marked or "green" by default, depends on the formatter.
- "not-covered": if the code is not covered. Marked as "red" by default.
- "partially-covered": Usually this mean the branch (such as if, switch statements) only partially tested. Marked as "yellow" by default.
- _Please note, istanbuljs (the library jest used to generate coverage info) reports switch branch coverage with the first "case" statement instead of the "switch" statement._

![coverage-screen-shot](images/coverage-screen-shot.png)
Expand All @@ -297,7 +292,6 @@ You can customize coverage start up behavior, style and colors, see [customizati

⚠️ In rare cases, coverage info might be less than what it actual is in "watch" mode (with `--watch` flag), where only changed files/tests are run (see facebook/jest#1284).


### How to use the extension with monorepo projects?
The recommended approach is to setup the monorepo project as a [multi-root workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) in vscode. This is a simple one time setup that add each sub package as a "folder" in the workspace.

Expand Down Expand Up @@ -390,7 +384,7 @@ Users can use the following settings to tailor the extension for their environme
|**Misc**|
|debugMode|Enable debug mode to diagnose plugin issues. (see developer console)|false|`"jest.debugMode": true`|
|disabledWorkspaceFolders 💼|Disabled workspace folders names in multiroot environment|[]|`"jest.disabledWorkspaceFolders": ["package-a", "package-b"]`|
|showTerminalOnLaunch 💼|automatically open test explorer terminal on launch (>= v4.5)|true|`"jest.showTerminalOnLaunch": false`|
|<a id="showTerminalOnLaunch"></a>showTerminalOnLaunch 💼|automatically open test explorer terminal on launch (>= v4.5)|true|`"jest.showTerminalOnLaunch": false`|

#### Details
##### jestCommandLine
Expand Down Expand Up @@ -669,4 +663,4 @@ Thanks for considering! Check [here](CONTRIBUTING.md) for useful tips and guidel

## License

vscode-jest is [MIT licensed.](LICENSE)
vscode-jest is [MIT licensed.](LICENSE)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "vscode-jest",
"displayName": "Jest",
"description": "Use Facebook's Jest With Pleasure.",
"version": "4.5.0",
"version": "4.6.0",
"publisher": "Orta",
"engines": {
"vscode": "^1.63.0"
Expand Down

0 comments on commit 8589744

Please sign in to comment.