mirror of
https://github.com/golang/go
synced 2024-11-19 00:44:40 -07:00
6d8f1af9cc
This change adds command line support for signatureHelp. If the location provided corresponds to a function, that function signature is displayed. In case that function is documented the related comment is shown as well. Example: $ gopls signature ~/tmp/foo/main.go:7:5 $ $ Next(n int) []byte $ $ Next returns a slice containing the next n bytes from $ the buffer, advancing the buffer as if the bytes had been $ returned by Read. Note that linebreaks shown in the comment are just to adhere commit message guidelines. The command prints documentation comments on one line. Updates golang/go#32875 Change-Id: Ib0dcc3267c594f95d80b74f289c1235c2c0c5f64 Reviewed-on: https://go-review.googlesource.com/c/tools/+/204057 Reviewed-by: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
40 lines
1.1 KiB
Go
40 lines
1.1 KiB
Go
// 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"
|
|
"testing"
|
|
|
|
"golang.org/x/tools/internal/lsp/cmd"
|
|
"golang.org/x/tools/internal/lsp/source"
|
|
"golang.org/x/tools/internal/tool"
|
|
|
|
"golang.org/x/tools/internal/span"
|
|
)
|
|
|
|
func (r *runner) SignatureHelp(t *testing.T, spn span.Span, expectedSignature *source.SignatureInformation) {
|
|
goldenTag := "-signature"
|
|
if expectedSignature != nil {
|
|
goldenTag = expectedSignature.Label + goldenTag
|
|
}
|
|
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() {
|
|
tool.Run(r.ctx, app, append([]string{"-remote=internal", "signature"}, target))
|
|
})
|
|
|
|
expect := string(r.data.Golden(goldenTag, filename, func() ([]byte, error) {
|
|
return []byte(got), nil
|
|
}))
|
|
|
|
if expect != got {
|
|
t.Errorf("signature failed failed for %s expected:\n%s\ngot:\n%s", filename, expect, got)
|
|
}
|
|
}
|