Skip to content

Commit

Permalink
prepare for v6.2.3 release
Browse files Browse the repository at this point in the history
  • Loading branch information
connectdotz committed Mar 15, 2024
1 parent cd6a4dc commit bc3b05d
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 25 deletions.
36 changes: 11 additions & 25 deletions README.md
Expand Up @@ -389,7 +389,7 @@ This setting can be one of the predefined types or a custom object.


<a id="outputconfig-conflict"></a>
**Handling Conflicts with "TEST RESULTS" panel**
**Handling Conflicts with "TEST RESULTS" panel setting**

_The Problem_

Expand All @@ -411,32 +411,18 @@ _Validation and Diagnosis_

The extension features output config diagnosis information in the jest terminal, as well as the built-in conflict detection and quick fixes to assist with the transition.

<a id="outputconfig-issues"></a>
**Common Issues**
<a id="default-output-focus"></a>
**Default Output Focus Behavior by RunMode**
When none of the output settings (`"testing.openTesting"` and `"jest.outputConfig"`) are present, The default output behavior is determined by [runMode](#runmode):

Upon upgrading to v6.2, some users, frequently with auto run modes (e.g., 'watch', 'on-save'), might experience frequent "TEST RESULTS" panel automatically grabbing focus whenever files are saved or tests are run.
| runMode| auto reveal "TEST RESULTS" | auto reveal "TERMINAL" |
|:--:|:--:|:--:|
| "watch" | :heavy_multiplication_x: | :heavy_multiplication_x:|
| "on-save" | :heavy_multiplication_x: | :heavy_multiplication_x: |
| "on-demand" | :heavy_check_mark: | :heavy_multiplication_x:|

> [!NOTE]
>
> **update**
> In version 6.2.3, we've resolved this issue by modifying the default auto-focus behavior so the 'TEST RESULTS' panel will not automatically grab focus in auto-run modes, particularly when `"testing.openTesting"` and `"jest.outputConfig"` settings are not specified. This change should completely eliminate this issue.
>
>
<details>

<summary>Previous Workaround</summary>

This is due to the extension generates a default `jest.outputConfig`, if none is existing in your settings, to match the existing `testing.openTesting` setting, which defaults to `"openOnTestStart"`. If this is not your desired output experience, you can easily disable `testing.openTesting` in your settings.json:
```json
"testing.openTesting": "neverOpen"
```
Then use the `jest.outputConfig` to find-tune the output experience you prefer.

</details>


**Examples**
**Configuration Examples**
- Choose a passive output experience that is identical to the previous version: no automatic focus switch, no automatic clear.
```json
"testing.openTesting": "neverOpen",
Expand All @@ -447,7 +433,7 @@ Then use the `jest.outputConfig` to find-tune the output experience you prefer.
"testing.openTesting": "neverOpen",
"jest.outputConfig": "terminal-based"
```
- Choose a test-results-based experience and switch focus to it when test fails.
- Choose a test-results-based experience and switch focus to it only when test fails.
```json
"testing.openTesting": "neverOpen",
"jest.outputConfig": {
Expand Down
9 changes: 9 additions & 0 deletions release-notes/release-note-v6.md
Expand Up @@ -3,6 +3,7 @@
Release Notes <!-- omit in toc -->
---

- [v6.2.3](#v623)
- [v6.2.2](#v622)
- [CHANGELOG](#changelog)
- [v6.2.1](#v621)
Expand Down Expand Up @@ -35,6 +36,14 @@ Release Notes <!-- omit in toc -->

---

## v6.2.3
This release is a patch release with the following changes:

**Enhancement**

- Improve output-focus default behavior for auto runs (e.g., "watch", "on-save"). This will eliminate the issue that the focus auto switching to "TEST RESULTS" panel whenever files are saved in auto-run modes. Now the default behavior is runMode aware and will not auto switch for auto runs unless specifically configured to do so. See [default output focus behavior](https://github.com/jest-community/vscode-jest#default-output-focus). ([#1128](https://github.com/jest-community/vscode-jest/pull/1128) - @connectdotz)
- docs: update README to fix jest run mode type. ([#1126](https://github.com/jest-community/vscode-jest/pull/1126) - @kota-kamikawa)

## v6.2.2
This release is a patch release with the following changes:

Expand Down
1 change: 1 addition & 0 deletions src/extension-manager.ts
Expand Up @@ -531,6 +531,7 @@ export class ExtensionManager {

const ReleaseNoteBase = 'https://github.com/jest-community/vscode-jest/blob/master/release-notes';
const ReleaseNotes: Record<string, string> = {
'6.2.3': `${ReleaseNoteBase}/release-note-v6.md#v623`,
'6.2.2': `${ReleaseNoteBase}/release-note-v6.md#v622`,
'6.2.0': `${ReleaseNoteBase}/release-note-v6.md#v620`,
'6.1.0': `${ReleaseNoteBase}/release-note-v6.md#v610-pre-release`,
Expand Down

0 comments on commit bc3b05d

Please sign in to comment.