Source code analyzer that helps you to make your Go programs more consistent.
This install go-consistent binary under your $GOPATH/bin:
go get github.com/Quasilyte/go-consistentIf $GOPATH/bin is under your system $PATH, go-consistent command should be available after that.
This should print the help message:
go-consistent --helpYou can pass package names and separate Go filenames to the go-consistent tool:
go-consistent foo.go bar.go mypkgYou can also use std, ./... and other conventional targets that are normally understood by Go tools.
- If you want to check consistency of a single file or package, just provide their name
- If you want to check the whole project, you should pass all its packages as an arguments
Suppose your project occupies separate $GOPATH, then you can check the entire project by doing:
cd $(go env GOPATH)/src go-consistent -v ./...To understand what go-consistent does, take a look at these 3 lines of code:
lit1 := map[K]V{} lit2 := map[K]V{} m := make(map[K]V)lit1, lit2 and m are initialized to an empty, non-nil map. The problem is that you have at least 2 ways to do it:
lit1andlit2use the first option, the map literalmuses the second option, themakefunction
Neither of these are the "best", but on the package or project level, you might want to prefer only one of them, for consistency reasons.
go-consistent tool detects that map literal used more frequently (2 vs 1) in the example above, so it suggest you to replace m initialization expression to use map literal instead of make function.
There are many similar cases where you have 2 or more options of expressing the same thing in Go, go-consistent tries to handle as much patterns as possible.
- Zero-configuration. Defaults should be good enough for most users. Other configuration is performed using command line arguments.
- Can handle projects of any size. This means that there should be no significant memory consumption growth with the increased number of packages being checked. There can be "fast, but memory-hungry" option that can work best for small-average projects, but it should be always possible to check huge projects on the developer machine.
- unit import
- zero val ptr alloc
- empty slice
- empty map
- hex lit
- range check
- and-not
- float-lit
- label case
- untyped const coerce
// A: no parenthesis import "fmt" // B: with parenthesis import ( "fmt" )// A: new call new(T) new([]T) // B: address of literal &T{} &[]T{}// A: make call make([]T, 0) // B: slice literal []T{}// A: make call make(map[K]V) // B: map literal map[K]V{}// A: lower case a-f digits 0xff // B: upper case A-F digits 0xFF// A: center-aligned x > low && x < high // B: left-aligned low < x && x < high// A: using &^ operator (no space) x &^ y // B: using & and ^ (with space) x & ^y// A: explicit int/frac parts 0.0 1.0 // B: implicit int/frac parts .0 1.// A: all upper case LABEL_NAME: // B: upper camel case LabelName: // C: lower camel case labelName:// A: LHS type var x int32 = 10 const y float32 = 1.6 // B: RHS type var x = int32(10) const y = float32(1.6)