Supporting VS Code Multi-root Workspaces

[seanmcbreen]

Hi,

I'm from the VS Code team (we have chatted before 😄) and I'm reaching out with some additional resources for adopting multi-root workspaces.

But first let me say thank you for working on and maintaining EditorConfig for VS Code which is one of the most popular extensions we really appreciate the work you have done to make VS Code better.

The purpose of this issue is that we are very close to releasing a significant new feature for VS Code - Multi-root Workspaces - which is the most requested missing feature. If you have not heard of multi-root workspaces we have described this in several of our recent updates. Today it's only enabled in our insiders release but our intent is to enable it for all users in our next update, targeted for release in the first week of November.

This is a pretty significant change and over the last four months we have updated pretty much all of VS Code to be Multi-root aware as well as updated all of our own extensions. In the process of doing this we have created a set of guidelines for Extension Authors to follow to ensure their extension can fully leverage the awesomeness that is Multi-root workspaces.

Our Request:

Having looked at your extension we think changes are required in how you contribute or change settings, specifically you need to review whether some of the settings can be applied on a resource (= file location) level instead of being global (= workspace level).

How Can We Help/Resources:

We realize we are asking for your help here - our goal is to make sure that your extensions works well with multi-root and continues to be loved by the community. The guide above outlines the changes that are required and we have a samples as well.

But we are sure you will have questions and we thought one way we could look to help is by getting a number of the team members (myself included) to be ready to respond to questions on a Slack Channel that we will dedicate to this issue. To join that channel simply follow this link.

Again thank you for being part of the VS Code community - we appreciate everything you have done. With the release of Multi-root Workspaces we will be shipping our most requested feature, together we can really help this feature light up for users.

Happy Coding!
Sean McBreen

// cc @bpasero @alexandrudima

[seanmcbreen]

Request: if you have prepared your extension for Multi-root Workspaces we would love you to add multi-root ready to your package.json i.e. "keywords": ["multi-root ready"]. If you upgrade to VSCE 1.32.0 this can be added to any existing keywords and will not be counted against the maximum of 5 allowed keywords.

This will help us keep track of adoptions and also help users know which extensions have been fully tested. Remember we are here to help should you need it on the Slack channel.

Happy Coding
Sean McBreen

[KamasamaK]

The relevant messages I see always come up are
[EditorConfig.EditorConfig] Accessing a resource scoped configuration without providing a resource is not expected. To get the effective value for 'editor.detectIndentation', provide the URI of a resource or 'null' for any resource.
and
[EditorConfig.EditorConfig] Accessing a resource scoped configuration without providing a resource is not expected. To get the effective value for 'files.trimTrailingWhitespace', provide the URI of a resource or 'null' for any resource.

[bpasero]

@KamasamaK do you need any help? The error message you see is expected if you declare a setting as a resource setting but when reading the setting you are not passing in a resource (either file or folder).

[KamasamaK]

@bpasero Thanks for the offer, but this was just an observation from developing an unrelated extension while having this extension active.

I can already see the messages are due to where workspace.getConfiguration is called without passing a second parameter and then accessing those resource settings.