x/tools/gopls/internal/lsp/protocol: use AnnotatedTextEdit for TextDocumentEdit.Edits #58583
Assignees
Labels
FeatureRequest
gopls
Issues related to the Go language server, gopls.
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Tools
This label describes issues relating to any tools in the x/tools repository.
Milestone
Comments
gopherbot
added
Tools
hyangah
added
FeatureRequest
and removed
Documentation
gopls
|
The general replacement idea doesn't work, alas. Several of the RPCs use
TextEdits, not AnnotatedTextEdits. But conforming with the specification
ought to be possible. What features would that enable?
…On Fri, Feb 17, 2023 at 2:32 PM Hyang-Ah Hana Kim ***@***.***> wrote:
In 3.16, LSP introduced support for AnnotatedTextEdit
<https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentEdit>
that allows annotations to a text edit and
supports UX that optionally asks user for confirmation before applying the
change.
TextDocumentEdit.Edits is defined an array of TextEdit | AnnotatedTextEdit
according to the spec,
but Gopls is currently accepting only TextEdit type. It would be nice if
gopls uses AnnotatedTextEdit instead of TextEdit
so we can experiment and start developing features with the
AnnotatedTextEdit.
Given that AnnotatedTextEdit is a simple extension of TextEdit with one
extra field (annotationId),
I think we can consider to replace all references of TextEdit in gopls
with AnnotatedTextEdit
<https://cs.opensource.google/go/x/tools/+/gopls/v0.11.0:gopls/internal/lsp/protocol/tsprotocol.go;l=18>
while marking the annotatedId field omitempty.
Alternatively, I saw some internal non-TS/JS LSP implementations work
around this OR type issue by a type corresponding to TextEdit
type TextEdit struct {
Range Range `json:"range"`
NewText string `json:"newText"`
AnnotationID ChangeAnnotationIdentifier `json:"annotationId,omitempt"`
}
cc @pjweinb <https://github.com/pjweinb>
—
Reply to this email directly, view it on GitHub
<#58583>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABJIAIZZIOFIHPTIJBTUNODWX7G3RANCNFSM6AAAAAAU7ZMQJA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
You are right that the general replacement doesn't work. This unlocks more advanced workspace edits shown in
I think this will help us enhance gopls's workspace edit feature - various renaming that results in multiple file changes/moves. |
thanm
added
the
NeedsInvestigation
|
Per chat -- this was done in https://go.dev/cl/547295 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In 3.16, LSP introduced support for
AnnotatedTextEditthat allows annotations to a text edit andsupports UX that optionally asks user for confirmation before applying the change.
TextDocumentEdit.Editsis defined an array ofTextEdit | AnnotatedTextEditaccording to the spec,but Gopls is currently accepting only
TextEdittype. It would be nice if gopls uses AnnotatedTextEdit instead of TextEditso we can experiment and start developing features with the AnnotatedTextEdit.
Given that
AnnotatedTextEditis a simple extension ofTextEditwith one extra field (annotationId),I think we can consider to replace all references of TextEdit in gopls with AnnotatedTextEdit while marking the annotatedId field omitempty.
Alternatively, I saw some internal non-TS/JS LSP implementations work around this OR type issue by a type corresponding to TextEdit
cc @pjweinb
The text was updated successfully, but these errors were encountered: