generator

Documentation

Index

• func GetFileImports(filePath string) ([]string, error)
• func RenderOptions(packageName, optionsStructName string, fileImports []string, spec *OptionSpec, ...) ([]byte, error)
• type OptionMeta
• type OptionSpec
  • func GetOptionSpec(filePath, optionsStructName, tagName string) (*OptionSpec, []string, error)
  • func (s OptionSpec) HasValidation() bool
• type TagOption

Functions

func GetFileImports

func GetFileImports(filePath string) ([]string, error)

GetFileImports read the file and parse the imports section. Return all found imports with aliases.

func RenderOptions

func RenderOptions(
	packageName, optionsStructName string,
	fileImports []string,
	spec *OptionSpec,
	tagName, varName, funcName, prefix string,
	withIsset bool,
) ([]byte, error)

RenderOptions will render file and out it's content.

Types

type OptionMeta

type OptionMeta struct {
	Name      string
	Docstring string // contains a comment with `//`. Can be empty or contain a multi-line string.
	Field     string
	Type      string
	TagOption TagOption
}

type OptionSpec

type OptionSpec struct {
	TypeParamsSpec string // [KeyT int | string, TT any]
	TypeParams     string // [KeyT, TT]
	Options        []OptionMeta
}

func GetOptionSpec

func GetOptionSpec(filePath, optionsStructName, tagName string) (*OptionSpec, []string, error)

GetOptionSpec read the input filename by filePath, find optionsStructName and scan for options.

func (OptionSpec) HasValidation

func (s OptionSpec) HasValidation() bool

type TagOption

type TagOption struct {
	IsRequired  bool
	GoValidator string
	Default     string
}