microsoft / microsoft/language-server-protocol
Additional information about read/write access in the Call Hierarchy Item
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13k
- Forks
- 1k
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 10
Description
A call hierarchy item containing information about the access method to the referenced object would improve clarity, especially in multithreaded scenarios.
For example, in the Eclipse-CDT Plugin, this feature is represented with symbols showing read and/or write access:
In the example we are looking for the call hierarchy of the field fooInt. As result we see that 3 items are tagged with symbols describing the kind of access: HasRefs::foo() writes to fooInt, HasRefs::fooSome() reads from fooint and the ctor HasRefs::HasRefs reads and writes to/from fooInt.
Information about Read/Write access is also helpful when searching for references on variables/fields and is part of this issue.
Related suggestion for the LSP specification https://github.com/microsoft/language-server-protocol/pull/2226
Related clangd PR https://github.com/llvm/llvm-project/pull/172462
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 by reading the issue's related language-server-protocol PR #2226 and clangd PR #172462, then review how call hierarchy items and references are represented in this specification. Done should define a protocol-level way to expose read/write access for both call hierarchy items and variable or field references.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend-api-design, devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100