repository·master·Indexed 25 days ago
https://github.com/kisielk/errcheckA static analysis tool for Go that identifies silently ignored errors. It ensures that functions returning errors have those errors either assigned to a variable or explicitly discarded using the blank identifier. It supports custom exclude files, build tags, and integration with the golang.org/x/tools/go/analysis API.
Use go-errcheck.el to integrate errcheck with Emacs. It provides a go-errcheck command and allows you to pass custom flags via Emacs variables.
If you use vim-go, you can run errcheck using the following commands:
:GoErrCheck:GoMetaLinterInstall the errcheck tool using go install. Note that errcheck requires Go 1.25 or newer.
go install github.com/kisielk/errcheck@latestRun errcheck by providing a package path. It identifies callables where returned errors are neither assigned to a variable nor explicitly discarded using the blank identifier _.
Common usage patterns:
errcheck <package_path>errcheck ./...$GOPATH and $GOROOT: errcheck allerrcheck ./...To prevent errcheck from complaining about specific functions, use the -exclude flag with a text file containing function signatures.
package.FunctionName (e.g., os.ReadFile)(package.Receiver).MethodName (e.g., (bytes.Buffer).Write)(*package.Receiver).MethodName (e.g., (*bytes.Buffer).Write)package.FunctionName(TYPE) excludes the call only if the first argument is of TYPE.package.FunctionName(os.Stdout) or package.FunctionName(os.Stderr) excludes the call only when the first argument is that specific literal.When using vendored dependencies, use the full import path including the vendor directory:
example.com/yourpkg/vendor/example.net/fmt2.Println
io.Copy(*bytes.Buffer)
io.Copy(os.Stdout)
os.ReadFile
// Sometimes we don't care if a HTTP request fails.
(*net/http.Client).Doerrcheck -exclude errcheck_excludes.txt path/to/packageerrcheck is a command-line tool used to find unchecked errors in Go code. It scans specified packages and reports locations where an error is returned but not handled.
By default, it checks the current directory (.) if no paths are provided. It can be configured to ignore specific packages, files (like tests or generated code), or specific function names via an exclude file.
0: No unchecked errors found.1: Unchecked errors were found.2: A fatal error occurred (e.g., failed to load packages or invalid flags).The errcheck package provides an Analyzer instance compatible with the golang.org/x/tools/go/analysis API. This allows you to use errcheck as part of a larger static analysis pipeline.
Supported flags for the Analyzer:
blankassertexcludeexcludeonlyNote: The analyzer is experimental and subject to change.
When running errcheck in CI or scripts, use the following exit codes to determine the result:
1: Problems (unchecked errors) were found in the checked files.2: Other failures occurred (e.g., tool errors).The following command-line options are available for errcheck:
| Flag | Description |
|---|---|
-tags <list> | A space-separated list of build tags (similar to go build). |
-asserts | Enables checking for ignored type assertion results. |
-blank | Enables checking for assignments of errors to the blank identifier (_). |
-abspath | Prints the absolute paths to files with unchecked errors. |
-mod <mode> | Sets the module download mode: readonly or vendor. |
-exclude <file> | Specifies a path to a file containing a list of functions to be excluded. |
-excludeonly | Disables the built-in exclude list (standard library functions that never return errors). |
-ignore <regex> | Deprecated: Takes a comma-separated list of package:regex pairs to ignore functions. |
-ignorepkg <list> | Deprecated: Takes a comma-separated list of package import paths to ignore. |
-ignoretests | Disables checking of _test.go files. |
-ignoregenerated | Disables checking of generated source code. |