x/tools/gopls: temporarily revert the removal of Structured hoverkind

[bhcleek]

gopls version

golang.org/x/tools/gopls v0.18.0

go env

GO111MODULE=''
GOARCH='arm64'
GOBIN='/Users/bhcleek/go/bin'
GOCACHE='/Users/bhcleek/Library/Caches/go-build'
GOENV='/Users/bhcleek/Library/Application Support/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFLAGS=''
GOHOSTARCH='arm64'
GOHOSTOS='darwin'
GOINSECURE=''
GOMODCACHE='/Users/bhcleek/go/pkg/mod'
GONOPROXY='*.internal.digitalocean.com,github.com/digitalocean'
GONOSUMDB='*.internal.digitalocean.com,github.com/digitalocean'
GOOS='darwin'
GOPATH='/Users/bhcleek/go'
GOPRIVATE='*.internal.digitalocean.com,github.com/digitalocean'
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/usr/local/go'
GOSUMDB='sum.golang.org'
GOTMPDIR=''
GOTOOLCHAIN='auto'
GOTOOLDIR='/usr/local/go/pkg/tool/darwin_arm64'
GOVCS=''
GOVERSION='go1.23.0'
GODEBUG=''
GOTELEMETRY='local'
GOTELEMETRYDIR='/Users/bhcleek/Library/Application Support/go/telemetry'
GCCGO='gccgo'
GOARM64='v8.0'
AR='ar'
CC='clang'
CXX='clang++'
CGO_ENABLED='1'
GOMOD='/dev/null'
GOWORK=''
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
PKG_CONFIG='pkg-config'
GOGCCFLAGS='-fPIC -arch arm64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -ffile-prefix-map=/var/folders/f9/d6g779t53gq_20w0zm2f_1zm0000gn/T/go-build530885244=/tmp/go-build -gno-record-gcc-switches -fno-common'

What did you do?

Updated to gopls v0.18.0.

What did you see happen?

gopls v0.18.0 removed structured hover results, breaking vim-go. Vim-go has a few features that depended on the structured result: :GoDoc, hover balloon documentation, and :GoDocBrowser all depended on that structure (and not all for the same reason).

fatih/vim-go#3701 was created this morning, but only documents one of the issues that this change caused.

Is it possible to revert? If not, where can I find a clear definition of the data and its structure that each of the hoverKind values will return, especially FullDocumentation?

What did you expect to see?

Documentation

Editor and settings

Vim w/ vim-go

Logs

No response

[findleyr]

Yes, I'd not seen this issue and just opened #71880 to track the revert. I'll close that as a dupe of this.

We'll revert for [email protected], which should be released next week (ideally, on Monday).

[findleyr]

As described in fatih/vim-go#3701 (comment), we should revert this without a warning for now, since the setting is set internally to vim-go, and therefore users would not be able to avoid the warning.

I will ask vim-go to stop using this setting, so that we can add a warning in [email protected], and finally actually remove this setting in [email protected].

[gabyhelp]

Related Issues

• x/tools/gopls: temporarily reinstate the 'Structured' hoverkind. #71880 (closed)
• x/tools/gopls: empty hover response should be null, not a zero struct #37570 (closed)
• x/tools/gopls: hover stops working #64778 (closed)
• x/tools/gopls: add method documentation & jump to page source to hovered type. #66721 (closed)
• x/tools/gopls: gopls was broken with the latest tip version #62163 (closed)
• x/tools/gopls: broken hovering in the builtin file #68026 (closed)
• x/tools/cmd/gopls: hover returns error when over non-identifier #32971 (closed)
• x/tools/gopls: client Configuration made with identical items? #33347 (closed)
• x/tools/gopls: gopls doc viewer failed with "package not found" error #70453 (closed)
• x/tools/gopls: hover over some tokens in template files oops #50031 (closed)

_{(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)}

[gopherbot]

Change https://go.dev/cl/651238 mentions this issue: gopls: temporarily reinstate the "Structured" hover kind

[gopherbot]

Change https://go.dev/cl/651239 mentions this issue: [gopls-release-branch.0.18] gopls: temporarily reinstate the "Structured" hover kind

[findleyr]

This is released in [email protected].

go install golang.org/x/tools/[email protected]

[gopherbot]

Change https://go.dev/cl/651618 mentions this issue: gopls/internal/golang: add missing json tags for hoverResult

[gopherbot]

Change https://go.dev/cl/651658 mentions this issue: [gopls-release-branch.0.18] gopls/internal/golang: add missing json tags for hoverResult