rust-lang / rust-lang/rust-analyzer
Record macro fragment captures
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
In short we should be able to ask a token in a macro-call tokentree in what way it has been captured, that is the fragment type it got captured as as well as asking for all the tokens that are part of the same capture.
This would allow us to potentially offer more IDE features for declarative macro-call inputs, as an example lets look at our match_ast macro
https://github.com/rust-analyzer/rust-analyzer/blob/1ba9a924d7b161c52e605e157ee16d582e4a8684/crates/syntax/src/lib.rs#L186-L196
Using this macro causes the match arm expressions in the input to lose all inlay hints. This is due to the input being just a bunch of unparsed tokens, but the fragment captures give us enough information to tell what tokens make up a valid expression in the input which should allow us to properly add inlay hints to these.
Completions would also benefit from this information https://github.com/rust-analyzer/rust-analyzer/issues/11059
The token map rewrite might be relevant here https://github.com/rust-analyzer/rust-analyzer/issues/9403
Contributor guide
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 match_ast macro example in crates/syntax/src/lib.rs and review the token map rewrite referenced by issue #9403. Trace how macro-call token trees represent captures, then determine how token fragment types and tokens sharing a capture should be exposed. Done means callers can query that capture information for IDE features such as inlay hints and completions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100