feat: Add mise.configureExtensionsAutomaticallyIncludeList setting

Author: hverlin

README.md

@@ -33,7 +33,10 @@ to use tools provided by `mise` in your current project.
 - [Open VSX Registry](https://open-vsx.org/extension/hverlin/mise-vscode)
 
 > [!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 setup.
+> 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.
+> 
+> You can access the settings by clicking on the mise extension indicator in the status bar.
 
 ## ✨ Features
 
@@ -62,7 +65,7 @@ The mise-vscode extension integrates mise's core functionality into VS Code, hel
 - 📱 Show tools which are not installed or active
 - 📦 Install/Remove/Use tools directly from the sidebar
 - 🔧 Configure your other VSCode extensions to use tools provided by `mise`
-  ([list of supported extensions](https://hverlin.github.io/mise-vscode/reference/supported-extensions/))
+  ([list of supported extensions](https://hverlin.github.io/mise-vscode/reference/supported-extensions/)). See the [set-up guide](https://hverlin.github.io/mise-vscode/tutorials/settinguptheextension/) for more information.
 
 <video src="https://github.com/user-attachments/assets/c2ad5e60-f011-46a4-8e1b-1da4264f0d09"></video>
 

docs/src/content/docs/tutorials/Getting-Started.mdx

@@ -25,4 +25,5 @@ The extension should now be activated. You can access the features using:
 ![]( ../../../../../screenshots/mise-vscode-screenshot.png)
 
 
-Everything should work if your `mise` setup is standard. Read the next section on [how to customize the extension to your needs](/mise-vscode/tutorials/settinguptheextension/).
+Everything should work out of the box if your `mise` setup is standard.
+Read the next section on [how to customize the extension to your needs](/mise-vscode/tutorials/settinguptheextension/).

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

@@ -35,10 +35,68 @@ However, there are some challenges with sharing `.vscode/settings.json`:
 
 Ideally, VS Code should support a `settings.local.json` file that would be ignored by git. See [this issue](https://github.com/microsoft/vscode/issues/40233) for more information.
 
-If you want to share some settings with others, a good workaround is to create a `settings.shared.json` file that other can use as a reference. You can also create a `mise` task to populate the `settings.json` file with the content of `settings.shared.json` if needed.
+If you want to share some settings with others, here are some good workarounds:
+  - Git ignore the `.vscode/settings.json` file. Create a `settings.shared.json` file that other can use as a reference. Set up a `mise` task to populate your `settings.json` file with the content of `settings.shared.json` if needed.
+  - Use extension such as [workspace-config-plus](https://github.com/swellaby/vscode-workspace-config-plus) to have a `settings.local.json` file that is ignored by git.
 
 </details>
 
+#### Controlling which extensions are configured automatically
+
+You can control which supported extensions are automatically configured by mise-vscode using the following settings in your VS Code settings (user or workspace):
+
+- [`mise.configureExtensionsAutomaticallyIgnoreList`](/mise-vscode/reference/settings/#miseconfigureextensionsautomaticallyignorelist): List of extensions that should **not** be configured automatically.
+- [`mise.configureExtensionsAutomaticallyIncludeList`](/mise-vscode/reference/settings/#miseconfigureextensionsautomaticallyincludelist): List of extensions that **should** be configured automatically.
+
+**How it works:**
+- If the **include** list is set and non-empty, only extensions in this list are considered for automatic configuration.
+- If both **include** and **ignore** lists are set, the ignore list takes precedence (extensions in the ignore list are always excluded).
+- If the **include** list contains `"all"`, all supported extensions are considered (except those in the ignore list).
+- If the **include** list is empty or not set, no extensions are configured automatically, and the extension will not modify your `.vscode/settings.json` file.
+- If [`mise.configureExtensionsAutomatically`](/mise-vscode/reference/settings/#miseconfigureextensionsautomatically) is set to `false`, no extensions will be configured automatically, regardless of the include or ignore lists.
+
+You can find the full list of supported extensions in the [Supported Extensions](/mise-vscode/reference/supported-extensions/) documentation.
+
+Example usage in your `settings.json`:
+
+```json
+{
+  "mise.configureExtensionsAutomaticallyIncludeList": ["ms-python.python", "golang.go"],
+  "mise.configureExtensionsAutomaticallyIgnoreList": ["denoland.vscode-deno"]
+}
+```
+
+This will configure only Python and Go extensions, and will always ignore Deno, even if it is in the include list.
+
+#### Advanced: Fine-grained control with user and workspace settings
+
+You can take advantage of VS Code's user and workspace settings to control which extensions are configured automatically at different levels.
+For example, you can set a global default at the **user** level and then override it at the **workspace** level for specific projects.
+
+This allows you to have a flexible setup where you can control which extensions are configured automatically based on your needs.
+
+To do this, set the `mise.configureExtensionsAutomaticallyIncludeList` to an empty array at the **user** level, and then specify the desired extensions at the **workspace** level in your `.vscode/settings.json` file.
+
+**User settings (`settings.json`):**
+```json
+{
+  "mise.configureExtensionsAutomaticallyIncludeList": []
+}
+```
+
+**Workspace settings (`.vscode/settings.json`):**
+```json
+{
+    "mise.configureExtensionsAutomaticallyIncludeList": [
+        "denoland.vscode-deno"
+    ]
+}
+```
+
+With this setup, only the deno extensions will be configured automatically for your project. However, if you open another project that does not specify the `mise.configureExtensionsAutomaticallyIncludeList`, no extensions will be configured automatically.
+
+**Note that updating this setting might require you to reload the VS Code window for the changes to take effect.**
+
 ### Automatic loading of environment variables
 
 The extension will load the environment variables provided by `mise` and update the VS Code process with them.

package.json

@@ -158,6 +158,37 @@
 					},
 					"markdownDescription": "List of extensions that should not be configured automatically."
 				},
+				"mise.configureExtensionsAutomaticallyIncludeList": {
+					"order": 5.1,
+					"type": "array",
+					"default": ["all"],
+					"items": {
+						"type": "string",
+						"enum": [
+							"all",
+							"ms-python.python",
+							"denoland.vscode-deno",
+							"charliermarsh.ruff",
+							"golang.go",
+							"oven.bun-vscode",
+							"oracle.oracle-java",
+							"redhat.java",
+							"vscjava.vscode-gradle",
+							"salesforce.salesforcedx-vscode-apex",
+							"timonwong.shellcheck",
+							"ms-vscode.js-debug",
+							"vscode.php-language-features",
+							"xdebug.php-debug",
+							"julialang.language-julia",
+							"pgourlain.erlang",
+							"Dart-Code.dart-code",
+							"dart-code.flutter",
+							"ziglang.vscode-zig",
+							"signageos.signageos-vscode-sops"
+						]
+					},
+					"markdownDescription": "List of extensions that should be configured automatically. If both include and ignore lists are set, the ignore list takes precedence. If the include list includes 'all' (default), all supported extensions are considered except those in the ignore list."
+				},
 				"mise.configureExtensionsUseShims": {
 					"order": 6,
 					"type": "boolean",

src/configuration.ts

@@ -12,6 +12,8 @@ export const CONFIGURATION_FLAGS = {
 	configureExtensionsUseSymLinks: "configureExtensionsUseSymLinks",
 	configureExtensionsAutomaticallyIgnoreList:
 		"configureExtensionsAutomaticallyIgnoreList",
+	configureExtensionsAutomaticallyIncludeList:
+		"configureExtensionsAutomaticallyIncludeList",
 	enableCodeLens: "enableCodeLens",
 	showToolVersionsDecorations: "showToolVersionsDecorations",
 	showOutdatedToolGutterDecorations: "showOutdatedToolGutterDecorations",
@@ -43,6 +45,13 @@ export const getIgnoreList = (): string[] => {
 	);
 };
 
+export const getIncludeList = (): string[] => {
+	return getConfOrElse(
+		CONFIGURATION_FLAGS.configureExtensionsAutomaticallyIncludeList,
+		[],
+	);
+};
+
 export const shouldConfigureExtensionsAutomatically = (): boolean => {
 	return getConfOrElse(
 		CONFIGURATION_FLAGS.configureExtensionsAutomatically,

src/miseService.ts

@@ -805,7 +805,7 @@ export class MiseService {
 				"self_update_available value from mise dr:",
 				miseConfig.self_update_available,
 			);
-			return !miseConfig.self_update_available;
+			return miseConfig.self_update_available;
 		}
 
 		const isSelfUpdateDisabled = await this.isSelfUpdateDisabled();

src/package-json.test.ts

@@ -17,4 +17,19 @@ describe("package.json configuration tests", () => {
 
 		expect(ignoreListOptions).toEqual(supportedExtensionNames);
 	});
+
+	test("include list should be correct", () => {
+		const supportedExtensionNames = [
+			...new Set(
+				SUPPORTED_EXTENSIONS.map((extension) => extension.extensionId),
+			),
+		];
+
+		const includeListOptions =
+			packageJson.contributes.configuration.properties[
+				"mise.configureExtensionsAutomaticallyIncludeList"
+			].items.enum;
+
+		expect(includeListOptions).toEqual(["all"].concat(supportedExtensionNames));
+	});
 });

src/providers/toolsProvider.ts

@@ -16,6 +16,7 @@ import {
 } from "../commands";
 import {
 	getIgnoreList,
+	getIncludeList,
 	isMiseExtensionEnabled,
 	shouldUseShims,
 	shouldUseSymLinks,
@@ -617,7 +618,10 @@ export function registerToolsCommands(
 		),
 		vscode.commands.registerCommand(MISE_CONFIGURE_ALL_SKD_PATHS, async () => {
 			await miseService.miseReshim();
+
 			const ignoreList = getIgnoreList();
+			const includeList = getIncludeList();
+
 			const tools = await miseService.getCurrentTools();
 			const configurableTools = tools.filter((tool) => {
 				const configurableExtensions = CONFIGURABLE_EXTENSIONS_BY_TOOL_NAME.get(
@@ -628,9 +632,20 @@ export function registerToolsCommands(
 				}
 
 				return configurableExtensions.some((configurableExtension) => {
-					return ignoreList.includes(configurableExtension.extensionId)
-						? false
-						: vscode.extensions.getExtension(configurableExtension.extensionId);
+					if (ignoreList.includes(configurableExtension.extensionId)) {
+						return false;
+					}
+
+					if (
+						!includeList.includes(configurableExtension.extensionId) &&
+						!includeList.includes("all")
+					) {
+						return false;
+					}
+
+					return vscode.extensions.getExtension(
+						configurableExtension.extensionId,
+					);
 				});
 			});