feat!: Set mise.configureExtensionsAutomatically to false by default

Author: hverlin

README.md

@@ -44,7 +44,7 @@ The extension will notify you if neither is installed.
 
 > [!NOTE]
 > The extension includes default settings that you might want to change. See the [configuration guide](https://hverlin.github.io/mise-vscode/tutorials/settinguptheextension/) to customize your set-up.
-> For example, you can choose to disable automatic configuration of other extensions or change the path to the `mise` binary.
+> For example, you can choose to enable/disable automatic configuration of other extensions or change the path to the `mise` binary.
 > 
 > You can access the settings by clicking on the mise extension indicator in the status bar.
 

docs/src/content/docs/reference/Settings.md

@@ -50,9 +50,11 @@ Mise environment to use. (https://mise.jdx.dev/configuration/environments.html)
 
 ##### `mise.configureExtensionsAutomatically`
 - **Type:** `boolean`
-- **Default:** `true`
+- **Default:** `false`
+
+Automatically configure extensions for the current workspace. ([list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions)).
 
-Automatically configure extensions for the current workspace. ([list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions))
+This will modify your workspace settings (`.vscode/settings.json`). You can use the ignore/include lists settings to customize which extensions are configured.
 
 ---
 
@@ -143,11 +145,11 @@ This is useful if you share the `.vscode/settings.json` file with others. When t
 
 ---
 
-##### `mise.enableCodeLens`
+##### `mise.checkForNewMiseVersion`
 - **Type:** `boolean`
 - **Default:** `true`
 
-Show run/add tool code lens indicators in the editor.
+Check if a new mise version is available on startup.
 
 ---
 
@@ -159,11 +161,11 @@ Show tool versions in the editor. (requires reload)
 
 ---
 
-##### `mise.checkForNewMiseVersion`
+##### `mise.enableCodeLens`
 - **Type:** `boolean`
 - **Default:** `true`
 
-Check if a new mise version is available on startup.
+Show run/add tool code lens indicators in the editor.
 
 ---
 
@@ -195,7 +197,7 @@ Update terminal environment variables automatically based on the mise configurat
 - **Type:** `boolean`
 - **Default:** `true`
 
-Enable experimental Tera auto-completion in `mise.toml` files.
+Enable Tera auto-completion in `mise.toml` files.
 
 ---
 

docs/src/content/docs/tutorials/SettingUpTheExtension.mdx

@@ -17,19 +17,19 @@ This might not work for you so make sure to update it manually if needed. You ca
 
 ### Automatic configuration of VS Code extensions
 
-By default, this extension will modify your `.vscode/settings.json` file so that [other extensions](/mise-vscode/reference/supported-extensions/) you use will use the tools you installed with `mise`.
+In order for some VS Code extensions to use the tools installed by `mise`, they need to be configured to point to the correct tool paths.
+This is usually done by updating your workspace's `.vscode/settings.json` file with the correct paths to the tools installed by `mise` or by ensuring that VS Code reads your `PATH` (see [IDE Integration documentation](https://mise.jdx.dev/ide-integration.html#adding-shims-to-path-default-shell)).
 
-**This might be a problem if you are sharing the `.vscode/settings.json` file with others.** (e.g., in a Git repository)
+By default, this extension **will not** automatically modify your `.vscode/settings.json` file.
 
-- This can be [turned off](/mise-vscode/reference/settings/#miseconfigureextensionsautomatically) if you don't want this behavior.
-- Alternatively, you can configure the extension to create symlinks to tools so that the settings points to a relative path in your project. Use [`mise.configureExtensionsUseSymLinks`](/mise-vscode/reference/settings/#miseconfigureextensionsusesymlinks) for this.
+You can [enable automatic configuration](/mise-vscode/reference/settings/#miseconfigureextensionsautomatically) so that [other extensions](/mise-vscode/reference/supported-extensions/) you use will automatically use the tools you installed with `mise`.
+
+**If you enable this feature and are sharing the `.vscode/settings.json` file with others** (e.g., in a Git repository), you may want to configure the extension to create symlinks to tools so that the settings point to a relative path in your project. Use [`mise.configureExtensionsUseSymLinks`](/mise-vscode/reference/settings/#miseconfigureextensionsusesymlinks) for this. Note that I consider that sharing the `.vscode/settings.json` file is not a good idea in general (see details below).
 
 <details>
 <summary>About sharing `.vscode/settings.json`</summary>
 
-If you are sharing the `.vscode/settings.json` file with others, you might think that the default value of this extension is not a good idea.
-
-However, there are some challenges with sharing `.vscode/settings.json`:
+If you enable automatic configuration and are sharing the `.vscode/settings.json` file with others, be aware of some challenges:
   - If you use extensions other members of your team don't have, you won't be able to update the settings file without conflicts.
   - If you would like some settings to be different for different members of your team, you won't be able to do so.
 

package.json

@@ -119,6 +119,34 @@
 				}
 			}
 		],
+		"walkthroughs": [
+			{
+				"id": "mise-getting-started",
+				"title": "Mise VSCode setup",
+				"description": "Important steps to get started with the Mise VSCode extension.",
+                "when": "!isWeb",
+                "steps": [
+					{
+						"id": "auto-configure",
+						"title": "Auto-Configure Extensions",
+						"description": "Choose whether to automatically configure VSCode extensions to use tools from mise.\n[Open settings](command:mise.openExtensionSettings)",
+						"media": {
+							"markdown": "walkthrough/auto-configure.md"
+						},
+                        "when": "!isWeb"
+					},
+					{
+						"id": "explore",
+						"title": "Tips for using Mise VSCode",
+						"description": "Open the mise panel to see tools, tasks and environment variables.\n[Open Mise Panel](command:workbench.view.extension.mise-panel)",
+						"media": {
+							"markdown": "walkthrough/explore.md"
+						},
+                        "when": "!isWeb"
+					}
+				]
+			}
+		],
 		"snippets": [
 			{
 				"language": "toml",
@@ -152,8 +180,8 @@
 				"mise.configureExtensionsAutomatically": {
 					"order": 4,
 					"type": "boolean",
-					"default": true,
-					"markdownDescription": "Automatically configure extensions for the current workspace. ([list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions))"
+					"default": false,
+					"markdownDescription": "Automatically configure extensions for the current workspace. ([list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions)).\n\nThis will modify your workspace settings (`.vscode/settings.json`). You can use the ignore/include lists settings to customize which extensions are configured."
 				},
 				"mise.configureExtensionsAutomaticallyIgnoreList": {
 					"order": 5,
@@ -240,27 +268,27 @@
 					"default": false,
 					"markdownDescription": "Create symlinks in your `.vscode` folder that links to the `mise` bin.\n\nThis is useful if you share the `.vscode/settings.json` file with others. When the project is version controlled:\n- every user must have the extension installed\n- the directory `.vscode/mise-tools` must be excluded from version control."
 				},
-				"mise.enableCodeLens": {
-					"order": 8,
-					"type": "boolean",
-					"title": "Enable code lens",
-					"default": true,
-					"markdownDescription": "Show run/add tool code lens indicators in the editor."
-				},
+                "mise.checkForNewMiseVersion": {
+                  "order": 8,
+                  "type": "boolean",
+                  "title": "Check for new mise version",
+                  "default": true,
+                  "markdownDescription": "Check if a new mise version is available on startup."
+                },
 				"mise.showToolVersionsDecorations": {
 					"order": 9,
 					"type": "boolean",
 					"title": "Show tool versions",
 					"default": true,
 					"markdownDescription": "Show tool versions in the editor. (requires reload)"
 				},
-				"mise.checkForNewMiseVersion": {
-					"order": 10,
-					"type": "boolean",
-					"title": "Check for new mise version",
-					"default": true,
-					"markdownDescription": "Check if a new mise version is available on startup."
-				},
+                "mise.enableCodeLens": {
+                  "order": 10,
+                  "type": "boolean",
+                  "title": "Enable code lens",
+                  "default": true,
+                  "markdownDescription": "Show run/add tool code lens indicators in the editor."
+                },
 				"mise.showNotificationIfMissingTools": {
 					"order": 11,
 					"type": "boolean",
@@ -287,7 +315,7 @@
 					"type": "boolean",
 					"title": "Enable Tera auto-completion",
 					"default": true,
-					"markdownDescription": "Enable experimental Tera auto-completion in `mise.toml` files."
+					"markdownDescription": "Enable Tera auto-completion in `mise.toml` files."
 				},
 				"mise.automaticallyTrustMiseConfigFiles": {
 					"order": 15,

src/commands.ts

@@ -1,4 +1,4 @@
-export const MISE_CONFIGURE_ALL_SKD_PATHS = "mise.configureAllSdkPaths";
+export const MISE_CONFIGURE_ALL_SDK_PATHS = "mise.configureAllSdkPaths";
 export const MISE_CONFIGURE_SDK_PATH = "mise.configureSdkPath";
 export const MISE_COPY_ENV_VARIABLE_NAME = "mise.copyEnvVariableName";
 export const MISE_COPY_ENV_VARIABLE_VALUE = "mise.copyEnvVariableValue";
@@ -40,3 +40,4 @@ export const MISE_SHOW_ENV_VARIABLE_VALUE = "mise.showEnvVariableValue";
 export const MISE_HIDE_ENV_VARIABLE_VALUE = "mise.hideEnvVariableValue";
 export const MISE_DISPLAY_PATH = "mise.displayPath";
 export const MISE_DOCTOR = "mise.doctor";
+export const MISE_ENABLE_AUTO_CONFIGURATION = "mise.enableAutoConfiguration";

src/configuration.ts

@@ -59,6 +59,14 @@ export const shouldConfigureExtensionsAutomatically = (): boolean => {
 	);
 };
 
+export const enableAutoConfiguration = async () => {
+	return getExtensionConfig().update(
+		CONFIGURATION_FLAGS.configureExtensionsAutomatically,
+		true,
+		vscode.ConfigurationTarget.Global,
+	);
+};
+
 export const shouldUseShims = () => {
 	return getConfOrElse(CONFIGURATION_FLAGS.configureExtensionsUseShims, true);
 };

src/miseExtension.ts

@@ -3,10 +3,11 @@ import { createCache } from "async-cache-dedupe";
 import vscode, { MarkdownString } from "vscode";
 import { version } from "../package.json";
 import {
-	MISE_CONFIGURE_ALL_SKD_PATHS,
+	MISE_CONFIGURE_ALL_SDK_PATHS,
 	MISE_DISMISS_MISSING_TOOLS_WARNING,
 	MISE_DOCTOR,
 	MISE_EDIT_SETTING,
+	MISE_ENABLE_AUTO_CONFIGURATION,
 	MISE_FMT,
 	MISE_LIST_ALL_TOOLS,
 	MISE_MISSING_TOOLS_MENU,
@@ -22,6 +23,7 @@ import {
 } from "./commands";
 import {
 	CONFIGURATION_FLAGS,
+	enableAutoConfiguration,
 	getConfiguredBinPath,
 	getCurrentWorkspaceFolder,
 	getMiseEnv,
@@ -151,6 +153,19 @@ export class MiseExtension {
 			),
 		);
 
+		context.subscriptions.push(
+			vscode.commands.registerCommand(
+				MISE_ENABLE_AUTO_CONFIGURATION,
+				async () => {
+					await enableAutoConfiguration();
+					logger.info("Auto-configuration enabled");
+					await vscode.commands.executeCommand(MISE_CONFIGURE_ALL_SDK_PATHS);
+					vscode.window.showInformationMessage(
+						"Mise auto-configuration has been enabled and extensions have been configured.",
+					);
+				},
+			),
+		);
 		const tasksProvider = new MiseTasksProvider(this.miseService);
 		const toolsProvider = new MiseToolsProvider(this.miseService);
 		const envsProvider = new MiseEnvsProvider(this.miseService);
@@ -219,7 +234,7 @@ export class MiseExtension {
 					shouldConfigureExtensionsAutomatically() &&
 					isMiseExtensionEnabled()
 				) {
-					await vscode.commands.executeCommand(MISE_CONFIGURE_ALL_SKD_PATHS);
+					await vscode.commands.executeCommand(MISE_CONFIGURE_ALL_SDK_PATHS);
 				}
 
 				this.updateStatusBar({ state: "ready" });

src/providers/toolsProvider.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import {
-	MISE_CONFIGURE_ALL_SKD_PATHS,
+	MISE_CONFIGURE_ALL_SDK_PATHS,
 	MISE_CONFIGURE_SDK_PATH,
 	MISE_COPY_TOOL_BIN_PATH,
 	MISE_COPY_TOOL_INSTALL_PATH,
@@ -616,7 +616,7 @@ export function registerToolsCommands(
 				}
 			},
 		),
-		vscode.commands.registerCommand(MISE_CONFIGURE_ALL_SKD_PATHS, async () => {
+		vscode.commands.registerCommand(MISE_CONFIGURE_ALL_SDK_PATHS, async () => {
 			await miseService.miseReshim();
 
 			const ignoreList = getIgnoreList();

walkthrough/auto-configure.md

@@ -0,0 +1,18 @@
+# Welcome to Mise VSCode! 👋
+
+This extension brings Mise support directly into Visual Studio Code. 
+- Syntax highlighting, autocompletion and go-to-definition for `mise.toml` files
+- tools, tasks, and environment variables available directly from the sidebar
+- Ability to autoconfigure other extensions to use tools from mise.
+
+# Auto-Configure Extensions
+
+One of the main features of this extension is the ability to **automatically configure other VSCode extensions** to use tools managed by mise.
+
+When enabled, the extension will automatically update your `.vscode/settings.json` file to configure supported VSCode extensions.
+See [the list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions).
+
+To enable this feature, simply click this button:
+**[Enable Auto-Configuration](command:mise.enableAutoConfiguration)**
+
+You can always change this setting later in the [extension settings](command:mise.openExtensionSettings).

walkthrough/explore.md

@@ -0,0 +1,15 @@
+## Documentation
+
+You can find the full documentation for the Mise VSCode extension at [hverlin.github.io/mise-vscode/](https://hverlin.github.io/mise-vscode/).
+
+## 🛠️ Mise panel
+
+[Open the **Mise** panel in the Activity Bar](command:workbench.view.extension.mise-panel) to run tasks, install tools, and view environment variables directly from the sidebar
+
+## Quick actions
+Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the command palette, then type `Mise` to see all available commands provided by the extension.
+
+## Mise command menu 
+
+This extension provides a command menu accessible via the bottom status bar or the command palette: [Command Menu](command:mise.openMenu).
+