enumizer

枚举

枚举器是Golang生成枚举助手并检查Switch语句中的枚举覆盖范围的命令行工具。

安装

 $ go install github.com/neglect-yp/enumizer@latest

用法

尝试之前，您需要添加标记评论。请参阅Examples部分。

 $ enumizer help
enumizer is a command-line tool to generate enum helpers and check enum coverage.

Usage:
  enumizer [command]

Examples:
* Generate enum helpers
  enumizer generate ./...

* Check enum coverage
  enumizer cover ./...

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  cover       Check that switch statements cover all variants of passed enum
  generate    Generate enum helpers that include stringer and validation methods
  help        Help about any command

Flags:
  -h, --help   help for enumizer

Use "enumizer [command] --help" for more information about a command.

例子

添加标记注释，例如// enumizer:target ，以进行枚举变体。

 package myenum

type MyEnum int

// enumizer:target
const (
	A MyEnum = iota
	B
	C
)

然后，您可以生成enumizer generate ./...生成的文件名是enumizer.gen.go默认情况下。 enumizer.gen.go如下：

 // Code generated by enumizer; DO NOT EDIT.
package myenum

import "fmt"

var myEnumSet = map [ MyEnum ] struct {}{
	A : {},
	B : {},
	C : {},
}

func MyEnumList () [] MyEnum {
	ret := make ([] MyEnum , 0 , len ( myEnumSet ))
	for v := range myEnumSet {
		ret = append ( ret , v )
	}
	return ret
}

func ( m MyEnum ) String () string {
	switch m {
	case A :
		return "A"
	case B :
		return "B"
	case C :
		return "C"
	default :
		return "<unknown MyEnum>"
	}
}

func ( m MyEnum ) IsValid () bool {
	_ , ok := myEnumSet [ m ]
	return ok
}

func ( m MyEnum ) Validate () error {
	if ! m . IsValid () {
		return fmt . Errorf ( "MyEnum(%v) is invalid" , m )
	}
	return nil
}

您可以检查Switch语句涵盖经过的所有枚举的所有变体。如果您的代码使用MyEnum ，例如以下内容，则会警告您，因为Switch语句中没有A和C案例。

 package myenumuser

import "github.com/neglect-yp/enumizer/examples/myenum"

func Foo ( a myenum. MyEnum ) {
	switch a {
	case myenum . B :
	}
}

$ enumizer cover ./examples/...
/<path to homedir>/enumizer/examples/myenumuser/myenumuser.go:6:2: this switch statement doesn't cover enum variants. missing cases: A, C