microsoft / microsoft/language-server-protocol

DidChangeConfigurationParams should contain a workspace URI

Open
#457 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

configuration feature-request help wanted
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

With 3.6.0 the protocol specification got multi-workspace support, however the workspace/didChangeConfiguration notification is still specced for single workspace roots. Often there is project/workspace specific configuration which should also trigger the workspace/didChangeConfiguration notification, however the server has no way of knowing for which workspace this new configuration applies and could just apply it to all workspaces which may yield in wrong future behaviour of the server.

Adding the workspace URI to DidChangeConfigurationParams is an easy way to make servers aware of workspace specific configuration without breaking backwards compatibility. If the field is unset/empty the server can just treat it like it did before such a change and if the server doesn't even support it, it will just treat it like before.

Contributor guide

No contributing guide indexed for this repository

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 by reviewing the workspace/didChangeConfiguration notification and the multi-workspace protocol specification referenced in the issue. Determine how an optional workspace URI would be represented while preserving existing behavior, then update the protocol definition and any corresponding validation or documentation; done means the specification clearly supports workspace-specific configuration changes without breaking older clients or servers.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.