x/tools/gopls: DocumentSymbol returns incorrect selectionRange

[MischaPanch]

Go version

go version go1.24.2 linux/amd64

Output of go env in your module/workspace:

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/mpanchen/.cache/go-build'
GOCACHEPROG=''
GODEBUG=''
GOENV='/home/mpanchen/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFIPS140='off'
GOFLAGS=''
GOGCCFLAGS='-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build1575410318=/tmp/go-build -gno-record-gcc-switches'
GOHOSTARCH='amd64'
GOHOSTOS='linux'
GOINSECURE=''
GOMOD='/dev/null'
GOMODCACHE='/home/mpanchen/go/pkg/mod'
GONOPROXY=''
GONOSUMDB=''
GOOS='linux'
GOPATH='/home/mpanchen/go'
GOPRIVATE=''
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/usr/local/go'
GOSUMDB='sum.golang.org'
GOTELEMETRY='local'
GOTELEMETRYDIR='/home/mpanchen/.config/go/telemetry'
GOTMPDIR=''
GOTOOLCHAIN='auto'
GOTOOLDIR='/usr/local/go/pkg/tool/linux_amd64'
GOVCS=''
GOVERSION='go1.24.2'
GOWORK=''
PKG_CONFIG='pkg-config'

What did you do?

This issue is about gopls. The selectionRange attribute of a symbol coincides with range, but it shouldn't. This means it becomes impossible to reference a symbol (e.g., find references to it programatically) from the info retrieved through the language server, as one would need the selectionRange for it (specifically, the character).

What did you see happen?

For example, for something like this

func main() {
    fmt.Println("Hello, Go!")
    Helper()
}

the document_symbol request will return a selectionRange with starting character 0.

What did you expect to see?

It should return the starting character 5 in the selection range.

[gabyhelp]

Related Issues

• x/tools/gopls: DocumentHighlight does not return correct locations for non-main module packages #43848 (closed)
• x/tools/cmd/gopls: references returns the declaration position twice #34087 (closed)

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

[adonovan]

the document_symbol request will return a selectionRange with starting character 0.
It should return the starting character 5 in the selection range.

Could you provide a complete sequence of steps to reproduce the problem? The logic looks fine to me, and I can't reproduce the problem on your example:

xtools$ cat a.go
package main

import "fmt"

func main() {
    fmt.Println("Hello, Go!")
    Helper()
}

xtools$ gopls symbols ./a.go 
main Function 5:6-5:10

[MischaPanch]

Sorry, you are right, the error was on my side. I was using gopls programatically and had to explicitly specify

            "documentSymbol": {
                "dynamicRegistration": true,
                "hierarchicalDocumentSymbolSupport": true,
                "symbolKind": {
                    "valueSet": [
                        1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
                        14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26
                    ]
                }
            }

in the initialization. Closing, and apologies for the late response