redhat-developer / redhat-developer/vscode-xml

Feature request: Support resource scoped settings

Open
#722 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
328
Forks
101
Avg merge
1d 17h
Merged PRs (30d)
7

Description

Hi,

I rely heavily on vscode's multi-root workspaces feature. However, when using multi-root workspaces I can only change settings for this extension across the entire workspace and not inside individual projects in the workspace.

When I set any of the extension settings inside the .vscode/settings.json file in my project, they're disabled and when I mouse over them I see this message:

This setting cannot be applied in this workspace. It will be applied when you open the containing workspace folder directly.

If I understand correctly, it seems like support has to be added to the extension itself:

You as extension author have to make the decision which scope applies to your settings:

Scope Description
window The setting is applied to the entire VS Code instance.
resource The setting is applied depending on an active resource.

By default, all settings have the window scope, however, we encourage you to support settings on the resource scope. Settings that apply on the window level are not supported once they are defined within a workspace folder, and as soon as the user entered a multi-root workspace. Settings that apply on a resource level however are supported, and as such, each workspace folder can have different values for these settings.

https://github.com/Microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#settings

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the extension settings described in the issue and compare their behavior with VS Code's multi-root workspace settings guidance. Use the project's settings declarations and .vscode/settings.json examples as the entry points; done means supported extension settings can be configured independently for each workspace folder without the scope warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.