You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getstarted/settings.md
+22-10Lines changed: 22 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ PageTitle: Visual Studio Code User and Workspace Settings
7
7
DateApproved: 02/06/2025
8
8
MetaDescription: How to modify Visual Studio Code User and Workspace Settings.
9
9
---
10
-
# User and Workspace Settings
10
+
# User and workspace settings
11
11
12
12
You can configure Visual Studio Code to your liking through its various settings. Nearly every part of VS Code's editor, user interface, and functional behavior has options you can modify.
13
13
@@ -34,7 +34,8 @@ You can access your user settings in a few ways:
34
34
35
35
Workspace settings are specific to a project and override user settings. If you have specific settings that you want to apply to a specific project, you can use workspace settings. For example, for a backend server project, you might want to set the `files.exclude` setting to exclude the `node_modules` folder from the File Explorer.
36
36
37
-
>**Note**: A VS Code "workspace" is usually just your project root folder. You can also have more than one root folder in a VS Code workspace through a feature called [Multi-root workspaces](/docs/editor/workspaces/multi-root-workspaces.md). Get more info about [VS Code workspaces](/docs/editor/workspaces/workspaces.md).
37
+
> [!NOTE]
38
+
> A VS Code "workspace" is usually just your project root folder. You can also have more than one root folder in a VS Code workspace through a feature called [Multi-root workspaces](/docs/editor/workspaces/multi-root-workspaces.md). Get more info about [VS Code workspaces](/docs/editor/workspaces/workspaces.md).
38
39
39
40
VS Code stores workspace settings at the root of the project in a `.vscode` folder. This makes it easy to share settings with others in a version-controlled (for example, Git) project.
40
41
@@ -66,7 +67,8 @@ The gear icon alongside the setting (`kb(settings.action.showContextMenu)`) open
> **Tip**: A settings URL enables you to navigate directly to a specific setting in the Settings editor from the browser. The URL is in the format `vscode://settings/<settingName>`, where `<settingName>` is the ID of the setting you want to navigate to. For example, to navigate to the `workbench.colorTheme` setting, use the URL `vscode://settings/workbench.colorTheme`.
70
+
> [!TIP]
71
+
> A settings URL enables you to navigate directly to a specific setting in the Settings editor from the browser. The URL is in the format `vscode://settings/<settingName>`, where `<settingName>` is the ID of the setting you want to navigate to. For example, to navigate to the `workbench.colorTheme` setting, use the URL `vscode://settings/workbench.colorTheme`.
70
72
71
73
### Settings groups
72
74
@@ -76,7 +78,8 @@ In the following example, the source control settings are focused by selecting *
76
78
77
79

78
80
79
-
> **Note**: VS Code extensions can also add their own custom settings, and those settings are visible under an **Extensions** section.
81
+
> [!NOTE]
82
+
> VS Code extensions can also add their own custom settings, and those settings are visible under an **Extensions** section.
80
83
81
84
### Settings editor filters
82
85
@@ -138,7 +141,8 @@ Some settings can only be edited in `settings.json` such as **Workbench: Color C
138
141
139
142

140
143
141
-
> **Tip**: If you prefer to always work directly with `settings.json`, you can set `setting(workbench.settings.editor)` to `json`. Then, **File** > **Preferences** > **Settings** and the keybinding `kb(workbench.action.openSettings)` always open the `settings.json` file and not the Setting editor UI.
144
+
> [!TIP]
145
+
> If you prefer to always work directly with `settings.json`, you can set `setting(workbench.settings.editor)` to `json`. Then, **File** > **Preferences** > **Settings** and the keybinding `kb(workbench.action.openSettings)` always open the `settings.json` file and not the Setting editor UI.
142
146
143
147
### Settings file locations
144
148
@@ -156,7 +160,8 @@ The workspace settings file is located under the `.vscode` folder in your root f
156
160
157
161

158
162
159
-
> **Note:** For a [Multi-root Workspace](/docs/editor/workspaces/multi-root-workspaces.md#settings), workspace settings are located inside the workspace configuration file.
163
+
> [!NOTE]
164
+
> For a [Multi-root Workspace](/docs/editor/workspaces/multi-root-workspaces.md#settings), workspace settings are located inside the workspace configuration file.
160
165
161
166
## Reset settings
162
167
@@ -173,7 +178,8 @@ For example, when modifying the user-scope `setting(diffEditor.codeLens)` settin
173
178
174
179

175
180
176
-
>**Note:** If you enter more than one language filter in the search widget, the current behavior is that only the first language filter will be used.
181
+
> [!NOTE]
182
+
> If you enter more than one language filter in the search widget, the current behavior is that only the first language filter will be used.
177
183
178
184
Another way to customize your editor by language is by running the global command **Preferences: Configure Language Specific Settings** (command ID: `workbench.action.configureLanguageBasedSettings`) from the **Command Palette** (`kb(workbench.action.showCommands)`) which opens the language picker. Select the language you want. Then, the Settings editor opens with a language filter for the selected language, which allows you to modify language-specific settings for that language. Though, if you have the `setting(workbench.settings.editor)` setting set to `json`, then the `settings.json` file opens with a new language entry where you can add applicable settings.
179
185
@@ -233,14 +239,19 @@ You can use [profiles in VS Code](/docs/editor/profiles.md) to create sets of cu
233
239
234
240
When you switch to a profile, the user settings are scoped to only that profile. When you switch to another profile, the user settings of that other profile are applied. This way, you can have different settings for different profiles.
235
241
236
-
If you're using a non-default profile, you notice that there is a **Preferences: Open Application Settings (JSON)** command in the Command Palette (`kb(workbench.action.showCommands)`). This command opens the user `settings.json` file that is associated with default profile.
237
-
238
242
The user settings JSON file for a profile is located in the following directory:
The `<profile ID>` is the unique identifier of the profile. For each profile that overrides settings, there will be a corresponding profile settings file.
249
+
250
+
> [!NOTE]
251
+
> The `settings.json` file for a profile is only created when you modify a setting for that profile.
252
+
253
+
When you're using a non-default profile, you can access the `settings.json` file that is associated with the default profile by using the **Preferences: Open Application Settings (JSON)** command in the Command Palette (`kb(workbench.action.showCommands)`).
254
+
244
255
## Settings precedence
245
256
246
257
Configurations can be overridden at multiple levels by the different setting scopes. In the following list, **later scopes override earlier scopes**:
@@ -322,7 +333,8 @@ You can share your user settings across your VS Code instances with the [Setting
322
333
323
334
You can learn more about turning on and configuring Settings Sync in the [Settings Sync](/docs/editor/settings-sync.md) user guide.
324
335
325
-
> **Note**: VS Code does not synchronize your extensions to or from a [remote](/docs/remote/remote-overview.md) window, such as when you're connected to SSH, a development container (devcontainer), or WSL.
336
+
> [!NOTE]
337
+
> VS Code does not synchronize your extensions to or from a [remote](/docs/remote/remote-overview.md) window, such as when you're connected to SSH, a development container (devcontainer), or WSL.
0 commit comments