mirror of
https://github.com/golang/go
synced 2024-11-18 22:55:23 -07:00
3b4f30a44f
We had too many options for functions to use to get type information for a package. Now we stick with having one option to get the check package handles, and then the caller can refine the results as needed. Change-Id: I81f69a670e1539854ee23b6f364159a7de9b782f Reviewed-on: https://go-review.googlesource.com/c/tools/+/194457 Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Ian Cottrell <iancottrell@google.com>
233 lines
7.3 KiB
Go
233 lines
7.3 KiB
Go
// Copyright 2018 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package lsp
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
|
|
"golang.org/x/tools/internal/imports"
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/lsp/telemetry"
|
|
"golang.org/x/tools/internal/span"
|
|
"golang.org/x/tools/internal/telemetry/log"
|
|
errors "golang.org/x/xerrors"
|
|
)
|
|
|
|
func (s *Server) getSupportedCodeActions() []protocol.CodeActionKind {
|
|
allCodeActionKinds := make(map[protocol.CodeActionKind]struct{})
|
|
for _, kinds := range s.session.Options().SupportedCodeActions {
|
|
for kind := range kinds {
|
|
allCodeActionKinds[kind] = struct{}{}
|
|
}
|
|
}
|
|
|
|
var result []protocol.CodeActionKind
|
|
for kind := range allCodeActionKinds {
|
|
result = append(result, kind)
|
|
}
|
|
sort.Slice(result, func(i, j int) bool {
|
|
return result[i] < result[j]
|
|
})
|
|
return result
|
|
}
|
|
|
|
func (s *Server) codeAction(ctx context.Context, params *protocol.CodeActionParams) ([]protocol.CodeAction, error) {
|
|
uri := span.NewURI(params.TextDocument.URI)
|
|
view := s.session.ViewOf(uri)
|
|
f, err := view.GetFile(ctx, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Determine the supported actions for this file kind.
|
|
fileKind := f.Handle(ctx).Kind()
|
|
supportedCodeActions, ok := view.Options().SupportedCodeActions[fileKind]
|
|
if !ok {
|
|
return nil, fmt.Errorf("no supported code actions for %v file kind", fileKind)
|
|
}
|
|
|
|
// The Only field of the context specifies which code actions the client wants.
|
|
// If Only is empty, assume that the client wants all of the possible code actions.
|
|
var wanted map[protocol.CodeActionKind]bool
|
|
if len(params.Context.Only) == 0 {
|
|
wanted = supportedCodeActions
|
|
} else {
|
|
wanted = make(map[protocol.CodeActionKind]bool)
|
|
for _, only := range params.Context.Only {
|
|
wanted[only] = supportedCodeActions[only]
|
|
}
|
|
}
|
|
if len(wanted) == 0 {
|
|
return nil, errors.Errorf("no supported code action to execute for %s, wanted %v", uri, params.Context.Only)
|
|
}
|
|
|
|
var codeActions []protocol.CodeAction
|
|
|
|
edits, editsPerFix, err := source.AllImportsFixes(ctx, view, f)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// If the user wants to see quickfixes.
|
|
if wanted[protocol.QuickFix] {
|
|
// First, add the quick fixes reported by go/analysis.
|
|
gof, ok := f.(source.GoFile)
|
|
if !ok {
|
|
return nil, fmt.Errorf("%s is not a Go file", f.URI())
|
|
}
|
|
qf, err := quickFixes(ctx, view, gof)
|
|
if err != nil {
|
|
log.Error(ctx, "quick fixes failed", err, telemetry.File.Of(uri))
|
|
}
|
|
codeActions = append(codeActions, qf...)
|
|
|
|
// If we also have diagnostics for missing imports, we can associate them with quick fixes.
|
|
if findImportErrors(params.Context.Diagnostics) {
|
|
// Separate this into a set of codeActions per diagnostic, where
|
|
// each action is the addition, removal, or renaming of one import.
|
|
for _, importFix := range editsPerFix {
|
|
// Get the diagnostics this fix would affect.
|
|
if fixDiagnostics := importDiagnostics(importFix.Fix, params.Context.Diagnostics); len(fixDiagnostics) > 0 {
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: importFixTitle(importFix.Fix),
|
|
Kind: protocol.QuickFix,
|
|
Edit: &protocol.WorkspaceEdit{
|
|
Changes: &map[string][]protocol.TextEdit{
|
|
string(uri): importFix.Edits,
|
|
},
|
|
},
|
|
Diagnostics: fixDiagnostics,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Add the results of import organization as source.OrganizeImports.
|
|
if wanted[protocol.SourceOrganizeImports] {
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: "Organize Imports",
|
|
Kind: protocol.SourceOrganizeImports,
|
|
Edit: &protocol.WorkspaceEdit{
|
|
Changes: &map[string][]protocol.TextEdit{
|
|
string(uri): edits,
|
|
},
|
|
},
|
|
})
|
|
}
|
|
|
|
return codeActions, nil
|
|
}
|
|
|
|
type protocolImportFix struct {
|
|
fix *imports.ImportFix
|
|
edits []protocol.TextEdit
|
|
}
|
|
|
|
// findImports determines if a given diagnostic represents an error that could
|
|
// be fixed by organizing imports.
|
|
// TODO(rstambler): We need a better way to check this than string matching.
|
|
func findImportErrors(diagnostics []protocol.Diagnostic) bool {
|
|
for _, diagnostic := range diagnostics {
|
|
// "undeclared name: X" may be an unresolved import.
|
|
if strings.HasPrefix(diagnostic.Message, "undeclared name: ") {
|
|
return true
|
|
}
|
|
// "could not import: X" may be an invalid import.
|
|
if strings.HasPrefix(diagnostic.Message, "could not import: ") {
|
|
return true
|
|
}
|
|
// "X imported but not used" is an unused import.
|
|
// "X imported but not used as Y" is an unused import.
|
|
if strings.Contains(diagnostic.Message, " imported but not used") {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func importFixTitle(fix *imports.ImportFix) string {
|
|
var str string
|
|
switch fix.FixType {
|
|
case imports.AddImport:
|
|
str = fmt.Sprintf("Add import: %s %q", fix.StmtInfo.Name, fix.StmtInfo.ImportPath)
|
|
case imports.DeleteImport:
|
|
str = fmt.Sprintf("Delete import: %s %q", fix.StmtInfo.Name, fix.StmtInfo.ImportPath)
|
|
case imports.SetImportName:
|
|
str = fmt.Sprintf("Rename import: %s %q", fix.StmtInfo.Name, fix.StmtInfo.ImportPath)
|
|
}
|
|
return str
|
|
}
|
|
|
|
func importDiagnostics(fix *imports.ImportFix, diagnostics []protocol.Diagnostic) (results []protocol.Diagnostic) {
|
|
for _, diagnostic := range diagnostics {
|
|
switch {
|
|
// "undeclared name: X" may be an unresolved import.
|
|
case strings.HasPrefix(diagnostic.Message, "undeclared name: "):
|
|
ident := strings.TrimPrefix(diagnostic.Message, "undeclared name: ")
|
|
if ident == fix.IdentName {
|
|
results = append(results, diagnostic)
|
|
}
|
|
// "could not import: X" may be an invalid import.
|
|
case strings.HasPrefix(diagnostic.Message, "could not import: "):
|
|
ident := strings.TrimPrefix(diagnostic.Message, "could not import: ")
|
|
if ident == fix.IdentName {
|
|
results = append(results, diagnostic)
|
|
}
|
|
// "X imported but not used" is an unused import.
|
|
// "X imported but not used as Y" is an unused import.
|
|
case strings.Contains(diagnostic.Message, " imported but not used"):
|
|
idx := strings.Index(diagnostic.Message, " imported but not used")
|
|
importPath := diagnostic.Message[:idx]
|
|
if importPath == fmt.Sprintf("%q", fix.StmtInfo.ImportPath) {
|
|
results = append(results, diagnostic)
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
return results
|
|
}
|
|
|
|
func quickFixes(ctx context.Context, view source.View, gof source.GoFile) ([]protocol.CodeAction, error) {
|
|
var codeActions []protocol.CodeAction
|
|
|
|
// TODO: This is technically racy because the diagnostics provided by the code action
|
|
// may not be the same as the ones that gopls is aware of.
|
|
// We need to figure out some way to solve this problem.
|
|
cphs, err := gof.CheckPackageHandles(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
cph := source.NarrowestCheckPackageHandle(cphs)
|
|
pkg, err := cph.Cached(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
for _, diag := range pkg.GetDiagnostics() {
|
|
pdiag, err := toProtocolDiagnostic(ctx, diag)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
for _, fix := range diag.SuggestedFixes {
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: fix.Title,
|
|
Kind: protocol.QuickFix, // TODO(matloob): Be more accurate about these?
|
|
Edit: &protocol.WorkspaceEdit{
|
|
Changes: &map[string][]protocol.TextEdit{
|
|
protocol.NewURI(diag.URI): fix.Edits,
|
|
},
|
|
},
|
|
Diagnostics: []protocol.Diagnostic{pdiag},
|
|
})
|
|
}
|
|
}
|
|
return codeActions, nil
|
|
}
|