Skip to content

Commit bab26b4

Browse files
authored
Minor docs updates for the migration guides (#1116)
1 parent ad12488 commit bab26b4

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -444,22 +444,23 @@ The extension also features built-in conflict detection and quick fixes to assis
444444
"clearOnRun": "terminal"
445445
}
446446
```
447-
448-
**Migration Guide**
449-
<a id="outputconfig-migration"></a>
450-
451-
Migrating to the new `"jest.outputConfig"` can require some manual adjustments, especially if you're working in a multi-root workspace. Here are some guidelines to help with the transition:
452-
453-
1. **Workspace Level vs Workspace-Folder Level**: The new `"jest.outputConfig"` is a workspace-level setting, unlike legacy settings like `"jest.autoClearTerminal"` and `"jest.autoRevealOutput"`, which are workspace-folder level settings.
454447

455-
2. **Backward Compatibility**: If no `"jest.outputConfig"` is defined in your settings.json, the extension will attempt to generate a backward-compatible outputConfig in memory. This uses the `"testing.openTesting"` setting and any legacy settings (`"jest.autoClearTerminal"`, `"jest.autoRevealOutput"`) you might have. Note that this might only work for single-root workspaces.
456-
457-
3. **Migration Steps**:
458-
- Use the `"Jest: Save Current Output Config"` command from the command palette to update your settings.json.
459-
- (optional) Fix warning: The save does not include `"testing.openTesting"`, so you might see the conflict warning message. You can either use the "Quick Fix" action or adjust the `settings.json` manually (see [handling conflict](#outputconfig-conflict)).
460-
- Finally, remove any deprecated settings.
461-
462-
By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`.
448+
> [!NOTE]
449+
> <a id="outputconfig-migration"></a>
450+
> **Migration Guide**
451+
>
452+
> Migrating to the new `"jest.outputConfig"` can require some manual adjustments, especially if you're working in a multi-root workspace. Here are some guidelines to help with the transition:
453+
>
454+
> 1. **Workspace Level vs Workspace-Folder Level**: The new `"jest.outputConfig"` is a workspace-level setting, unlike legacy settings like `"jest.autoClearTerminal"` and `"jest.autoRevealOutput"`, which are workspace-folder level settings.
455+
>
456+
> 2. **Backward Compatibility**: If no `"jest.outputConfig"` is defined in your settings.json, the extension will attempt to generate a backward-compatible outputConfig in memory. This uses the `"testing.openTesting"` setting and any legacy settings (`"jest.autoClearTerminal"`, `"jest.autoRevealOutput"`) you might have. Note that this might only work for single-root workspaces.
457+
>
458+
> 3. **Migration Steps**:
459+
> - Use the `"Jest: Save Current Output Config"` command from the command palette to update your settings.json.
460+
> - (optional) Fix warning: The save does not include `"testing.openTesting"`, so you might see the conflict warning message. You can either use the "Quick Fix" action or adjust the `settings.json` manually (see [handling conflict](#outputconfig-conflict)).
461+
> - Finally, remove any deprecated settings.
462+
>
463+
> By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`.
463464
464465
---
465466

@@ -563,9 +564,9 @@ Starting from v6.1.0, if no runMode is defined in settings.json, the extension w
563564
---
564565

565566
#### autoRun
566-
<div style="background-color: yellow; color: black; padding: 10px; border-radius: 5px;">
567-
Note: As of v6.1.0, autoRun will be replaced by <a href="#runmode">runMode</a>. For transition details, please refer to the <a href="#runmode-migration">runMode migration</a>.
568-
</div>
567+
568+
> [!WARNING]
569+
> As of v6.1.0, autoRun will be replaced by <a href="#runmode">runMode</a>. For transition details, please refer to the <a href="#runmode-migration">runMode migration</a>.
569570
570571
AutoRun controls when tests should be executed automatically.
571572

@@ -651,9 +652,8 @@ There are 2 ways to change autoRun:
651652

652653
#### testExplorer
653654

654-
<div style="background-color: yellow; color: black; padding: 10px; border-radius: 5px;">
655-
As of v6.1.0, this setting has been folded into <a href="#runmode">runMode</a>. For transition details, please refer to the <a href="#runmode-migration">runMode migration</a>.
656-
</div>
655+
> [!WARNING]
656+
> As of v6.1.0, this setting has been folded into <a href="#runmode">runMode</a>. For transition details, please refer to the <a href="#runmode-migration">runMode migration</a>.
657657

658658
```ts
659659
testExplorer = {showInlineError?: boolean}
@@ -697,9 +697,9 @@ Default is `"jest.monitorLongRun":60000` (1 minute)
697697
---
698698

699699
#### autoRevealOutput
700-
<div style="background-color: yellow; color: black; padding: 10px; border-radius: 5px;">
701-
As of v6.1.0, this setting has been folded into <a href="#runmode">runMode</a>. For transition details, please refer to the <a href="#runmode-migration">runMode migration</a>.
702-
</div>
700+
701+
> [!WARNING]
702+
> As of v6.1.0, this setting has been folded into <a href="#outputconfig">outputConfig</a>. For transition details, please refer to the <a href="#outputconfig-migration">outputConfig migration</a>.
703703
704704
```ts
705705
autoRevealOutput = "on-run" | "on-exec-error" | "off"

0 commit comments

Comments
 (0)