x/tools/gopls: using hints results in error saying hints already specified when not

[leighmcculloch]

gopls version

❯ gopls -v version
Build info
----------
golang.org/x/tools/gopls v0.11.0
    golang.org/x/tools/[email protected] h1:/nvKHdTtePQmrv9XN3gIUN9MOdUrKzO/dcqgbG6x8EY=
    github.com/BurntSushi/[email protected] h1:9F2/+DoOYIOksmaJFPw1tGFy1eDnIJXg+UHjuD8lTak=
    github.com/google/[email protected] h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
    github.com/sergi/[email protected] h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
    golang.org/x/[email protected] h1:QfTh0HpN6hlw6D3vu8DAwC8pBIwikq0AI1evdm+FksE=
    golang.org/x/exp/[email protected] h1:fl8k2zg28yA23264d82M4dp+YlJ3ngDcpuB1bewkQi4=
    golang.org/x/[email protected] h1:LapD9S96VoQRhi/GrNTqeBJFrUjs5UHCAtTlgwA5oZA=
    golang.org/x/[email protected] h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
    golang.org/x/[email protected] h1:ljd4t30dBnAvMZaQCevtY0xLLD0A+bRZXbgLMLU1F/A=
    golang.org/x/[email protected] h1:BrVqGRd7+k1DiOgtnFvAkoQEWQvBc25ouMJM6429SFg=
    golang.org/x/[email protected] h1:7/HkGkN/2ktghBCSRRgp31wAww4syfsW52tj7yirjWk=
    golang.org/x/[email protected] h1:qptQiQwEpETwDiz85LKtChqif9xhVkAm8Nhxs0xnTww=
    honnef.co/go/[email protected] h1:oDx7VAwstgpYpb3wv0oxiZlxY+foCpRAwY7Vk6XpAgA=
    mvdan.cc/[email protected] h1:JVf4NN1mIpHogBj7ABpgOyZc65/UUOkKQFkoURsz4MM=
    mvdan.cc/xurls/[email protected] h1:tzxjVAj+wSBmDcF6zBB7/myTy3gX9xvi8Tyr28AuQgc=
go: go1.19.1

go env

❯ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN="/Users/leighmcculloch/.local/bin"
GOCACHE="/Users/leighmcculloch/Library/Caches/go-build"
GOENV="/Users/leighmcculloch/Library/Application Support/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="darwin"
GOINSECURE=""
GOMODCACHE="/Users/leighmcculloch/.local/gopath/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="darwin"
GOPATH="/Users/leighmcculloch/.local/gopath"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/Users/leighmcculloch/.local/bin/go/latest"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/Users/leighmcculloch/.local/bin/go/latest/pkg/tool/darwin_amd64"
GOVCS=""
GOVERSION="go1.19.1"
GCCGO="gccgo"
GOAMD64="v1"
AR="ar"
CC="clang"
CXX="clang++"
CGO_ENABLED="1"
GOMOD="/Users/leighmcculloch/Code/playground/go.mod"
GOWORK=""
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -arch x86_64 -m64 -pthread -fno-caret-diagnostics -Qunused-arguments -fmessage-length=0 -fdebug-prefix-map=/var/folders/63/pqms5lmj1ys9wqt171l2y6xr0000gn/T/go-build450876770=/tmp/go-build -gno-record-gcc-switches -fno-common"

What did you do?

Added the following JSON to VSCode Settings.

    "gopls": {
        "ui.completion.usePlaceholders": true,
        "codelenses": {
            "generate": true,
            "gc_details": true,
        },
        "hints": {
            "assignVariableTypes": true
        }
    },

What did you expect to see?

Expected to see hints for variable type assignments.

What did you see instead?

The following error message immediately after saving the settings:

Invalid settings: parsing setting "hints": duplicate configuration for hints

Editor and settings

See above.

Logs

<!--
If possible please include gopls logs. Instructions for capturing them can be found here:
https://github.com/golang/tools/blob/master/gopls/doc/troubleshooting.md#capture-logs
-->

I spent a little while trying to figure out how to capture the logs in VSCode following the instructions in the link, as well as the "documentation for your editor" link, but I couldn't figure it out. I'm happy to provide logs if someone could give me some more straightforward instructions than those above.

[leighmcculloch]

What did you see instead?

The following error message immediately after saving the settings:

Invalid settings: parsing setting "hints": duplicate configuration for hints

This error message suggested to me that I'd accidentally double specified the "hints" block, but I've double checked my settings JSON file, and there's no "hints" other than the one shown above.

[leighmcculloch]

Ah so, I think I'm trying to configure inlayHints incorrectly for VSCode's specific use of gopls.

While the gopls hints are configurable with that option, the VSCode extension surfaces inlay hints under a different config, and then I think passes them through.

I got inlay hints working by instead adding this option in VSCode:

    "go.inlayHints.assignVariableTypes": true,

[gopherbot]

Change https://go.dev/cl/459519 mentions this issue: docs/features.md: add link to inlayHints settings from features.md

[suzmue]

@leighmcculloch Thanks for filing an issue and glad you figured it out! I updated the feature documentation in VS Code to point to the go.inlayHints.* settings, so hopefully that helps with this in the future.