staticcheck

package module
v0.0.0-...-5cc689c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 17, 2016 License: MIT Imports: 17 Imported by: 0

README

Staticcheck is go vet on steroids, applying a ton of static analysis checks you might be used to from tools like ReSharper for C#.

Installation

Staticcheck requires Go 1.6 or later.

go get honnef.co/go/staticcheck/cmd/staticcheck

Usage

Invoke staticcheck with one or more filenames, a directory, or a package named by its import path. Staticcheck uses the same import path syntax as the go command and therefore also supports relative import paths like ./.... Additionally the ... wildcard can be used as suffix on relative and absolute file paths to recurse into them.

The output of this tool is a list of suggestions in Vim quickfix format, which is accepted by lots of different editors.

Purpose

The main purpose of staticcheck is editor integration, or workflow integration in general. For example, by running staticcheck when saving a file, one can quickly catch simple bugs without having to run the whole test suite or the program itself.

The tool shouldn't report any errors unless there are legitimate bugs - or very dubious constructs - in the code.

It is similar in nature to go vet, but has more checks that catch bugs that would also be caught easily at runtime, to reduce the number of edit, compile and debug cycles.

Checks

The following things are currently checked by staticcheck:

Check Description
SA1??? Various misuses of the standard library
SA1000 Invalid regular expression
SA1001 Invalid template
SA1002 Invalid format in time.Parse
SA1003 Unsupported argument to functions in encoding/binary
SA1004 Suspiciously small untyped constant in time.Sleep
SA1005 Invalid first argument to exec.Command
SA1006 Printf with dynamic first argument and no further arguments
SA1007 Invalid URL in net/url.Parse
SA1008 Non-canonical key in http.Header map
SA1009 Incorrect usage of some standard library functions
SA2??? Concurrency issues
SA2000 sync.WaitGroup.Add called inside the goroutine, leading to a race condition
SA2001 Empty critical section, did you mean to defer the unlock?
SA2002 Called testing.T.FailNow or SkipNow in a goroutine, which isn't allowed
SA2003 Deferred Lock right after locking, likely meant to defer Unlock instead
SA3??? Testing issues
SA3000 TestMain doesn't call os.Exit, hiding test failures
SA3001 Assigning to b.N in benchmarks distorts the results
SA4??? Code that isn't really doing anything
SA4000 Boolean expression has identical expressions on both sides
SA4001 &*x gets simplified to x, it does not copy x
SA4002 Comparing strings with known different sizes has predictable results
SA4003 Comparing unsigned values against negative values is pointless
SA4004 The loop exits unconditionally after one iteration
SA4005 Field assignment that will never be observed. Did you mean to use a pointer receiver?
SA4006 A value assigned to a variable is never read before being overwritten. Forgotten error check or dead code?
SA4008 The variable in the loop condition never changes, are you incrementing the wrong variable?
SA4009 A function argument is overwritten before its first use
SA4010 The result of append will never be observed anywhere
SA4011 Break statement with no effect. Did you mean to break out of an outer loop?
SA4012 Comparing a value against NaN even though no value is equal to NaN
SA5??? Correctness issues
SA5000 Assignment to nil map
SA5001 Defering Close before checking for a possible error
SA5002 The empty for loop (for {}) spins and can block the scheduler
SA5003 Defers in infinite loops will never execute
SA5004 for { select { ... with an empty default branch spins
SA5005 The finalizer references the finalized object, preventing garbage collection
SA5006 Slice index out of bounds
SA9??? Dubious code constructs that have a high probability of being wrong
SA9000 Storing non-pointer values in sync.Pool allocates memory
SA9001 defers in for range loops may not run when you expect them to

Ignoring checks

staticcheck allows disabling some or all checks for certain files. The -ignore flag takes a whitespace-separated list of glob:check1,check2,... pairs. glob is a glob pattern matching files in packages, and check1,check2,... are checks named by their IDs.

For example, to ignore assignment to nil maps in all test files in the os/exec package, you would write -ignore "os/exec/*_test.go:SA5000"

Additionally, the check IDs support globbing, too. Using a pattern such as os/exec/*.gen.go:* would disable all checks in all auto-generated files in the os/exec package.

Any whitespace can be used to separate rules, including newlines. This allows for a setup like the following:

$ cat stdlib.ignore
sync/*_test.go:SA2001
testing/benchmark.go:SA3001
runtime/string_test.go:SA4007
runtime/proc_test.go:SA5004
runtime/lfstack_test.go:SA4010
runtime/append_test.go:SA4010
errors/errors_test.go:SA4000
reflect/all_test.go:SA4000

$ staticcheck -ignore "$(cat stdlib.ignore)" std

Documentation

Overview

Package staticcheck contains a linter for Go source code.

Index

Constants

This section is empty.

Variables

View Source 
var Funcs = map[string]lint.Func{
	"SA1000": CheckRegexps,
	"SA1001": CheckTemplate,
	"SA1002": CheckTimeParse,
	"SA1003": CheckEncodingBinary,
	"SA1004": CheckTimeSleepConstant,
	"SA1005": CheckExec,
	"SA1006": CheckUnsafePrintf,
	"SA1007": CheckURLs,
	"SA1008": CheckCanonicalHeaderKey,
	"SA1009": CheckStdlibUsage,

	"SA2000": CheckWaitgroupAdd,
	"SA2001": CheckEmptyCriticalSection,
	"SA2002": CheckConcurrentTesting,
	"SA2003": CheckDeferLock,

	"SA3000": CheckTestMainExit,
	"SA3001": CheckBenchmarkN,

	"SA4000": CheckLhsRhsIdentical,
	"SA4001": CheckIneffectiveCopy,
	"SA4002": CheckDiffSizeComparison,
	"SA4003": CheckUnsignedComparison,
	"SA4004": CheckIneffectiveLoop,
	"SA4005": CheckIneffecitiveFieldAssignments,
	"SA4006": CheckUnreadVariableValues,

	"SA4007": nil,
	"SA4008": CheckLoopCondition,
	"SA4009": CheckArgOverwritten,
	"SA4010": CheckIneffectiveAppend,
	"SA4011": CheckScopedBreak,
	"SA4012": CheckNaNComparison,

	"SA5000": CheckNilMaps,
	"SA5001": CheckEarlyDefer,
	"SA5002": CheckInfiniteEmptyLoop,
	"SA5003": CheckDeferInInfiniteLoop,
	"SA5004": CheckLoopEmptyDefault,
	"SA5005": CheckCyclicFinalizer,
	"SA5006": CheckSliceOutOfBounds,

	"SA9000": CheckDubiousSyncPoolPointers,
	"SA9001": CheckDubiousDeferInChannelRangeLoop,
}

Functions

func CheckArgOverwritten 

func CheckArgOverwritten(f *lint.File)

func CheckBenchmarkN 

func CheckBenchmarkN(f *lint.File)

func CheckCanonicalHeaderKey 

func CheckCanonicalHeaderKey(f *lint.File)

func CheckConcurrentTesting 

func CheckConcurrentTesting(f *lint.File)

func CheckCyclicFinalizer 

func CheckCyclicFinalizer(f *lint.File)

func CheckDeferInInfiniteLoop 

func CheckDeferInInfiniteLoop(f *lint.File)

func CheckDeferLock 

func CheckDeferLock(f *lint.File)

func CheckDiffSizeComparison 

func CheckDiffSizeComparison(f *lint.File)

func CheckDubiousDeferInChannelRangeLoop 

func CheckDubiousDeferInChannelRangeLoop(f *lint.File)

func CheckDubiousSyncPoolPointers 

func CheckDubiousSyncPoolPointers(f *lint.File)

func CheckEarlyDefer 

func CheckEarlyDefer(f *lint.File)

func CheckEmptyCriticalSection 

func CheckEmptyCriticalSection(f *lint.File)

func CheckEncodingBinary 

func CheckEncodingBinary(f *lint.File)

func CheckExec 

func CheckExec(f *lint.File)

func CheckIneffecitiveFieldAssignments 

func CheckIneffecitiveFieldAssignments(f *lint.File)

func CheckIneffectiveAppend 

func CheckIneffectiveAppend(f *lint.File)

func CheckIneffectiveCopy 

func CheckIneffectiveCopy(f *lint.File)

func CheckIneffectiveLoop 

func CheckIneffectiveLoop(f *lint.File)

func CheckInfiniteEmptyLoop 

func CheckInfiniteEmptyLoop(f *lint.File)

func CheckLhsRhsIdentical 

func CheckLhsRhsIdentical(f *lint.File)

func CheckLoopCondition 

func CheckLoopCondition(f *lint.File)

func CheckLoopEmptyDefault 

func CheckLoopEmptyDefault(f *lint.File)

func CheckNaNComparison 

func CheckNaNComparison(f *lint.File)

func CheckNilMaps 

func CheckNilMaps(f *lint.File)

func CheckPredeterminedBooleanExprs 

func CheckPredeterminedBooleanExprs(f *lint.File)

func CheckRegexps 

func CheckRegexps(f *lint.File)

func CheckScopedBreak 

func CheckScopedBreak(f *lint.File)

func CheckSliceOutOfBounds 

func CheckSliceOutOfBounds(f *lint.File)

func CheckStdlibUsage 

func CheckStdlibUsage(f *lint.File)

func CheckTemplate 

func CheckTemplate(f *lint.File)

func CheckTestMainExit 

func CheckTestMainExit(f *lint.File)

func CheckTimeParse 

func CheckTimeParse(f *lint.File)

func CheckTimeSleepConstant 

func CheckTimeSleepConstant(f *lint.File)

func CheckURLs 

func CheckURLs(f *lint.File)

func CheckUnreadVariableValues 

func CheckUnreadVariableValues(f *lint.File)

func CheckUnsafePrintf 

func CheckUnsafePrintf(f *lint.File)

func CheckUnsignedComparison 

func CheckUnsignedComparison(f *lint.File)

func CheckWaitgroupAdd 

func CheckWaitgroupAdd(f *lint.File)

func IsTestMain 

func IsTestMain(f *lint.File, node ast.Node) bool

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
cmd
staticcheck
staticcheck statically checks arguments to certain functions
 staticcheck statically checks arguments to certain functions

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.