Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multi-root Workspaces and Angular LS #184

Closed
seanmcbreen opened this issue Oct 13, 2017 · 3 comments · Fixed by #208
Closed

Multi-root Workspaces and Angular LS #184

seanmcbreen opened this issue Oct 13, 2017 · 3 comments · Fixed by #208
Assignees
Labels

Comments

@seanmcbreen
Copy link

Hi,

I'm from the VS Code team 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 Angular Language Server Support 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:

  • Make use of the (now deprecated) workspace.rootPath property, there is a proposed migration path and sample for this case.
  • Implement a language server and in the new multi-folder setup, a language server should be able to handle multiple folders.

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 @octref

@chuckjaz chuckjaz self-assigned this Oct 24, 2017
@chuckjaz
Copy link
Contributor

Thank you for reporting.

I will test the extension for multiple root directories but I believe it will work unmodified.

  1. I don't actually use workspace.rootPath. It is stored an a local variable which is never referenced. This is vestigial code from the template I cloned.

  2. The language service needed to support multiple configuration files already as the project is defined by the tsconfig.json file, not workspace.rootPath. If a workspace contained multiple tsconfig.json file (or none at all) we would detect this and report results based on the tsconfig.json file that referenced the file.

@seanmcbreen
Copy link
Author

Thanks @chuckjaz that sounds very positive.

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

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Feb 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants