verification

Documentation

Overview

Package verification provides analyzers for the ok-verify vet tool.

Index

• Variables

Variables

var CloseCheck = &analysis.Analyzer{
	Name: "closecheck",
	Doc:  "checks that deferred Close() calls check their error return to prevent silent data loss",
	Run:  runCloseCheck,
}

var ContextBg = &analysis.Analyzer{
	Name: "contextbg",
	Doc:  "checks that context.Background() is not used where a derived context is available",
	Run:  runContextBg,
}

var DeferInLoop = &analysis.Analyzer{
	Name: "deferinloop",
	Doc:  "checks that defer is not used inside a for loop",
	Run:  runDeferInLoop,
}

var DoubleClose = &analysis.Analyzer{
	Name: "doubleclose",
	Doc:  "checks for channels that may be closed more than once",
	Run:  runDoubleClose,
}

var LateCancel = &analysis.Analyzer{
	Name: "latecancel",
	Doc:  "checks that defer cancel() is placed close to context.WithCancel to prevent leaks on early returns",
	Run:  runLateCancel,
}

var LoopClosure = &analysis.Analyzer{
	Name: "loopclosure",
	Doc:  "checks that goroutines or defer statements inside loops capture loop variables correctly",
	Run:  runLoopClosure,
}

var MutexCopy = &analysis.Analyzer{
	Name: "mutexcopy",
	Doc:  "checks that sync.Mutex and sync.RWMutex are not copied by value",
	Run:  runMutexCopy,
}

var NilMapWrite = &analysis.Analyzer{
	Name: "nilmapwrite",
	Doc:  "checks for possible nil map writes that would panic",
	Run:  runNilMapWrite,
}

var PreallocSlice = &analysis.Analyzer{
	Name: "preallocslice",
	Doc:  "checks that slices with known size are pre-allocated to avoid repeated growth",
	Run:  runPreallocSlice,
}

var RawAssert = &analysis.Analyzer{
	Name: "rawassert",
	Doc:  "checks that type assertions use the comma-ok pattern to prevent panic on failure",
	Run:  runRawAssert,
}

var RecoverCheck = &analysis.Analyzer{
	Name: "recovercheck",
	Doc:  "checks that every goroutine has a defer-recover to prevent process crash on panic",
	Run:  runRecoverCheck,
}

var SleepInLoop = &analysis.Analyzer{
	Name: "sleepinloop",
	Doc:  "checks that time.Sleep inside for loops uses a timer instead for efficiency",
	Run:  runSleepInLoop,
}

var SprintfHex = &analysis.Analyzer{
	Name: "sprintfhex",
	Doc:  "checks that fmt.Sprintf with %%x is replaced by the faster hex.EncodeToString",
	Run:  runSprintfHex,
}

var StringCastLoop = &analysis.Analyzer{
	Name: "stringcastloop",
	Doc:  "checks for repeated []byte(string) conversions inside loops that could be hoisted",
	Run:  runStringCastLoop,
}

var SwitchDefault = &analysis.Analyzer{
	Name: "switchdefault",
	Doc:  "checks that switch statements have a default branch to handle unexpected values",
	Run:  runSwitchDefault,
}

var TmpDirCheck = &analysis.Analyzer{
	Name: "tmpdircheck",
	Doc:  "checks that os.MkdirTemp is paired with defer os.RemoveAll",
	Run:  runTmpDirCheck,
}