goimports missing from Install/Update Tools

[rittneje]

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.23.6 darwin/arm64

• Run gopls -v version to get version of Gopls from the VS Code integrated terminal.

Build info
----------
golang.org/x/tools/gopls v0.17.1
    golang.org/x/tools/gopls@v0.17.1 h1:Mt/DSfnnSe3dyf6MH/dZZ0iww+viHNhAFc4rEYDiOAw=
    github.com/BurntSushi/toml@v1.4.1-0.20240526193622-a339e1f7089c h1:pxW6RcqyfI9/kWtOwnv/G+AzdKuy2ZrqINhenH4HyNs=
    github.com/google/go-cmp@v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
    golang.org/x/exp/typeparams@v0.0.0-20231108232855-2478ac86f678 h1:1P7xPZEwZMoBoz0Yze5Nx2/4pxj6nw9ZqHWXqP0iRgQ=
    golang.org/x/mod@v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
    golang.org/x/sync@v0.9.0 h1:fEo0HyrW1GIgZdpbhCRO0PkJajUS5H9IFUztCgEo2jQ=
    golang.org/x/telemetry@v0.0.0-20241106142447-58a1122356f5 h1:TCDqnvbBsFapViksHcHySl/sW4+rTGNIAoJJesHRuMM=
    golang.org/x/text@v0.20.0 h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=
    golang.org/x/tools@v0.27.1-0.20241219162658-575221bfbda3 h1:kgwdasJRsdDWYgWcEgMF424DiXwwXHSb3V8xVTi//i8=
    golang.org/x/vuln@v1.0.4 h1:SP0mPeg2PmGCu03V+61EcQiOjmpri2XijexKdzv8Z1I=
    honnef.co/go/tools@v0.5.1 h1:4bH5o3b5ZULQ4UrBmP+63W9r7qIkqJClEA9ko5YKx+I=
    mvdan.cc/gofumpt@v0.7.0 h1:bg91ttqXmi9y2xawvkuMXyvAA/1ZGJqYAEGjXuP0JXU=
    mvdan.cc/xurls/v2@v2.5.0 h1:lyBNOm8Wo71UknhUs4QTFUNNMyxy2JEIaKKo0RWOh+8=
go: go1.23.6

• Run code -v or code-insiders -v to get version of VS Code or VS Code Insiders.

1.96.4
cd4ee3b1c348a13bafd8f9ad8060705f6d4b9cba
arm64

• Check your installed extensions to get the version of the VS Code Go extension

0.44.0

• Run Ctrl+Shift+P (Cmd+Shift+P on Mac OS) > Go: Locate Configured Go Tools command.

# Tools Configuration


## Environment

GOBIN: undefined
toolsGopath: /Users/rittneje/gotools
gopath: /Users/rittneje/go-workspace
GOROOT: /usr/local/go
PATH: /opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:/Applications/Wireshark.app/Contents/MacOS:/usr/local/go/bin

## Tools

	go:	/usr/local/go/bin/go: go version go1.23.6 darwin/arm64

	gopls:	/Users/rittneje/gotools/bin/gopls	(version: v0.17.1 built with go: go1.23.6)
	gotests:	/Users/rittneje/gotools/bin/gotests	(version: v1.6.0 built with go: go1.23.6)
	gomodifytags:	/Users/rittneje/gotools/bin/gomodifytags	(version: v1.17.0 built with go: go1.23.6)
	impl:	/Users/rittneje/gotools/bin/impl	(version: v1.4.0 built with go: go1.23.6)
	goplay:	/Users/rittneje/gotools/bin/goplay	(version: v1.0.0 built with go: go1.23.6)
	dlv:	/Users/rittneje/gotools/bin/dlv	(version: v1.24.0 built with go: go1.23.6)
	golangci-lint:	/Users/rittneje/gotools/bin/golangci-lint	(version: v1.63.4 built with go: go1.23.6)

## Go env

