2019-04-05 13:56:08 -06:00
|
|
|
// 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"
|
2019-06-27 19:26:42 -06:00
|
|
|
"fmt"
|
2020-02-26 15:07:02 -07:00
|
|
|
"regexp"
|
2019-08-14 13:24:21 -06:00
|
|
|
"sort"
|
2019-04-05 13:56:08 -06:00
|
|
|
"strings"
|
|
|
|
|
2019-07-30 12:00:02 -06:00
|
|
|
"golang.org/x/tools/internal/imports"
|
2019-12-17 14:13:33 -07:00
|
|
|
"golang.org/x/tools/internal/lsp/mod"
|
2019-04-05 13:56:08 -06:00
|
|
|
"golang.org/x/tools/internal/lsp/protocol"
|
|
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
|
|
)
|
|
|
|
|
|
|
|
func (s *Server) codeAction(ctx context.Context, params *protocol.CodeActionParams) ([]protocol.CodeAction, error) {
|
2020-02-13 11:46:49 -07:00
|
|
|
snapshot, fh, ok, err := s.beginFileRequest(params.TextDocument.URI, source.UnknownKind)
|
|
|
|
if !ok {
|
2019-08-16 11:49:17 -06:00
|
|
|
return nil, err
|
|
|
|
}
|
2020-02-13 11:46:49 -07:00
|
|
|
uri := fh.Identity().URI
|
2019-09-27 11:17:59 -06:00
|
|
|
|
2019-08-05 17:27:28 -06:00
|
|
|
// Determine the supported actions for this file kind.
|
2020-02-13 11:46:49 -07:00
|
|
|
supportedCodeActions, ok := snapshot.View().Options().SupportedCodeActions[fh.Identity().Kind]
|
2019-08-05 17:27:28 -06:00
|
|
|
if !ok {
|
2019-11-12 15:58:37 -07:00
|
|
|
return nil, fmt.Errorf("no supported code actions for %v file kind", fh.Identity().Kind)
|
2019-08-05 17:27:28 -06:00
|
|
|
}
|
2019-06-27 19:26:42 -06:00
|
|
|
|
|
|
|
// 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 {
|
2019-08-05 17:27:28 -06:00
|
|
|
wanted = supportedCodeActions
|
2019-06-27 19:26:42 -06:00
|
|
|
} else {
|
|
|
|
wanted = make(map[protocol.CodeActionKind]bool)
|
|
|
|
for _, only := range params.Context.Only {
|
2019-08-05 17:27:28 -06:00
|
|
|
wanted[only] = supportedCodeActions[only]
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
if len(wanted) == 0 {
|
2020-03-30 10:45:15 -06:00
|
|
|
return nil, fmt.Errorf("no supported code action to execute for %s, wanted %v", uri, params.Context.Only)
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
|
|
|
|
2019-04-05 13:56:08 -06:00
|
|
|
var codeActions []protocol.CodeAction
|
2019-11-12 15:58:37 -07:00
|
|
|
switch fh.Identity().Kind {
|
2019-09-18 23:21:54 -06:00
|
|
|
case source.Mod:
|
2020-01-29 09:16:19 -07:00
|
|
|
if diagnostics := params.Context.Diagnostics; len(diagnostics) > 0 {
|
2020-04-01 19:31:43 -06:00
|
|
|
modFixes, err := mod.SuggestedFixes(ctx, snapshot, fh, diagnostics)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
codeActions = append(codeActions, modFixes...)
|
2020-01-29 09:16:19 -07:00
|
|
|
}
|
2020-02-26 15:07:02 -07:00
|
|
|
if wanted[protocol.SourceOrganizeImports] {
|
2019-12-17 14:13:33 -07:00
|
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
|
|
Title: "Tidy",
|
|
|
|
Kind: protocol.SourceOrganizeImports,
|
|
|
|
Command: &protocol.Command{
|
|
|
|
Title: "Tidy",
|
|
|
|
Command: "tidy",
|
|
|
|
Arguments: []interface{}{fh.Identity().URI},
|
|
|
|
},
|
|
|
|
})
|
|
|
|
}
|
2019-09-18 23:21:54 -06:00
|
|
|
case source.Go:
|
2020-04-29 15:49:22 -06:00
|
|
|
// 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
|
|
|
|
}
|
2020-03-15 13:41:57 -06:00
|
|
|
diagnostics := params.Context.Diagnostics
|
|
|
|
|
2020-02-26 15:07:02 -07:00
|
|
|
// 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)
|
2020-03-15 13:41:57 -06:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2020-02-26 15:07:02 -07:00
|
|
|
// 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),
|
|
|
|
},
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// Check for context cancellation before processing analysis fixes.
|
|
|
|
if ctx.Err() != nil {
|
|
|
|
return nil, ctx.Err()
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
2020-03-15 13:41:57 -06:00
|
|
|
// Retrieve any necessary analysis fixes or edits.
|
|
|
|
if (wanted[protocol.QuickFix] || wanted[protocol.SourceFixAll]) && len(diagnostics) > 0 {
|
2020-02-26 15:07:02 -07:00
|
|
|
analysisQuickFixes, highConfidenceEdits, err := analysisFixes(ctx, snapshot, fh, diagnostics)
|
2019-09-18 23:21:54 -06:00
|
|
|
if err != nil {
|
2020-02-26 15:07:02 -07:00
|
|
|
return nil, err
|
2019-09-18 23:21:54 -06:00
|
|
|
}
|
2020-02-26 15:07:02 -07:00
|
|
|
if wanted[protocol.QuickFix] {
|
|
|
|
// Add the quick fixes reported by go/analysis.
|
|
|
|
codeActions = append(codeActions, analysisQuickFixes...)
|
2020-03-15 13:41:57 -06:00
|
|
|
|
2020-02-26 15:07:02 -07:00
|
|
|
// If there are any diagnostics relating to the go.mod file,
|
|
|
|
// add their corresponding quick fixes.
|
|
|
|
moduleQuickFixes, err := getModuleQuickFixes(ctx, snapshot, diagnostics)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2019-07-30 12:00:02 -06:00
|
|
|
}
|
2020-02-26 15:07:02 -07:00
|
|
|
codeActions = append(codeActions, moduleQuickFixes...)
|
2019-07-30 12:00:02 -06:00
|
|
|
}
|
2020-02-26 15:07:02 -07:00
|
|
|
if wanted[protocol.SourceFixAll] && len(highConfidenceEdits) > 0 {
|
|
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
|
|
Title: "Simplifications",
|
|
|
|
Kind: protocol.SourceFixAll,
|
|
|
|
Edit: protocol.WorkspaceEdit{
|
|
|
|
DocumentChanges: highConfidenceEdits,
|
|
|
|
},
|
|
|
|
})
|
2020-01-22 12:23:12 -07:00
|
|
|
}
|
2019-04-05 13:56:08 -06:00
|
|
|
}
|
2020-06-03 12:56:29 -06:00
|
|
|
fillActions, err := source.FillStruct(ctx, snapshot, fh, params.Range)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
codeActions = append(codeActions, fillActions...)
|
2019-09-18 23:21:54 -06:00
|
|
|
default:
|
|
|
|
// Unsupported file kind for a code action.
|
|
|
|
return nil, nil
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
2019-04-05 13:56:08 -06:00
|
|
|
return codeActions, nil
|
|
|
|
}
|
|
|
|
|
2020-02-26 15:07:02 -07:00
|
|
|
var missingRequirementRe = regexp.MustCompile(`(.+) is not in your go.mod file`)
|
|
|
|
|
|
|
|
func getModuleQuickFixes(ctx context.Context, snapshot source.Snapshot, diagnostics []protocol.Diagnostic) ([]protocol.CodeAction, error) {
|
|
|
|
// Don't bother getting quick fixes if we have no relevant diagnostics.
|
|
|
|
var missingDeps map[string]protocol.Diagnostic
|
|
|
|
for _, diagnostic := range diagnostics {
|
|
|
|
matches := missingRequirementRe.FindStringSubmatch(diagnostic.Message)
|
|
|
|
if len(matches) != 2 {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if missingDeps == nil {
|
|
|
|
missingDeps = make(map[string]protocol.Diagnostic)
|
|
|
|
}
|
|
|
|
missingDeps[matches[1]] = diagnostic
|
|
|
|
}
|
|
|
|
if len(missingDeps) == 0 {
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
// Get suggested fixes for each missing dependency.
|
|
|
|
edits, err := mod.SuggestedGoFixes(ctx, snapshot)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
var codeActions []protocol.CodeAction
|
|
|
|
for dep, diagnostic := range missingDeps {
|
|
|
|
edit, ok := edits[dep]
|
|
|
|
if !ok {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
codeActions = append(codeActions, protocol.CodeAction{
|
|
|
|
Title: fmt.Sprintf("Add %s to go.mod", dep),
|
|
|
|
Diagnostics: []protocol.Diagnostic{diagnostic},
|
|
|
|
Edit: protocol.WorkspaceEdit{
|
|
|
|
DocumentChanges: []protocol.TextDocumentEdit{edit},
|
|
|
|
},
|
|
|
|
Kind: protocol.QuickFix,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return codeActions, nil
|
|
|
|
}
|
|
|
|
|
2019-09-18 23:21:54 -06:00
|
|
|
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
|
|
|
|
}
|
|
|
|
|
2019-07-30 12:00:02 -06:00
|
|
|
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
|
|
|
|
}
|
|
|
|
|
2020-03-15 13:41:57 -06:00
|
|
|
func analysisFixes(ctx context.Context, snapshot source.Snapshot, fh source.FileHandle, diagnostics []protocol.Diagnostic) ([]protocol.CodeAction, []protocol.TextDocumentEdit, error) {
|
|
|
|
if len(diagnostics) == 0 {
|
|
|
|
return nil, nil, nil
|
|
|
|
}
|
|
|
|
|
2019-06-27 19:26:42 -06:00
|
|
|
var codeActions []protocol.CodeAction
|
2020-03-15 13:41:57 -06:00
|
|
|
var sourceFixAllEdits []protocol.TextDocumentEdit
|
2019-11-20 12:26:02 -07:00
|
|
|
|
2019-11-29 23:17:57 -07:00
|
|
|
phs, err := snapshot.PackageHandles(ctx, fh)
|
2019-09-09 17:26:26 -06:00
|
|
|
if err != nil {
|
2020-03-15 13:41:57 -06:00
|
|
|
return nil, nil, err
|
2019-09-09 17:26:26 -06:00
|
|
|
}
|
2019-09-24 14:28:59 -06:00
|
|
|
// We get the package that source.Diagnostics would've used. This is hack.
|
|
|
|
// TODO(golang/go#32443): The correct solution will be to cache diagnostics per-file per-snapshot.
|
2020-01-14 16:29:21 -07:00
|
|
|
ph, err := source.WidestPackageHandle(phs)
|
2019-10-10 13:22:30 -06:00
|
|
|
if err != nil {
|
2020-03-15 13:41:57 -06:00
|
|
|
return nil, nil, err
|
2019-10-10 13:22:30 -06:00
|
|
|
}
|
2019-09-24 14:28:59 -06:00
|
|
|
for _, diag := range diagnostics {
|
2020-03-31 21:53:42 -06:00
|
|
|
srcErr, analyzer, ok := findSourceError(ctx, snapshot, ph.ID(), diag)
|
|
|
|
if !ok {
|
2019-09-24 14:28:59 -06:00
|
|
|
continue
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
2019-10-24 13:44:41 -06:00
|
|
|
for _, fix := range srcErr.SuggestedFixes {
|
2019-11-12 15:58:37 -07:00
|
|
|
action := protocol.CodeAction{
|
2019-09-24 14:28:59 -06:00
|
|
|
Title: fix.Title,
|
|
|
|
Kind: protocol.QuickFix,
|
|
|
|
Diagnostics: []protocol.Diagnostic{diag},
|
2019-11-17 12:29:15 -07:00
|
|
|
Edit: protocol.WorkspaceEdit{},
|
2019-11-12 15:58:37 -07:00
|
|
|
}
|
|
|
|
for uri, edits := range fix.Edits {
|
2020-01-10 15:37:29 -07:00
|
|
|
fh, err := snapshot.GetFile(uri)
|
2019-11-12 15:58:37 -07:00
|
|
|
if err != nil {
|
2020-02-26 15:07:02 -07:00
|
|
|
return nil, nil, err
|
2019-11-12 15:58:37 -07:00
|
|
|
}
|
2020-03-15 13:41:57 -06:00
|
|
|
docChanges := documentChanges(fh, edits)
|
|
|
|
if analyzer.HighConfidence {
|
|
|
|
sourceFixAllEdits = append(sourceFixAllEdits, docChanges...)
|
|
|
|
}
|
|
|
|
action.Edit.DocumentChanges = append(action.Edit.DocumentChanges, docChanges...)
|
2019-11-12 15:58:37 -07:00
|
|
|
}
|
|
|
|
codeActions = append(codeActions, action)
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
|
|
|
}
|
2020-03-15 13:41:57 -06:00
|
|
|
return codeActions, sourceFixAllEdits, nil
|
2019-06-27 19:26:42 -06:00
|
|
|
}
|
2019-11-12 15:58:37 -07:00
|
|
|
|
2020-03-31 21:53:42 -06:00
|
|
|
func findSourceError(ctx context.Context, snapshot source.Snapshot, pkgID string, diag protocol.Diagnostic) (*source.Error, source.Analyzer, bool) {
|
|
|
|
var analyzer *source.Analyzer
|
|
|
|
|
|
|
|
// If the source is "compiler", we expect a type error analyzer.
|
|
|
|
if diag.Source == "compiler" {
|
|
|
|
for _, a := range snapshot.View().Options().TypeErrorAnalyzers {
|
|
|
|
if a.FixesError(diag.Message) {
|
|
|
|
analyzer = &a
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
// This code assumes that the analyzer name is the Source of the diagnostic.
|
|
|
|
// If this ever changes, this will need to be addressed.
|
|
|
|
if a, ok := snapshot.View().Options().DefaultAnalyzers[diag.Source]; ok {
|
|
|
|
analyzer = &a
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if analyzer == nil || !analyzer.Enabled(snapshot) {
|
|
|
|
return nil, source.Analyzer{}, false
|
|
|
|
}
|
|
|
|
analysisErrors, err := snapshot.Analyze(ctx, pkgID, analyzer.Analyzer)
|
|
|
|
if err != nil {
|
|
|
|
return nil, source.Analyzer{}, false
|
|
|
|
}
|
|
|
|
for _, err := range analysisErrors {
|
|
|
|
if err.Message != diag.Message {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if protocol.CompareRange(err.Range, diag.Range) != 0 {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if err.Category != analyzer.Analyzer.Name {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
// The error matches.
|
|
|
|
return err, *analyzer, true
|
|
|
|
}
|
|
|
|
return nil, source.Analyzer{}, false
|
|
|
|
}
|
|
|
|
|
2019-11-12 15:58:37 -07:00
|
|
|
func documentChanges(fh source.FileHandle, edits []protocol.TextEdit) []protocol.TextDocumentEdit {
|
|
|
|
return []protocol.TextDocumentEdit{
|
|
|
|
{
|
|
|
|
TextDocument: protocol.VersionedTextDocumentIdentifier{
|
|
|
|
Version: fh.Identity().Version,
|
|
|
|
TextDocumentIdentifier: protocol.TextDocumentIdentifier{
|
2020-02-12 14:36:46 -07:00
|
|
|
URI: protocol.URIFromSpanURI(fh.Identity().URI),
|
2019-11-12 15:58:37 -07:00
|
|
|
},
|
|
|
|
},
|
|
|
|
Edits: edits,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|