microsoft / microsoft/vscode-docs
Document configuration scopes
Open
@sandy081 is already working on this.
Since Dec 14, 2022.
doc-enhancement
extensibility
feature-request
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 5.8k
- Avg merge
- 11h 43m
- Merged PRs (30d)
- 123
Description
From @Colengms
| Scope | VS Code description | Overridable in workspace (or workspace folder in a single root scenario) | Overridable in workspace folder (in a multiroot scenario which has one or more folders) | Remote will inherit local user settings | Overridable remotely | Overridable at language level |
|---|---|---|---|---|---|---|
| application | Settings that apply to all instances of VS Code and can only be configured in user settings. | no | no | yes | no | no |
| window | Windows (instance) specific settings which can be configured in user, workspace, or remote settings. | yes | no | yes | yes | no |
| resource | Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings. | yes | yes | yes | yes | no |
| machine | Machine specific settings that can be set only in user settings or only in remote settings. For example, an installation path which shouldn't be shared across machines. | no | no | no | yes (implicitly, as it's not inherited) | no |
| machine-overridable | Machine specific settings that can be overridden by workspace or folder settings. | yes | yes | no | yes (implicitly, as it's not inherited) | no |
| language-overridable | Resource settings that can be overridable at a language level. | yes | yes | yes | yes | Yes |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.