Documentation
¶
Overview ¶
Package goenumgen: Go enum code generation engine with flexible naming modes Auto generates type-safe enum code with customizable naming patterns Supports multiple output formats and validation function generation Provides compile-time safety with runtime efficiency optimization
goenumgen: Go 枚举代码生成引擎，支持灵活的命名模式 自动生成类型安全的枚举代码，支持可定制的命名模式 支持多种输出格式和验证函数生成 提供编译时安全和运行时效率优化
Index ¶
Constants ¶
const NamingMode = NamingModeEnum("Naming")
Variables ¶
This section is empty.
Functions ¶
func Generate ¶
func Generate[T comparable](config *Config[T], path string)
Generate creates enum code file with complete package structure Auto detects package name and imports required dependencies Formats generated code and writes to specified file path Ensures proper file permissions and error handling
Generate 创建具有完整包结构的枚举代码文件 自动检测包名并导入所需依赖 格式化生成的代码并写入指定的文件路径 确保适当的文件权限和错误处理
func GenerateCode ¶
func GenerateCode[T comparable](config *Config[T]) string
GenerateCode creates the actual enum implementation code Builds type definitions, constants, and validation methods Supports multiple naming modes and optional method generation Returns formatted Go code ready for compilation
GenerateCode 创建实际的枚举实现代码 构建类型定义、常量和验证方法 支持多种命名模式和可选方法生成 返回格式化的 Go 代码，准备编译
Types ¶
type Config ¶
type Config[T comparable] struct { Type string // Type name for generated enum // 生成枚举的类型名 Name string // Base enum element name // 基本枚举元素名 BasicValue T // Basic string like "Status" in "StatusOK" "StatusNotFound" // 基本字符串如 "StatusOK" "StatusNotFound" 中的 "Status" DelimValue T // Delimiter like "-" to get "status-ok" "status-wa" // 分隔符如 "-" 用于生成 "status-ok" "status-wa" Options []*EnumOption[T] // Enum option definitions // 枚举选项定义 NamingMode NamingModeEnum // Naming pattern mode // 命名模式 IsGenBasic bool // Generate Basic() method // 生成 Basic() 方法 IsGenValid bool // Generate Valid() method // 生成 Valid() 方法 IsGenCheck bool // Generate Check() method // 生成 Check() 方法 }
Config represents the complete configuration for enum generation Contains all settings needed to generate type-safe enum code Supports generic types and flexible naming pattern configuration Enables customization of generated validation functions
Config 代表枚举生成的完整配置 包含生成类型安全枚举代码所需的所有设置 支持泛型类型和灵活的命名模式配置 允许自定义生成的验证函数
type EnumOption ¶
type EnumOption[T comparable] struct { Name string // Generated enum function name // 生成的枚举函数名 OptionValue T // Enum code like 200/400/404/201 or "OK"/"WA" // 枚举代码如 200/400/404/201 或 "OK"/"WA" }
EnumOption represents a single enum value definition Contains the function name and corresponding value for generation Supports any comparable type as enum value
EnumOption 代表单个枚举值定义 包含生成的函数名和对应的值 支持任何可比较类型作为枚举值
type NamingModeEnum ¶
type NamingModeEnum string
func (NamingModeEnum) Enums ¶
func (NamingModeEnum) Enums() []NamingModeEnum
func (NamingModeEnum) Middle ¶
func (NamingModeEnum) Middle() NamingModeEnum
func (NamingModeEnum) Prefix ¶
func (NamingModeEnum) Prefix() NamingModeEnum
func (NamingModeEnum) Single ¶
func (NamingModeEnum) Single() NamingModeEnum
func (NamingModeEnum) Suffix ¶
func (NamingModeEnum) Suffix() NamingModeEnum
Source Files