Workspace Folder (go-workspace): /Users/rittneje/go-workspace

	GO111MODULE=''
	GOARCH='arm64'
	GOBIN=''
	GOCACHE='/Users/rittneje/Library/Caches/go-build'
	GOENV='/Users/rittneje/Library/Application Support/go/env'
	GOEXE=''
	GOEXPERIMENT=''
	GOFLAGS=''
	GOHOSTARCH='arm64'
	GOHOSTOS='darwin'
	GOINSECURE=''
	GOMODCACHE='/Users/rittneje/go-workspace/pkg/mod'
	GONOPROXY=''
	GONOSUMDB=''
	GOOS='darwin'
	GOPATH='/Users/rittneje/go-workspace'
	GOPRIVATE=''
	GOPROXY='https://proxy.golang.org,direct'
	GOROOT='/usr/local/go'
	GOSUMDB='sum.golang.org'
	GOTMPDIR=''
	GOTOOLCHAIN='local'
	GOTOOLDIR='/usr/local/go/pkg/tool/darwin_arm64'
	GOVCS=''
	GOVERSION='go1.23.6'
	GODEBUG=''
	GOTELEMETRY='off'
	GOTELEMETRYDIR='/Users/rittneje/Library/Application Support/go/telemetry'
	GCCGO='gccgo'
	GOARM64='v8.0'
	AR='ar'
	CC='clang'
	CXX='clang++'
	CGO_ENABLED='1'
	GOMOD='/dev/null'
	GOWORK='/Users/rittneje/go-workspace/go.work'
	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/4r/75blkk01543_51vp0jcgy1kr0000gn/T/go-build3781262283=/tmp/go-build -gno-record-gcc-switches -fno-common'

Share the Go related settings you have added/edited

Run Preferences: Open Settings (JSON) command to open your settings.json file.
Share all the settings with the go. or ["go"] or gopls prefixes.

{
    "go.toolsGopath": "${env:HOME}/gotools",
    "[go]": {
        "editor.formatOnSave": true
    },
    "go.useLanguageServer": true,
    "go.vetOnSave": "package",
    "go.formatTool": "goimports",
    "go.lintTool": "golangci-lint"
}

Describe the bug

When I do Cmd+Shift+P and click "Go: Install/Update Tools", it does not include goimports, even though I have set it in "go.formatTool".

Steps to reproduce the behavior:

1. Set "go.formatTool": "goimports" in user or workspace settings.
2. Do Cmd+Shift+P and click "Go: Install/Update Tools".

Screenshots or recordings

It should also be noted that upon saving the settings file, it gives a popup to install goimports. But this is the only way to do so.

[h9jiang]

Hi rittneje, if you hover over the package json configuration, you will find the documentation mentioning:

The language server (gopls) is now responsible of formatting unless it's being done through a custom format tools. Internally, goimports is already replaced by gopls.

I saw you have this configuration set up "go.useLanguageServer": true,. So I assumed you have gopls running running as language server. If you are using Gopls as language server, could you try remove "go.formatTool": "goimports", and see if gopls is doing the same thing as you are expecting.

To explain why goimports is missing from the install/update tools, vscode-go prefer not to offer install / update any tool that is already replaced by gopls to encourage the gopls usage.

[rittneje]

@h9jiang The current behavior seems very inconsistent and confusing. According to the tooltip in your screenshot, setting "goimports" means it will be handled by gopls. But if that's the case, why am I prompted to install goimports upon saving the file, as I showed above?

Either goimports is always handled by gopls, in which case I should never be prompted, or it isn't, in which case it needs to show up under Install/Update Tools when it is the chosen value for go.formatTool.

[firelizzard18]

It sounds like there's some part of vscode-go that hasn't been updated to account for the fact that goimports is now integrated into gopls

[h9jiang]

Hi rittneje, I think you are right. This part is confusing.

I think the fact that we are prompting for installing goimports is a bug we should fix. I think what we can do here is stop prompting if the user already use language server gopls.

Exactly as firelizzard18 said, probably some where in vscode-go that hasn't been updated.

I find some history git issue related to this, I will assign to myself to stop prompting for install those tools when language server is enabled.

#51 microsoft/vscode-go#2753

[gopherbot]

Change https://go.dev/cl/648415 mentions this issue: extension/src: skip tool existence check if replaced by gopls