go / checks
I run five checks before committing Go code:
goimports -local "$(go list -m)" -w .
go vet ./...
go test ./...
deadcode -test ./...
gopls check -severity=hint ./*.go
Order
The checks run fast-to-slow to fail fast:
- goimports: Formats code and fixes imports. Runs first so other tools see properly formatted code.
- go vet: Static analysis. Catches bugs before spending time on tests.
- go test: Runs tests. No point running if vet already found issues.
- deadcode: Finds unreachable functions. Slowest (whole-program analysis), informational.
- gopls: Reports the same diagnostics the editor shows. Loads the whole workspace, so it runs last.
goimports
goimports
formats code like gofmt and also adds/removes imports.
go install golang.org/x/tools/cmd/goimports@latest
I install this via my laptop script.
The -local flag groups imports into three sections:
standard library, third-party, and local module.
import (
"fmt"
"net/http"
"github.com/someone/pkg"
"mymodule/internal/foo"
)
go vet
go vet reports likely mistakes: printf format errors, unreachable code, suspicious constructs.
It's built into Go and runs fast.
go test
go test runs tests.
The ./... pattern matches all packages in the module.
deadcode
deadcode finds functions that are never called.
go install golang.org/x/tools/cmd/deadcode@latest
I install this via my laptop script.
It uses whole-program analysis starting from main,
so it only works on executables, not libraries.
The -test flag includes test binaries in the analysis:
deadcode -test ./...
This creates a virtuous cycle for codebase quality. When deadcode reports an unreachable function, you have two options:
- Remove it. The function is genuinely unused.
- Add a test. The function is used but not covered by tests.
Either outcome improves the codebase: less dead code or better test coverage.
The -test flag is especially useful for projects with multiple entry points
(WASM, CLI tools, etc.) where some functions are only reachable
from entry points that deadcode can't analyze natively.
gopls
gopls, the Go language
server, surfaces diagnostics beyond go vet: modernizers that flag
older idioms in favor of newer standard-library APIs, and correctness
hints like an unchecked bufio.Scanner.Err. Running it as a check
catches these before review rather than leaving them as editor squiggles.
go install golang.org/x/tools/gopls@latest
The -severity=hint flag lowers the exit threshold so even hint-level
diagnostics fail the check. gopls check takes file paths, not package
patterns, so pass ./*.go rather than ./....
On a large repo, checking every file is slow because gopls loads and
type-checks the whole workspace. There, scope the check to the files a
branch changed against main:
git diff --name-only --diff-filter=d origin/main...HEAD -- '*.go' |
xargs gopls check -severity=hint
A protected main means every change lands through a checked PR, so the
only gap is a Go or gopls upgrade adding hints to untouched files. Catch
that with a one-off full scan:
git ls-files -z '*.go' | xargs -0 gopls check -severity=hint
How they run
The same commands live in two places, so I rarely run them by hand:
- AI agents read the project's
AGENTS.mdfiles (root and per-subdirectory), which list the checks with conditional rules: "run X if Y files touched." See ai/agents for the patterns I use. - CI runs them via cibot. Each line of
cibot's
Checkfileis a named check. Output is plain text, so a failed run pastes cleanly back into an agent prompt.
Project-specific checks live alongside these. In one repo the
Checkfile also runs nullscan, a static check for
pgx scans of nullable columns into non-nullable Go types.
Security: govulncheck
govulncheck uses the Go Vulnerability Database and static analysis to filter out vulnerabilities that don't affect your code. Dependabot can't do this, so it opens noisy PRs for vulnerabilities in packages you don't even call. See Filippo Valsorda's Turn Dependabot Off.
Run periodically:
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
Test against latest dependencies
Test against the newest dependency versions to catch breakage early:
go get -u -t ./...
go mod tidy
go test ./...
git checkout go.mod go.sum # restore pinned versions