blob: b0f675907489454cee70e91bf89319f7eeb26edc [file] [log] [blame]
// Copyright 2019 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 cmd
import (
"context"
"flag"
"fmt"
"golang.org/x/tools/gopls/internal/protocol"
"golang.org/x/tools/internal/tool"
)
// imports implements the import verb for gopls.
type imports struct {
EditFlags
app *Application
}
func (t *imports) Name() string { return "imports" }
func (t *imports) Parent() string { return t.app.Name() }
func (t *imports) Usage() string { return "[imports-flags] <filename>" }
func (t *imports) ShortHelp() string { return "updates import statements" }
func (t *imports) DetailedHelp(f *flag.FlagSet) {
fmt.Fprintf(f.Output(), `
Example: update imports statements in a file:
$ gopls imports -w internal/cmd/check.go
imports-flags:
`)
printFlagDefaults(f)
}
// Run performs diagnostic checks on the file specified and either;
// - if -w is specified, updates the file in place;
// - if -d is specified, prints out unified diffs of the changes; or
// - otherwise, prints the new versions to stdout.
func (t *imports) Run(ctx context.Context, args ...string) error {
if len(args) != 1 {
return tool.CommandLineErrorf("imports expects 1 argument")
}
t.app.editFlags = &t.EditFlags
conn, err := t.app.connect(ctx)
if err != nil {
return err
}
defer conn.terminate(ctx)
from := parseSpan(args[0])
uri := from.URI()
file, err := conn.openFile(ctx, uri)
if err != nil {
return err
}
actions, err := conn.CodeAction(ctx, &protocol.CodeActionParams{
TextDocument: protocol.TextDocumentIdentifier{
URI: uri,
},
Context: protocol.CodeActionContext{
Only: []protocol.CodeActionKind{protocol.SourceOrganizeImports},
},
})
if err != nil {
return fmt.Errorf("%v: %v", from, err)
}
var edits []protocol.TextEdit
for _, a := range actions {
for _, c := range a.Edit.DocumentChanges {
// This code action should affect only the specified file;
// it is safe to ignore others.
if c.TextDocumentEdit != nil && c.TextDocumentEdit.TextDocument.URI == uri {
edits = append(edits, protocol.AsTextEdits(c.TextDocumentEdit.Edits)...)
}
}
}
return applyTextEdits(file.mapper, edits, t.app.editFlags)
}