microsoft / microsoft/pyright

workspaceEdit missing changeAnnotations

Open
#10,671 3 comments 2 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
15.6k
Forks
1.8k
Avg merge
12h 13m
Merged PRs (30d)
52

Description

Hello,

I'm facing an issue where the `rename` capability is broken because the issue reported here:
https://github.com/neovim/neovim/issues/34731

It seems problem has to do with the fact that when `rename` generates a workspaceEdit, it returns AnnotatedTextEdits but without a changeAnnotations field. So a client trying to use the annotation IDs will break.

[This is a good description of the issue.
](https://github.com/neovim/neovim/issues/34731#issuecomment-3029046310)

Contributor guide

Open the contributing guide

Research direction

Start by tracing the rename capability's workspaceEdit generation and the handling of AnnotatedTextEdits. Use the linked Neovim issue and its referenced description to understand how clients consume annotation IDs. Done means rename returns a workspaceEdit with the required changeAnnotations data so clients can use those IDs without breaking.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.