Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools/gopls: add cmd support for references
This change adds command line support for references. Example: $ gopls references ~/tmp/foo/main.go:8:6 $ gopls references ~/tmp/foo/main.go:#53 Updates golang/go#32875 Change-Id: I9a0cf6ae8ba0a5c3d4ffc829b96fe3b42297c192 Reviewed-on: https://go-review.googlesource.com/c/tools/+/202178 Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rebecca Stambler <rstambler@golang.org>
- Loading branch information
1 parent
cf891b7
commit 2b544e3
Showing
7 changed files
with
141 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
// 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/internal/lsp/protocol" | ||
"golang.org/x/tools/internal/span" | ||
"golang.org/x/tools/internal/tool" | ||
"sort" | ||
) | ||
|
||
// references implements the references verb for gopls | ||
type references struct { | ||
IncludeDeclaration bool `flag:"d" help:"include the declaration of the specified identifier in the results"` | ||
|
||
app *Application | ||
} | ||
|
||
func (r *references) Name() string { return "references" } | ||
func (r *references) Usage() string { return "<position>" } | ||
func (r *references) ShortHelp() string { return "display selected identifier's references" } | ||
func (r *references) DetailedHelp(f *flag.FlagSet) { | ||
fmt.Fprint(f.Output(), ` | ||
Example: | ||
$ # 1-indexed location (:line:column or :#offset) of the target identifier | ||
$ gopls references helper/helper.go:8:6 | ||
$ gopls references helper/helper.go:#53 | ||
gopls references flags are: | ||
`) | ||
f.PrintDefaults() | ||
} | ||
|
||
func (r *references) Run(ctx context.Context, args ...string) error { | ||
if len(args) != 1 { | ||
return tool.CommandLineErrorf("references expects 1 argument (position)") | ||
} | ||
|
||
conn, err := r.app.connect(ctx) | ||
if err != nil { | ||
return err | ||
} | ||
defer conn.terminate(ctx) | ||
|
||
from := span.Parse(args[0]) | ||
file := conn.AddFile(ctx, from.URI()) | ||
if file.err != nil { | ||
return file.err | ||
} | ||
|
||
loc, err := file.mapper.Location(from) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
p := protocol.ReferenceParams{ | ||
Context: protocol.ReferenceContext{ | ||
IncludeDeclaration: r.IncludeDeclaration, | ||
}, | ||
TextDocumentPositionParams: protocol.TextDocumentPositionParams{ | ||
TextDocument: protocol.TextDocumentIdentifier{URI: loc.URI}, | ||
Position: loc.Range.Start, | ||
}, | ||
} | ||
locations, err := conn.References(ctx, &p) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
if len(locations) == 0 { | ||
return tool.CommandLineErrorf("%v: not an identifier", from) | ||
} | ||
|
||
var spans []string | ||
for _, l := range locations { | ||
f := conn.AddFile(ctx, span.NewURI(l.URI)) | ||
// convert location to span for user-friendly 1-indexed line | ||
// and column numbers | ||
span, err := f.mapper.Span(l) | ||
if err != nil { | ||
return err | ||
} | ||
spans = append(spans, fmt.Sprint(span)) | ||
} | ||
|
||
sort.Strings(spans) | ||
for _, s := range spans { | ||
fmt.Println(s) | ||
} | ||
|
||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
// 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 cmdtest | ||
|
||
import ( | ||
"fmt" | ||
"golang.org/x/tools/internal/lsp/cmd" | ||
"golang.org/x/tools/internal/tool" | ||
"testing" | ||
|
||
"golang.org/x/tools/internal/span" | ||
) | ||
|
||
func (r *runner) References(t *testing.T, spn span.Span, itemList []span.Span) { | ||
var expect string | ||
for _, i := range itemList { | ||
expect += fmt.Sprintln(i) | ||
} | ||
|
||
uri := spn.URI() | ||
filename := uri.Filename() | ||
target := filename + fmt.Sprintf(":%v:%v", spn.Start().Line(), spn.Start().Column()) | ||
|
||
app := cmd.New("gopls-test", r.data.Config.Dir, r.data.Config.Env, r.options) | ||
got := CaptureStdOut(t, func() { | ||
err := tool.Run(r.ctx, app, append([]string{"-remote=internal", "references"}, target)) | ||
if err != nil { | ||
fmt.Println(spn.Start().Line()) | ||
fmt.Println(err) | ||
} | ||
}) | ||
|
||
if expect != got { | ||
t.Errorf("references failed for %s expected:\n%s\ngot:\n%s", target, expect, got) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters