rust-lang / rust-lang/rust-analyzer

ReferenceSearchResult should optionally return the access type (read/write)

Open
#2,560 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-ide E-unknown S-unactionable
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

textDocument/documentHghlight allows us to fill in a kind of read and write to say: "this text range represents a read" for example and can highlight differently based on this flag. I can also imagine filtering reference results by read or write access. We should return this information in ReferenceSearchResult.

Contributor guide

Open the contributing guide

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 tracing ReferenceSearchResult and the textDocument/documentHighlight handling mentioned in the issue. Determine how optional read/write access should be represented and exposed, then verify that reference results and highlighting can carry the information.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.