Skip to content

Add additionalTextEdit for trailing ; in import statement #4110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2025
Merged

Add additionalTextEdit for trailing ; in import statement #4110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions private/buf/buflsp/completion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"fmt"
"iter"
"log/slog"
"math"
"slices"
"strings"

Expand Down Expand Up @@ -240,6 +241,26 @@ func completionItemsForImport(ctx context.Context, file *file, declImport ast.De
prefix := importPathText[:index]
suffix := importPathText[index:]

// We ought to also send along an AdditionalTextEdit for adding the `;` at the end of the
// line, if it doesn't already exist.
var additionalTextEdits []protocol.TextEdit
if declImport.Semicolon().IsZero() {
additionalTextEdits = append(additionalTextEdits, protocol.TextEdit{
NewText: ";",
// End of line.
Range: protocol.Range{
Start: protocol.Position{
Line: position.Line,
Character: math.MaxInt32 - 1,
},
End: protocol.Position{
Line: position.Line,
Character: math.MaxUint32,
Copy link
Contributor

@emcfarlane emcfarlane Oct 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't seem to work in neovim/vim. I tried the following change:

+		importRange := reportSpanToProtocolRange(declImport.Span())

-				Start: protocol.Position{
-					Line:      position.Line,
-					Character: math.MaxInt32 - 1,
-				},
-				End: protocol.Position{
-					Line:      position.Line,
-					Character: math.MaxUint32,
-				},
+				Start: importRange.End,
+				End:   importRange.End,

But that doesn't look like it works either (works in VSCode).

Copy link
Member Author

@stefanvanburen stefanvanburen Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works for me in neovim, at least (I can check vim); with both mini.completion & nvim-cmp. (The trick is to make sure you're using the plugin's mapping for complete, e.g. <C-y> for nvim-cmp, assuming you've set up the defaults.)

Copy link
Member Author

@stefanvanburen stefanvanburen Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately, with vim + https://github.com/prabirshrestha/asyncomplete.vim + https://github.com/prabirshrestha/asyncomplete-lsp.vim, it looks like the plugin has a bug where it applies the additionalTextEdit, but then also inserts the completion again?:

import "google/protobuf/type.proto";import "google/protobuf/type.proto"

Going to see about reporting upstream.

Copy link
Member Author

@stefanvanburen stefanvanburen Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

prabirshrestha/asyncomplete-lsp.vim#51

},
},
})
}

var items []protocol.CompletionItem
for importPath := range file.importToFile {
suggest := fmt.Sprintf("%q", importPath)
Expand Down Expand Up @@ -269,6 +290,7 @@ func completionItemsForImport(ctx context.Context, file *file, declImport ast.De
},
NewText: suggest[len(prefix) : len(suggest)-len(suffix)],
},
AdditionalTextEdits: additionalTextEdits,
})
}
return items
Expand Down