mirror of https://github.com/golang/go.git
519 lines
16 KiB
Go
519 lines
16 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/event"
|
|
"golang.org/x/tools/internal/imports"
|
|
"golang.org/x/tools/internal/lsp/command"
|
|
"golang.org/x/tools/internal/lsp/debug/tag"
|
|
"golang.org/x/tools/internal/lsp/mod"
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/span"
|
|
errors "golang.org/x/xerrors"
|
|
)
|
|
|
|
func (s *Server) codeAction(ctx context.Context, params *protocol.CodeActionParams) ([]protocol.CodeAction, error) {
|
|
snapshot, fh, ok, release, err := s.beginFileRequest(ctx, params.TextDocument.URI, source.UnknownKind)
|
|
defer release()
|
|
if !ok {
|
|
return nil, err
|
|
}
|
|
uri := fh.URI()
|
|
|
|
// Determine the supported actions for this file kind.
|
|
supportedCodeActions, ok := snapshot.View().Options().SupportedCodeActions[fh.Kind()]
|
|
if !ok {
|
|
return nil, fmt.Errorf("no supported code actions for %v file kind", fh.Kind())
|
|
}
|
|
|
|
// 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 non-explicit code actions.
|
|
var wanted map[protocol.CodeActionKind]bool
|
|
|
|
// Explicit Code Actions are opt-in and shouldn't be returned to the client unless
|
|
// requested using Only.
|
|
// TODO: Add other CodeLenses such as GoGenerate, RegenerateCgo, etc..
|
|
explicit := map[protocol.CodeActionKind]bool{
|
|
protocol.GoTest: true,
|
|
}
|
|
|
|
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] || explicit[only]
|
|
}
|
|
}
|
|
if len(wanted) == 0 {
|
|
return nil, fmt.Errorf("no supported code action to execute for %s, wanted %v", uri, params.Context.Only)
|
|
}
|
|
|
|
var codeActions []protocol.CodeAction
|
|
switch fh.Kind() {
|
|
case source.Mod:
|
|
if diagnostics := params.Context.Diagnostics; len(diagnostics) > 0 {
|
|
diags, err := mod.DiagnosticsForMod(ctx, snapshot, fh)
|
|
if source.IsNonFatalGoModError(err) {
|
|
return nil, nil
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
quickFixes, err := quickFixesForDiagnostics(ctx, snapshot, diagnostics, diags)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, quickFixes...)
|
|
}
|
|
case source.Go:
|
|
// Don't suggest fixes for generated files, since they are generally
|
|
// not useful and some editors may apply them automatically on save.
|
|
if source.IsGenerated(ctx, snapshot, uri) {
|
|
return nil, nil
|
|
}
|
|
diagnostics := params.Context.Diagnostics
|
|
|
|
// First, process any missing imports and pair them with the
|
|
// diagnostics they fix.
|
|
if wantQuickFixes := wanted[protocol.QuickFix] && len(diagnostics) > 0; wantQuickFixes || wanted[protocol.SourceOrganizeImports] {
|
|
importEdits, importEditsPerFix, err := source.AllImportsFixes(ctx, snapshot, fh)
|
|
if err != nil {
|
|
event.Error(ctx, "imports fixes", err, tag.File.Of(fh.URI().Filename()))
|
|
}
|
|
// Separate this into a set of codeActions per diagnostic, where
|
|
// each action is the addition, removal, or renaming of one import.
|
|
if wantQuickFixes {
|
|
for _, importFix := range importEditsPerFix {
|
|
fixes := importDiagnostics(importFix.Fix, diagnostics)
|
|
if len(fixes) == 0 {
|
|
continue
|
|
}
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: importFixTitle(importFix.Fix),
|
|
Kind: protocol.QuickFix,
|
|
Edit: protocol.WorkspaceEdit{
|
|
DocumentChanges: documentChanges(fh, importFix.Edits),
|
|
},
|
|
Diagnostics: fixes,
|
|
})
|
|
}
|
|
}
|
|
|
|
// Send all of the import edits as one code action if the file is
|
|
// being organized.
|
|
if wanted[protocol.SourceOrganizeImports] && len(importEdits) > 0 {
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: "Organize Imports",
|
|
Kind: protocol.SourceOrganizeImports,
|
|
Edit: protocol.WorkspaceEdit{
|
|
DocumentChanges: documentChanges(fh, importEdits),
|
|
},
|
|
})
|
|
}
|
|
}
|
|
if ctx.Err() != nil {
|
|
return nil, ctx.Err()
|
|
}
|
|
pkg, err := snapshot.PackageForFile(ctx, fh.URI(), source.TypecheckFull, source.WidestPackage)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if (wanted[protocol.QuickFix] || wanted[protocol.SourceFixAll]) && len(diagnostics) > 0 {
|
|
analysisDiags, err := source.Analyze(ctx, snapshot, pkg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if wanted[protocol.QuickFix] {
|
|
pkgDiagnostics, err := snapshot.DiagnosePackage(ctx, pkg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
quickFixDiags := append(pkgDiagnostics[uri], analysisDiags[uri]...)
|
|
modURI := snapshot.GoModForFile(fh.URI())
|
|
if modURI != "" {
|
|
modFH, err := snapshot.GetVersionedFile(ctx, modURI)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
modDiags, err := mod.DiagnosticsForMod(ctx, snapshot, modFH)
|
|
if err != nil && !source.IsNonFatalGoModError(err) {
|
|
// Not a fatal error.
|
|
event.Error(ctx, "module suggested fixes failed", err, tag.Directory.Of(snapshot.View().Folder()))
|
|
}
|
|
quickFixDiags = append(quickFixDiags, modDiags...)
|
|
}
|
|
quickFixes, err := quickFixesForDiagnostics(ctx, snapshot, diagnostics, quickFixDiags)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, quickFixes...)
|
|
|
|
}
|
|
if wanted[protocol.SourceFixAll] {
|
|
var fixAllEdits []protocol.TextDocumentEdit
|
|
for _, ad := range analysisDiags[uri] {
|
|
if ad.Analyzer == nil || !ad.Analyzer.HighConfidence {
|
|
continue
|
|
}
|
|
for _, fix := range ad.SuggestedFixes {
|
|
edits := fix.Edits[fh.URI()]
|
|
if len(edits) == 0 {
|
|
continue
|
|
}
|
|
fixAllEdits = append(fixAllEdits, documentChanges(fh, edits)...)
|
|
}
|
|
|
|
}
|
|
if len(fixAllEdits) != 0 {
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
Title: "Simplifications",
|
|
Kind: protocol.SourceFixAll,
|
|
Edit: protocol.WorkspaceEdit{
|
|
DocumentChanges: fixAllEdits,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
}
|
|
if ctx.Err() != nil {
|
|
return nil, ctx.Err()
|
|
}
|
|
// Add any suggestions that do not necessarily fix any diagnostics.
|
|
if wanted[protocol.RefactorRewrite] {
|
|
fixes, err := convenienceFixes(ctx, snapshot, pkg, uri, params.Range)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, fixes...)
|
|
}
|
|
if wanted[protocol.RefactorExtract] {
|
|
fixes, err := extractionFixes(ctx, snapshot, pkg, uri, params.Range)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, fixes...)
|
|
}
|
|
|
|
if wanted[protocol.GoTest] {
|
|
fixes, err := goTest(ctx, snapshot, uri, params.Range)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, fixes...)
|
|
}
|
|
|
|
default:
|
|
// Unsupported file kind for a code action.
|
|
return nil, nil
|
|
}
|
|
return codeActions, nil
|
|
}
|
|
|
|
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 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
|
|
}
|
|
|
|
// diagnosticToAnalyzer return the analyzer associated with a given diagnostic.
|
|
// It assumes that the diagnostic's source will be the name of the analyzer.
|
|
// If this changes, this approach will need to be reworked.
|
|
func diagnosticToAnalyzer(snapshot source.Snapshot, src, msg string) (analyzer *source.Analyzer) {
|
|
// Make sure that the analyzer we found is enabled.
|
|
defer func() {
|
|
if analyzer != nil && !analyzer.IsEnabled(snapshot.View()) {
|
|
analyzer = nil
|
|
}
|
|
}()
|
|
if a, ok := snapshot.View().Options().DefaultAnalyzers[src]; ok {
|
|
return a
|
|
}
|
|
if a, ok := snapshot.View().Options().StaticcheckAnalyzers[src]; ok {
|
|
return a
|
|
}
|
|
if a, ok := snapshot.View().Options().ConvenienceAnalyzers[src]; ok {
|
|
return a
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func convenienceFixes(ctx context.Context, snapshot source.Snapshot, pkg source.Package, uri span.URI, rng protocol.Range) ([]protocol.CodeAction, error) {
|
|
var analyzers []*source.Analyzer
|
|
for _, a := range snapshot.View().Options().ConvenienceAnalyzers {
|
|
if !a.IsEnabled(snapshot.View()) {
|
|
continue
|
|
}
|
|
if a.Fix == "" {
|
|
event.Error(ctx, "convenienceFixes", fmt.Errorf("no suggested fixes for convenience analyzer %s", a.Analyzer.Name))
|
|
continue
|
|
}
|
|
analyzers = append(analyzers, a)
|
|
}
|
|
diagnostics, err := snapshot.Analyze(ctx, pkg.ID(), analyzers)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
var codeActions []protocol.CodeAction
|
|
for _, d := range diagnostics {
|
|
// For now, only show diagnostics for matching lines. Maybe we should
|
|
// alter this behavior in the future, depending on the user experience.
|
|
if d.URI != uri {
|
|
continue
|
|
}
|
|
|
|
if !protocol.Intersect(d.Range, rng) {
|
|
continue
|
|
}
|
|
action, err := diagnosticToCommandCodeAction(ctx, snapshot, d, nil, protocol.RefactorRewrite)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
codeActions = append(codeActions, *action)
|
|
}
|
|
return codeActions, nil
|
|
}
|
|
|
|
func diagnosticToCommandCodeAction(ctx context.Context, snapshot source.Snapshot, sd *source.Diagnostic, pd *protocol.Diagnostic, kind protocol.CodeActionKind) (*protocol.CodeAction, error) {
|
|
// The fix depends on the category of the analyzer. The diagnostic may be
|
|
// nil, so use the error's category.
|
|
analyzer := diagnosticToAnalyzer(snapshot, string(sd.Source), sd.Message)
|
|
if analyzer == nil {
|
|
return nil, fmt.Errorf("no convenience analyzer for source %s", sd.Source)
|
|
}
|
|
if analyzer.Fix == "" {
|
|
return nil, fmt.Errorf("no fix for convenience analyzer %s", analyzer.Analyzer.Name)
|
|
}
|
|
cmd, err := command.NewApplyFixCommand(sd.Message, command.ApplyFixArgs{
|
|
URI: protocol.URIFromSpanURI(sd.URI),
|
|
Range: sd.Range,
|
|
Fix: analyzer.Fix,
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
var diagnostics []protocol.Diagnostic
|
|
if pd != nil {
|
|
diagnostics = append(diagnostics, *pd)
|
|
}
|
|
return &protocol.CodeAction{
|
|
Title: sd.Message,
|
|
Kind: kind,
|
|
Diagnostics: diagnostics,
|
|
Command: &cmd,
|
|
}, nil
|
|
}
|
|
|
|
func extractionFixes(ctx context.Context, snapshot source.Snapshot, pkg source.Package, uri span.URI, rng protocol.Range) ([]protocol.CodeAction, error) {
|
|
if rng.Start == rng.End {
|
|
return nil, nil
|
|
}
|
|
fh, err := snapshot.GetFile(ctx, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
_, pgf, err := source.GetParsedFile(ctx, snapshot, fh, source.NarrowestPackage)
|
|
if err != nil {
|
|
return nil, errors.Errorf("getting file for Identifier: %w", err)
|
|
}
|
|
srng, err := pgf.Mapper.RangeToSpanRange(rng)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
puri := protocol.URIFromSpanURI(uri)
|
|
var commands []protocol.Command
|
|
if _, ok, _ := source.CanExtractFunction(snapshot.FileSet(), srng, pgf.Src, pgf.File); ok {
|
|
cmd, err := command.NewApplyFixCommand("Extract to function", command.ApplyFixArgs{
|
|
URI: puri,
|
|
Fix: source.ExtractFunction,
|
|
Range: rng,
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
commands = append(commands, cmd)
|
|
}
|
|
if _, _, ok, _ := source.CanExtractVariable(srng, pgf.File); ok {
|
|
cmd, err := command.NewApplyFixCommand("Extract variable", command.ApplyFixArgs{
|
|
URI: puri,
|
|
Fix: source.ExtractVariable,
|
|
Range: rng,
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
commands = append(commands, cmd)
|
|
}
|
|
var actions []protocol.CodeAction
|
|
for _, cmd := range commands {
|
|
actions = append(actions, protocol.CodeAction{
|
|
Title: cmd.Title,
|
|
Kind: protocol.RefactorExtract,
|
|
Command: &cmd,
|
|
})
|
|
}
|
|
return actions, nil
|
|
}
|
|
|
|
func documentChanges(fh source.VersionedFileHandle, edits []protocol.TextEdit) []protocol.TextDocumentEdit {
|
|
return []protocol.TextDocumentEdit{
|
|
{
|
|
TextDocument: protocol.OptionalVersionedTextDocumentIdentifier{
|
|
Version: fh.Version(),
|
|
TextDocumentIdentifier: protocol.TextDocumentIdentifier{
|
|
URI: protocol.URIFromSpanURI(fh.URI()),
|
|
},
|
|
},
|
|
Edits: edits,
|
|
},
|
|
}
|
|
}
|
|
|
|
func quickFixesForDiagnostics(ctx context.Context, snapshot source.Snapshot, pdiags []protocol.Diagnostic, sdiags []*source.Diagnostic) ([]protocol.CodeAction, error) {
|
|
var quickFixes []protocol.CodeAction
|
|
for _, e := range sdiags {
|
|
var diag *protocol.Diagnostic
|
|
for _, d := range pdiags {
|
|
if sameDiagnostic(d, e) {
|
|
diag = &d
|
|
break
|
|
}
|
|
}
|
|
if diag == nil {
|
|
continue
|
|
}
|
|
for _, fix := range e.SuggestedFixes {
|
|
action := protocol.CodeAction{
|
|
Title: fix.Title,
|
|
Kind: protocol.QuickFix,
|
|
Diagnostics: []protocol.Diagnostic{*diag},
|
|
Edit: protocol.WorkspaceEdit{},
|
|
Command: fix.Command,
|
|
}
|
|
|
|
for uri, edits := range fix.Edits {
|
|
fh, err := snapshot.GetVersionedFile(ctx, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
action.Edit.DocumentChanges = append(action.Edit.DocumentChanges, protocol.TextDocumentEdit{
|
|
TextDocument: protocol.OptionalVersionedTextDocumentIdentifier{
|
|
Version: fh.Version(),
|
|
TextDocumentIdentifier: protocol.TextDocumentIdentifier{
|
|
URI: protocol.URIFromSpanURI(uri),
|
|
},
|
|
},
|
|
Edits: edits,
|
|
})
|
|
}
|
|
quickFixes = append(quickFixes, action)
|
|
}
|
|
}
|
|
return quickFixes, nil
|
|
}
|
|
|
|
func sameDiagnostic(pd protocol.Diagnostic, sd *source.Diagnostic) bool {
|
|
return pd.Message == sd.Message && protocol.CompareRange(pd.Range, sd.Range) == 0 && pd.Source == string(sd.Source)
|
|
}
|
|
|
|
func goTest(ctx context.Context, snapshot source.Snapshot, uri span.URI, rng protocol.Range) ([]protocol.CodeAction, error) {
|
|
fh, err := snapshot.GetFile(ctx, uri)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
fns, err := source.TestsAndBenchmarks(ctx, snapshot, fh)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var tests, benchmarks []string
|
|
for _, fn := range fns.Tests {
|
|
if !protocol.Intersect(fn.Rng, rng) {
|
|
continue
|
|
}
|
|
tests = append(tests, fn.Name)
|
|
}
|
|
for _, fn := range fns.Benchmarks {
|
|
if !protocol.Intersect(fn.Rng, rng) {
|
|
continue
|
|
}
|
|
benchmarks = append(benchmarks, fn.Name)
|
|
}
|
|
|
|
if len(tests) == 0 && len(benchmarks) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
cmd, err := command.NewTestCommand("Run tests and benchmarks", protocol.URIFromSpanURI(uri), tests, benchmarks)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return []protocol.CodeAction{{
|
|
Title: cmd.Title,
|
|
Kind: protocol.GoTest,
|
|
Command: &cmd,
|
|
}}, nil
|
|
}
|