Skip to content

Commit f286ca1

Browse files
authored
note on settings interaction
pointing out that code-workspace settings are over-ridden by .vscode/settings.json and launch.json
1 parent 875761c commit f286ca1

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/Configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ VS Code settings enable you to customize various aspects of its function. The In
1111
{: #code-workspaces}
1212
## VS Code Workspaces
1313

14-
To work with VS Code, you need to open a workspace. A VS Code workspace can be just the root folder of your project. Workspace settings and task configurations are stored in the root folder in the `settings.json` file in a folder called `.vscode`. Debugging launch configurations are stored in `launch.json`, also in `.vscode`.
14+
To work with VS Code, you need to open a workspace. In the simplest setup, a VS Code workspace is just the root folder of your project. Workspace settings and task configurations are stored in the root folder in the `settings.json` file in a folder called `.vscode`. Debugging launch configurations are stored in `launch.json`, also in `.vscode`.
1515

1616
If you need to have more than one root folder in a VS Code workspace, use a feature called multi-root workspaces. See [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) in the VS Code documentation.
1717

18-
A multi root workspace contains a `*.code-workspace` file. The file can have any name followed by *.code-workspace*, for example `test.code-workspace`. The `*.code-workspace` file stores information about what folders are in the workspace. Other settings that would otherwise be stored in the settings.json or launch.json files can be stored in the `*.code-workspace` file. You can optionally have a workspace file even if you are not using the multi-root feature.
18+
A multi root workspace contains a `*.code-workspace` file. The file can have any name followed by *.code-workspace*, for example `test.code-workspace`. The `*.code-workspace` file stores information about what folders are in the workspace and other settings that would otherwise be stored in the settings.json or launch.json files. Settings in `settings.json` or `launch.json` will override those in the `*.code-workspace` file, so be careful to use one or the other unless you truly need to leverage this flexibility. You can optionally have a workspace file even if you are not using the multi-root feature.
1919

2020
To edit a `*.code-workspace` file in VS Code using the **InterSystems ObjectScript** extension, select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) and select the Workspace level. Search for **objectscript: conn**, and click on *Edit in settings.json*. VS Code opens the `*.code-workspace` file for that workspace.
2121

@@ -131,4 +131,4 @@ The components of this configuration are:
131131

132132
- **ns** - namespace to use on the server
133133
- **server** - server name as specified in the server configuration
134-
- **active** - specifies whether the connection is active.
134+
- **active** - specifies whether the connection is active.

0 commit comments

Comments
 (0)