Copyright 2017 The Go Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
Simplified dead code detector. Used for skipping certain checks on unreachable code (for instance, shift checks on arch-specific code).
Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string. Vet uses heuristics that do not guarantee all reports are genuine problems, but it can find errors not caught by the compilers.
It can be invoked three ways:
By package, from the go tool:
go vet package/path/name
vets the package whose path is provided.
go tool vet source/directory/*.go
vets the files named, all of which must be in the same package.
go tool vet source/directory
recursively descends the directory, vetting each package it finds.
Vet's exit code is 2 for erroneous invocation of the tool, 1 if a problem was reported, and 0 otherwise. Note that the tool does not check every possible problem and depends on unreliable heuristics so it should be used as guidance only, not as a firm indicator of program correctness.
By default the -all flag is set so all checks are performed. If any flags are explicitly set to true, only those tests are run. Conversely, if any flag is explicitly set to false, only those tests are disabled. Thus -printf=true runs the printf check, -printf=false runs all checks except the printf check.
By default vet uses the object files generated by 'go install some/pkg' to typecheck the code. If the -source flag is provided, vet uses only source code.
Mismatches between assembly files and Go function declarations.
Check for useless assignments.
Common mistaken usages of the sync/atomic package.
Mistakes involving boolean operators.
Badly formed or misplaced +build tags.
Detect some violations of the cgo pointer passing rules.
Composite struct literals that do not use the field-keyed syntax.
Locks that are erroneously passed by value.
Mistakes deferring a function call on an HTTP response before checking whether the error returned with the response was nil.
The cancelation function returned by context.WithCancel, WithTimeout, and WithDeadline must be called or the new context will remain live until its parent context is cancelled. (The background context is never cancelled.)
Non-standard signatures for methods with familiar names, including:
Format GobEncode GobDecode MarshalJSON MarshalXML Peek ReadByte ReadFrom ReadRune Scan Seek UnmarshalJSON UnreadByte UnreadRune WriteByte WriteTo
Comparisons between functions and nil.
Suspicious calls to functions in the Printf family, including any functions with these names, disregarding case:
Print Printf Println Fprint Fprintf Fprintln Sprint Sprintf Sprintln Error Errorf Fatal Fatalf Log Logf Panic Panicf Panicln
The -printfuncs flag can be used to redefine this list. If the function name ends with an 'f', the function is assumed to take a format descriptor string in the manner of fmt.Printf. If not, vet complains about arguments that look like format descriptor strings.
It also checks for errors such as using a Writer as the first argument of Printf.
Incorrect uses of range loop variables in closures.
Flag: -shadow=false (experimental; must be set explicitly)
Variables that may have been unintentionally shadowed.
Shifts equal to or longer than the variable's length.
Struct tags that do not follow the format understood by reflect.StructTag.Get. Well-known encoding struct tags (json, xml) used with unexported fields.
Mistakes involving tests including functions with incorrect names or signatures and example tests that document identifiers not in the package.
Likely incorrect uses of unsafe.Pointer to convert integers to pointers. A conversion from uintptr to unsafe.Pointer is invalid if it implies that there is a uintptr-typed word in memory that holds a pointer value, because that word will be invisible to stack copying and to the garbage collector.
Calls to well-known functions and methods that return a value that is discarded. By default, this includes functions like fmt.Errorf and fmt.Sprintf and methods like String and Error. The flags -unusedfuncs and -unusedstringmethods control the set.
These flags configure the behavior of vet:
-all (default true) Enable all non-experimental checks. -v Verbose mode -printfuncs A comma-separated list of print-like function names to supplement the standard list. For more information, see the discussion of the -printf flag. -shadowstrict Whether to be strict about shadowing; can be noisy.
Vet is a simple checker for static errors in Go source code. See doc.go for more information.
asmdecl.go assign.go atomic.go bool.go buildtag.go cgo.go composite.go copylock.go dead.go deadcode.go doc.go httpresponse.go lostcancel.go main.go method.go nilfunc.go print.go rangeloop.go shadow.go shift.go structtag.go tests.go types.go unsafeptr.go unused.go
|internal/cfg||This package constructs a simple control-flow graph (CFG) of the statements and expressions within a single function.|
|internal/whitelist||Package whitelist defines exceptions for the vet tool.|