x/tools/gopls: instead of hard-coded a link to pkgsite, provide link to definition if the symbol is local (defined in the same module)

[K9gam]

What version of Go, VS Code & VS Code Go extension are you using?

Version Information

• Run go version to get version of Go from the VS Code integrated terminal.
  • go version go1.26.3 linux/amd64
• Run gopls -v version to get version of Gopls from the VS Code integrated terminal.
  • zsh: command not found: gopls
• Run code -v or code-insiders -v to get version of VS Code or VS Code Insiders.
  • 1.123.2
    3c631b164c239e7aeaaae7c626b46c527b361af2
    x64
• Check your installed extensions to get the version of the VS Code Go extension
  • v0.52.2
• Run Ctrl+Shift+P (Cmd+Shift+P on Mac OS) > Go: Locate Configured Go Tools command.

  • Tools Configuration

Environment

GOBIN: undefined
toolsGopath:
gopath: /home/user/go
GOROOT: /usr/local/go
PATH: /home/user/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/snap/bin:/var/cfengine/bin:/usr/local/go/bin

Tools

go:	/usr/local/go/bin/go: go version go1.26.3 linux/amd64

gotests:	not installed
impl:	not installed
goplay:	not installed
dlv:	not installed
gopls:	/home/user/go/bin/gopls	(version: v0.22.0 built with go: go1.26.3)

Go env

Workspace Folder (mygit): /home/user/repos/mygit

AR='ar'
CC='gcc'
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_ENABLED='1'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
CXX='g++'
GCCGO='gccgo'
GO111MODULE=''
GOAMD64='v1'
GOARCH='amd64'
GOAUTH='netrc'
GOBIN=''
GOCACHE='/home/user/.cache/go-build'
GOCACHEPROG=''
GODEBUG=''
GOENV='/home/user/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFIPS140='off'
GOFLAGS=''
GOGCCFLAGS='-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build825909314=/tmp/go-build -gno-record-gcc-switches'
GOHOSTARCH='amd64'
GOHOSTOS='linux'
GOINSECURE=''
GOMOD='/mnt/build/repos/mygit/go.mod'
GOMODCACHE='/home/user/go/pkg/mod'
GONOPROXY='/home/user/repos/mygit/pkg/xxx'
GONOSUMDB='/home/user/repos/mygit/pkg/xxx'
GOOS='linux'
GOPATH='/home/user/go'
GOPRIVATE='/home/user/repos/mygit/pkg/xxx'
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/usr/local/go'
GOSUMDB='sum.golang.org'
GOTELEMETRY='local'
GOTELEMETRYDIR='/home/user/.config/go/telemetry'
GOTMPDIR=''
GOTOOLCHAIN='auto'
GOTOOLDIR='/usr/local/go/pkg/tool/linux_amd64'
GOVCS=''
GOVERSION='go1.26.3'
GOWORK=''
PKG_CONFIG='pkg-config'

Share the Go related settings you have added/edited

None

Describe the bug

When hovering mouse pointer over a private package in the VS editor, it suggests documentation link on pkg.go.dev.

Acting by suggestion from https://github.com/golang/vscode-go/wiki/settings#uidocumentationlinktarget and trying to set GOPRIVATE environment variable to github path for the private package or to the local filesystem path for it gives no change in hovering behavior.

I'm working inside a workspace and private package is located as ./pkg/xxx.

Expected fix would be at least to hide the link in order to not mislead with providing links to pkg.go.dev for local/private packages.
Ideally the link should point to the correct package location.

Steps to reproduce the behavior:

1. Hover mouse pointer over a private package name in VS Code editor.
2. Notice the documentation link points to pkg.go.dev.

Screenshots or recordings

N/A

[h9jiang]

Hi @K9gam

To make sure I understand your reported issue, the link you are describing is the screenshots below, at the bottom of the hover over box:

And when you say

Ideally the link should point to the correct package location.

You mean, when you click the link, you would hope gopls / vscode-go will take you to the definition of the symbol. Like Go To Definition. Instead of having a link that take you to pkgsite that is 404.

I think the gopls does not actually visit the website and notice it is a 404. So gopls just put the url together based on the syntax and type checks. Gopls made an assumption that this package is public available, I think.

One thing that gopls honor is the GOPRIVATE as you mentioned, but maybe the setting is not very obvious, have you try the configuration in vscode

    "go.toolsEnvVars": {
        "GOPRIVATE": "golang.org/x/tools/gopls/internal/*"
    },

after the setting

Let me know if this solves your problem or not.

[K9gam]

Hi, @h9jiang ,

Your understanding is correct, I meant the link at the bottom of hover over box and desired "Go to definition" behavior.
I changed my GOPRIVATE to the path equal to the string like the local package is imported in import() "mymodule/pkg/xxx" and can confirm that observe absence of the link as on the last screenshot, thus GOPRIVATE works for me.

As modifying GOPRIVATE for every project with local packages seems to be not the best user experience, here's my suggestion.
Since gopls displays object description like "Package cache is the core..." for the local packages, thus it can determine whether that a local or remote package, and offer "go to definition" link for the local ones instead of pkg.go.dev link.

[h9jiang]

Thanks, in that case, I will first transfer the issue from vscode-go to gopls. Then we can ask Alex or Alan's opinion on this.

As modifying GOPRIVATE for every project with local packages seems to be not the best user experience

I would assume in a company env, a lot of private module will have the same "prefix" in the package path. So I would assume it would be easy to just write the following to the GOPRIVATE and make it globally available in the user settings json file (which will be applied to all the workspace you are working on.

    "go.toolsEnvVars": {
        "GOPRIVATE": "path/to/my/company/go/module/*"
    },

whether that a local or remote package

I think this is can be easily done. Just to check whether the package we are referring to is the same module or not.