Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x/tools/gopls: detect tools.go files, and suppress warning #69072

Open
Jyosua opened this issue Aug 15, 2024 · 7 comments
Open

x/tools/gopls: detect tools.go files, and suppress warning #69072

Jyosua opened this issue Aug 15, 2024 · 7 comments
Labels
gopls/analysis Issues related to running analysis in gopls gopls Issues related to the Go language server, gopls. help wanted Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
gopls/unplanned

Comments

@Jyosua
Copy link

Jyosua commented Aug 15, 2024 •
edited
Loading

I've been looking for a way to fix this for quite a bit of time and nothing I've tried has worked. I'm using oapi-codegen to generate boilerplate for my webserver. The authors of this library recommend the tools.go pattern for managing the dependency, so that go.mod can act as the single source of truth for versioning. For transparency, their readme recommends this here. Doing this actually works -- I can run go generate just fine and my code builds. However, VSCode insists on showing an error and warning in this tools.go file, marking the file and the module folder red:

image

This is driving me crazy. I'd like to at least suppress these, but I can't find any way to do so. I've tried using the lintFlags to exclude it, but it appears to be gopls and not staticcheck, so this doesn't do anything. I can't find a gopls configuration setting that will allow me to ignore this file or any issues with it, either.

For what it's worth, someone else noticed the same thing with a different library in this issue.

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.22.5 darwin/arm64
  • Run gopls -v version to get version of Gopls from the VS Code integrated terminal.
    • golang.org/x/tools/gopls v0.16.1
  • Run code -v or code-insiders -v to get version of VS Code or VS Code Insiders.
    • Version: 1.92.1
  • Check your installed extensions to get the version of the VS Code Go extension
    • v0.42.0
  • Run Ctrl+Shift+P (Cmd+Shift+P on Mac OS) > Go: Locate Configured Go Tools command.
# Tools Configuration


## Environment

GOBIN: undefined
toolsGopath: 
gopath: /Users/[username]/go
GOROOT: /opt/homebrew/Cellar/go/1.22.5/libexec
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:/Users/[username]/Library/Application Support/JetBrains/Toolbox/scripts:/Users/[username]/go/bin

## Tools

	go:	/opt/homebrew/bin/go: go version go1.22.5 darwin/arm64

	gopls:	/Users/[username]/go/bin/gopls	(version: v0.16.1 built with go: go1.22.5)
	gotests:	not installed
	gomodifytags:	not installed
	impl:	not installed
	goplay:	not installed
	dlv:	/Users/[username]/go/bin/dlv	(version: v1.23.0 built with go: go1.22.5)
	staticcheck:	/Users/[username]/go/bin/staticcheck	(version: v0.4.7 built with go: go1.22.5)

## Go env

Workspace Folder (point-system): /Users/[username]/Documents/Repositories/point-system

	GO111MODULE=''
	GOARCH='arm64'
	GOBIN=''
	GOCACHE='/Users/[username]/Library/Caches/go-build'
	GOENV='/Users/[username]/Library/Application Support/go/env'
	GOEXE=''
	GOEXPERIMENT=''
	GOFLAGS=''
	GOHOSTARCH='arm64'
	GOHOSTOS='darwin'
	GOINSECURE=''
	GOMODCACHE='/Users/[username]/go/pkg/mod'
	GONOPROXY=''
	GONOSUMDB=''
	GOOS='darwin'
	GOPATH='/Users/[username]/go'
	GOPRIVATE=''
	GOPROXY='https://proxy.golang.org,direct'
	GOROOT='/opt/homebrew/Cellar/go/1.22.5/libexec'
	GOSUMDB='sum.golang.org'
	GOTMPDIR=''
	GOTOOLCHAIN='auto'
	GOTOOLDIR='/opt/homebrew/Cellar/go/1.22.5/libexec/pkg/tool/darwin_arm64'
	GOVCS=''
	GOVERSION='go1.22.5'
	GCCGO='gccgo'
	AR='ar'
	CC='cc'
	CXX='c++'
	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/by/cxzl4qc57c3c8dd9p9snhn680000gn/T/go-build3419525479=/tmp/go-build -gno-record-gcc-switches -fno-common'

