microsoft / microsoft/language-server-protocol
WorkspaceSymbol response data for `workspace/symbol` lacks detail field
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13k
- Forks
- 1k
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 10
Description
I am working on a language server for the VHDL language and encountered this limitations of the 'workspace/symbol' response data that I want to bring up here.
VHDL is a language that supports overloading which means there can be several identically named functions in the same file.
The workspace/symbol request offers no way to provide the signature of the function. It is poor UX to show a long list of identically named functions.
The temptation is to put the signature in the name of the symbol itself but this will cause clients such as VSCode to highlight matches in the signature. This behavior is pointing to a lack of separation of concerns where the server is responsible for filtering on the query but clients such as VSCode try to make their own made-up highlighting of matches, related issue: https://github.com/microsoft/language-server-protocol/issues/1674
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with the workspace/symbol response data in the Language Server Protocol and review the related issue about VSCode highlighting. Determine how overloaded symbols could expose signatures without putting them in the symbol name; done means a clearly specified protocol change that addresses this separation-of-concerns problem.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100