Add more context to completion items (#4117)

Author: stefanvanburen

private/buf/buflsp/completion.go

@@ -457,7 +457,7 @@ func completionItemsForImport(ctx context.Context, file *file, declImport ast.De
 	}
 
 	var items []protocol.CompletionItem
-	for importPath := range file.importToFile {
+	for importPath, importFile := range file.importToFile {
 		suggest := fmt.Sprintf("%q", importPath)
 		if !strings.HasPrefix(suggest, prefix) || !strings.HasSuffix(suggest, suffix) {
 			file.lsp.logger.Debug("completion: skipping on prefix/suffix",
@@ -469,6 +469,10 @@ func completionItemsForImport(ctx context.Context, file *file, declImport ast.De
 			continue
 		}
 
+		var importFileIsDeprecated bool
+		if _, ok := importFile.ir.Deprecated().AsBool(); ok {
+			importFileIsDeprecated = true
+		}
 		items = append(items, protocol.CompletionItem{
 			Label: importPath,
 			Kind:  protocol.CompletionItemKindFile,
@@ -480,6 +484,7 @@ func completionItemsForImport(ctx context.Context, file *file, declImport ast.De
 				NewText: suggest[len(prefix) : len(suggest)-len(suffix)],
 			},
 			AdditionalTextEdits: additionalTextEdits,
+			Deprecated:          importFileIsDeprecated,
 		})
 	}
 	return items
@@ -651,7 +656,8 @@ func typeReferencesToCompletionItems(
 					Range:   editRange,
 					NewText: label,
 				},
-				Deprecated: isDeprecated,
+				Deprecated:    isDeprecated,
+				Documentation: symbol.FormatDocs(),
 				// TODO: If this type's file is not currently imported add an additional edit.
 			}) {
 				break

private/buf/buflsp/server.go

@@ -333,7 +333,7 @@ func (s *server) Hover(
 		return nil, nil
 	}
 
-	docs := symbol.FormatDocs(ctx)
+	docs := symbol.FormatDocs()
 	if docs == "" {
 		return nil, nil
 	}

private/buf/buflsp/symbol.go

@@ -21,7 +21,6 @@
 package buflsp
 
 import (
-	"context"
 	"fmt"
 	"log/slog"
 	"slices"
@@ -184,7 +183,7 @@ func (s *symbol) LogValue() slog.Value {
 // string for showing to the client.
 //
 // Returns the empty string if no docs are available.
-func (s *symbol) FormatDocs(ctx context.Context) string {
+func (s *symbol) FormatDocs() string {
 	var def ast.DeclDef
 	switch s.kind.(type) {
 	case *imported:
@@ -265,12 +264,7 @@ func (s *symbol) FormatDocs(ctx context.Context) string {
 		reference, _ := s.kind.(*reference)
 		def = reference.def
 	}
-	var tooltip strings.Builder
-	docs := getCommentsFromDef(def)
-	if docs != "" {
-		fmt.Fprintln(&tooltip, docs)
-	}
-	return tooltip.String()
+	return getCommentsFromDef(def)
 }
 
 // GetSymbolInformation returns the protocol symbol information for the symbol.