Share the Go related settings you have added/edited

{
    "go.lintTool": "staticcheck",
    "go.lintFlags": [
        "-exclude=gateway/tools/tools.go"
    ]
}
@hyangah hyangah added gopls/analysis Issues related to running analysis in gopls gopls Issues related to the Go language server, gopls. labels Aug 19, 2024
@hyangah
Copy link
Contributor

hyangah commented Aug 19, 2024

Yes, the error and warning messages come from the gopls (the language server).
Since the tools.go file has //go:build tools build tag, gopls processes and analyzes the file only it is open. The diagnostics will disappear as soon as you close the tools.go file.

The warning message ("No packages found for open file ...") seems intentional, but I think we can consider different wording and info-level.

The error message ("import X is a program, not an importable package") is not great for tools.go style dependency management practice. Can we teach gopls this special case and suppress this specific error message?

cc @findleyr

@findleyr
Copy link
Member

I'd be happy to accept a change suppressing errors that match this pattern. The heuristic seems accurate enough. Moving this to the Go issue tracker as a gopls issue.

A couple quick notes:

  • this error is from go list, by way of go/packages, which means it needs to be suppressed when processing go list errors, for example here
  • the warning only appears if the file is open, which is probably benign enough. However, if we have a heuristic for detecting a tools.go file, perhaps we could suppress all other diagnostics, and have an information diagnostic explaining that this file is not considered for builds, and linking to some documentation (or even just this issue)

@findleyr findleyr changed the title Tools.go Shows an Unsuppressible Warning and Error x/tools/gopls: detect tools.go files, and suppress warning Aug 26, 2024
@findleyr findleyr transferred this issue from golang/vscode-go Aug 26, 2024
@findleyr findleyr added this to the gopls/backlog milestone Aug 26, 2024
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Aug 26, 2024
@matthewmueller
Copy link

I'm also seeing this when trying to import packages that make use of this pattern:

CleanShot 2024-10-16 at 01 39 38@2x

found packages crossplane (analyze.go) and tools (tools.go) in $GOPATH/pkg/mod/github.com/nginxinc/nginx-go-crossplane@v0.4.63 go list

Would love to see this get resolved!

@findleyr
Copy link
Member

With 1.24 adding first class support for tools in the go.mod file, this issue is a much lower priority.
https://tip.golang.org/doc/go1.24#go-command

We will probably not resolve the current issue, instead letting folks take advantage of the new tool directive. (We have extremely limited resources, and adding a workaround for an obsolete convention unfortunately ranks pretty low).

@Jyosua
Copy link
Author

Jyosua commented Jan 8, 2025 •
edited
Loading

With 1.24 adding first class support for tools in the go.mod file, this issue is a much lower priority. https://tip.golang.org/doc/go1.24#go-command

We will probably not resolve the current issue, instead letting folks take advantage of the new tool directive. (We have extremely limited resources, and adding a workaround for an obsolete convention unfortunately ranks pretty low).

This is a much cleaner solution overall and I really like it! Thank you guys for adding this support directly to go.mod!

If I'm reading this correctly, basically instead of adding a tools.go file, the recommendation from 1.24 onwards would be to do go get -tool github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen?

@findleyr
Copy link
Member

If I'm reading this correctly, basically instead of adding a tools.go file, the recommendation from 1.24 onwards would be to do go get -tool github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen?

Yep, that's correct (though I think you need to add @latest).

@findleyr
Copy link
Member

@Jyosua yes that's right. Though you may need to add @latest, as in go get -tool .../oapi-codegen@latest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
gopls/analysis Issues related to running analysis in gopls gopls Issues related to the Go language server, gopls. help wanted Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
gopls/unplanned
Development

No branches or pull requests
5 participants
@matthewmueller @hyangah @gopherbot @Jyosua @findleyr