From bab26b45414f1d7e5ef10c6301253b30e07932b6 Mon Sep 17 00:00:00 2001 From: Patrick McElhaney Date: Wed, 21 Feb 2024 16:13:01 -0500 Subject: [PATCH] Minor docs updates for the migration guides (#1116) --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ea75d2a5..972e31db 100644 --- a/README.md +++ b/README.md @@ -444,22 +444,23 @@ The extension also features built-in conflict detection and quick fixes to assis "clearOnRun": "terminal" } ``` - -**Migration Guide** - - -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: - -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. -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. - -3. **Migration Steps**: - - Use the `"Jest: Save Current Output Config"` command from the command palette to update your settings.json. - - (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)). - - Finally, remove any deprecated settings. - -By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`. +> [!NOTE] +> +> **Migration Guide** +> +> 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: +> +> 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. +> +> 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. +> +> 3. **Migration Steps**: +> - Use the `"Jest: Save Current Output Config"` command from the command palette to update your settings.json. +> - (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)). +> - Finally, remove any deprecated settings. +> +> By following these guidelines, you should be able to smoothly transition to using `"jest.outputConfig"`. --- @@ -563,9 +564,9 @@ Starting from v6.1.0, if no runMode is defined in settings.json, the extension w --- #### autoRun -
- Note: As of v6.1.0, autoRun will be replaced by runMode. For transition details, please refer to the runMode migration. -
+ +> [!WARNING] +> As of v6.1.0, autoRun will be replaced by runMode. For transition details, please refer to the runMode migration. AutoRun controls when tests should be executed automatically. @@ -651,9 +652,8 @@ There are 2 ways to change autoRun: #### testExplorer -
- As of v6.1.0, this setting has been folded into runMode. For transition details, please refer to the runMode migration. -
+> [!WARNING] +> As of v6.1.0, this setting has been folded into runMode. For transition details, please refer to the runMode migration. ```ts testExplorer = {showInlineError?: boolean} @@ -697,9 +697,9 @@ Default is `"jest.monitorLongRun":60000` (1 minute) --- #### autoRevealOutput -
- As of v6.1.0, this setting has been folded into runMode. For transition details, please refer to the runMode migration. -
+ +> [!WARNING] +> As of v6.1.0, this setting has been folded into outputConfig. For transition details, please refer to the outputConfig migration. ```ts autoRevealOutput = "on-run" | "on-exec-error" | "off"