exhaustruct
is a golang analyzer that finds structures with uninitialized fields
Installation
go get -u github.com/GaijinEntertainment/go-exhaustruct/v3/cmd/exhaustruct
Usage
exhaustruct [-flag] [package]
Flags:
-i value
Regular expression to match type names, can receive multiple flags.
Anonymous structs can be matched by '<anonymous>' alias.
4ex:
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.<anonymous>
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.TypeInfo
-e value
Regular expression to exclude type names, can receive multiple flags.
Anonymous structs can be matched by '<anonymous>' alias.
4ex:
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.<anonymous>
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.TypeInfo
exhaustruct
supports comment directives to mark individual structures as ignored during linting or enforce it's check
regardless global configuration. Comment directives have precedence over global configuration.
//exhaustruct:ignore
- ignore structure during linting
//exhaustruct:enforce
- enforce structure check during linting, even in case global configuration says it should
be ignored.
Note: all directives can be placed in the end of structure declaration or on the line above it.
Also, any additional comment can be placed same line right after the directive or anywhere around it, but directive
should be at the very beginning of the line. It is recommended to comment directives, especially when ignoring
structures - it will help to understand the reason later.
Example
// Package a.go
package a
type Shape struct {
Length int
Width int
volume int
Perimeter int `exhaustruct:"optional"`
}
// valid
var a Shape = Shape{
Length: 5,
Width: 3,
volume: 5,
}
// invalid, `volume` is missing
var b Shape = Shape{
Length: 5,
Width: 3,
}
// Package b.go
package b
import "a"
// valid
var b Shape = a.Shape{
Length: 5,
Width: 3,
}
// invalid, `Width` is missing
var b Shape = a.Shape{
Length: 5,
}