Skip to content

Commit aba5b93

Browse files
committed
docs: Clarify auto-configuration settings documentation.
1 parent 83609ed commit aba5b93

5 files changed

Lines changed: 57 additions & 45 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,19 @@ The extension will notify you if neither is installed.
4242

4343
## Important Defaults
4444

45-
> [!NOTE]
46-
> 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.
47-
> For example, you can choose to enable/disable automatic configuration of other extensions or change the path to the `mise` binary.
48-
>
49-
> You can access the settings by clicking on the mise extension indicator in the status bar.
45+
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.
46+
47+
For example, you can choose to enable/disable automatic configuration of other extensions or change the path to the `mise` binary.
48+
49+
You can access the settings by clicking on the mise extension indicator in the status bar.
50+
51+
### Enabling/Disabling Auto-Configuration
5052

51-
### Recommended: Disable Global Tools in Auto-Configuration
53+
By default, the extension will not automatically configure other VS Code extensions to use tools provided by `mise` in your current project.
5254

53-
By default, the extension includes tools from your global mise configuration (`~/.config/mise/config.toml`) when auto-configuring other VS Code extensions. This can pollute your project settings with extensions for tools not in your current project.
55+
To enable auto-configuration, set [`mise.configureExtensionsAutomatically`](https://hverlin.github.io/mise-vscode/reference/settings/#miseconfigureextensionsautomatically) to `true`. This will automatically configure other VS Code extensions to use tools provided by `mise` in your current project.
5456

55-
**Recommended setting:** Set `mise.configureExtensionsIncludeGlobalTools` to `false` to only use tools from your local `mise.toml` file. This keeps your `.vscode/settings.json` clean and ensures extensions are only configured for tools actually used in your project.
57+
**Important:** By default, tools from your global mise configuration (`~/.config/mise/config.toml`) are included when auto-configuring other VS Code extensions ([`mise.configureExtensionsIncludeGlobalTools`](https://hverlin.github.io/mise-vscode/reference/settings/#miseconfigureextensionsincludeglobaltools) is `true` for backward compatibility). You can set it to `false` to keep your `.vscode/settings.json` clean and ensure extensions are only configured for tools actually used in your project.
5658

5759
## ✨ Features
5860

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Custom Extensions
3+
description: How to configure any VS Code extension to use mise tools
4+
sidebar:
5+
order: 300
6+
---
7+
8+
You can configure any VS Code extension to use mise tools via settings:
9+
10+
- **`mise.customBinaryExtensions`**: Configure extensions that need a binary path
11+
- **`mise.customFolderExtensions`**: Configure extensions that need a folder path (e.g., JDK home)
12+
13+
Example for binary mode:
14+
15+
```json
16+
{
17+
"mise.customBinaryExtensions": [
18+
{
19+
"extensionId": "example.my-extension",
20+
"toolSources": ["aqua:mytool"],
21+
"vscodeSetting": { "key": "myExtension.toolPath" }
22+
}
23+
]
24+
}
25+
```
26+
27+
Example for folder mode:
28+
29+
```json
30+
{
31+
"mise.customFolderExtensions": [
32+
{
33+
"extensionId": "example.java-extension",
34+
"toolSources": ["jfox:java", "asdf:openjdk"],
35+
"vscodeSetting": { "key": "java.jdkHome" },
36+
"folderName": "custom-jdk"
37+
}
38+
]
39+
}
40+
```
41+
42+
See the [Extension Settings](/mise-vscode/reference/settings/) for full configuration options.

docs/src/content/docs/reference/Supported-extensions.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -46,41 +46,7 @@ Extensions which have built-in support for `mise`:
4646

4747
## Custom Extensions
4848

49-
You can configure any VSCode extension to use mise tools via settings:
50-
51-
- **`mise.customBinaryExtensions`**: Configure extensions that need a binary path
52-
- **`mise.customFolderExtensions`**: Configure extensions that need a folder path (e.g., JDK home)
53-
54-
Example for binary mode:
55-
56-
```json
57-
{
58-
"mise.customBinaryExtensions": [
59-
{
60-
"extensionId": "example.my-extension",
61-
"toolSources": ["aqua:mytool"],
62-
"vscodeSetting": { "key": "myExtension.toolPath" }
63-
}
64-
]
65-
}
66-
```
67-
68-
Example for folder mode:
69-
70-
```json
71-
{
72-
"mise.customFolderExtensions": [
73-
{
74-
"extensionId": "example.java-extension",
75-
"toolSources": ["jfox:java", "asdf:openjdk"],
76-
"vscodeSetting": { "key": "java.jdkHome" },
77-
"folderName": "custom-jdk"
78-
}
79-
]
80-
}
81-
```
82-
83-
See the Extension Settings for full configuration options.
49+
If the extension you're using is not listed above, you can still configure it manually. See the [Custom Extensions Guide](/mise-vscode/guides/custom-extensions/) for more details.
8450

8551
Extensions that are not supported:
8652
- [Rust](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) does not offer to update the cargo path automatically. See [this discussion](https://github.com/hverlin/mise-vscode/discussions/70) for workarounds.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ By default, this extension **will not** automatically modify your `.vscode/setti
2424

2525
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`.
2626

27+
By default, [`mise.configureExtensionsIncludeGlobalTools`](/mise-vscode/reference/settings/#miseconfigureextensionsincludeglobaltools) is `true`, meaning tools from your global mise configuration (`~/.config/mise/config.toml`) are also included. You can set it to `false` if you only want to use tools from the local project configuration.
28+
2729
**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).
2830

2931
<details>

walkthrough/auto-configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ One of the main features of this extension is the ability to **automatically con
1212
When enabled, the extension will automatically update your `.vscode/settings.json` file to configure supported VSCode extensions.
1313
See [the list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions).
1414

15-
> [!IMPORTANT]
16-
> **Recommended:** Set `mise.configureExtensionsIncludeGlobalTools` to `false` to only use tools from your local `mise.toml` file. This prevents your project settings from being polluted with extensions for tools not in your current project.
15+
> [!NOTE]
16+
> By default, `mise.configureExtensionsIncludeGlobalTools` is set to `true` (for backward compatibility), meaning tools from your global configuration (`~/.config/mise/config.toml`) are also included. You can set it to `false` to only use tools from your local `mise.toml` file.
1717
1818
To enable this feature, simply click this button:
1919
**[Enable Auto-Configuration](command:mise.enableAutoConfiguration)**

0 commit comments

Comments
 (0)