Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GaijinEntertainment/go-exhaustruct
golang analyzer that finds structures with uninitialized fields
https://github.com/GaijinEntertainment/go-exhaustruct
analysis golang lint structures
Last synced: about 2 months ago
JSON representation
golang analyzer that finds structures with uninitialized fields
- Host: GitHub
- URL: https://github.com/GaijinEntertainment/go-exhaustruct
- Owner: GaijinEntertainment
- License: mit
- Created: 2022-03-18T17:32:31.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T00:34:34.000Z (about 2 months ago)
- Last Synced: 2024-11-11T23:26:06.661Z (about 2 months ago)
- Topics: analysis, golang, lint, structures
- Language: Go
- Homepage:
- Size: 125 KB
- Stars: 127
- Watchers: 5
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# exhaustruct
---
`exhaustruct` is a golang analyzer that finds structures with uninitialized fields
### Installation
```shell
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 '' alias.
4ex:
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.
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 '' alias.
4ex:
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.
github.com/GaijinEntertainment/go-exhaustruct/v3/analyzer\.TypeInfo
```
#### Comment directives
`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
```go
// 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,
}
```
### Errors handling
In order to avoid unnecessary noise, when dealing with non-pointer types returned along with errors - `exhaustruct` will
ignore non-error types, checking only structures satisfying `error` interface.
```go
package main
import "errors"
type Shape struct {
Length int
Width int
}
func NewShape() (Shape, error) {
return Shape{}, errors.New("error") // will not raise an error
}
type MyError struct {
Err error
}
func (e MyError) Error() string {
return e.Err.Error()
}
func NewSquare() (Shape, error) {
return Shape{}, MyError{Err: errors.New("error")} // will not raise an error
}
func NewCircle() (Shape, error) {
return Shape{}, MyError{} // will raise "main.MyError is missing field Err"
}
```