validation

Documentation

Index

• Variables
• func Execute(log klog.Logger, version string, opts Opts) error
• func Generate(ctx context.Context, log klog.Logger, outputfs fs.FS, inputfs fs.FS, ...) (retErr error)
• type ExecEnv
• type Opts

Variables

var (
	// ErrEnv is returned when validation is run outside of go generate
	ErrEnv errEnv
	// ErrInvalidFile is returned when parsing an invalid validation file
	ErrInvalidFile errInvalidFile
	// ErrInvalidValidator is returned when parsing a validator with invalid syntax
	ErrInvalidValidator errInvalidValidator
)

Functions

func Execute

func Execute(log klog.Logger, version string, opts Opts) error

Execute runs forge validation generation

func Generate

func Generate(ctx context.Context, log klog.Logger, outputfs fs.FS, inputfs fs.FS, version string, opts Opts, env ExecEnv) (retErr error)

Types

type ExecEnv

type ExecEnv struct {
	GoPackage string
}

type Opts

type Opts struct {
	Output      string
	Prefix      string
	PrefixValid string
	PrefixHas   string
	PrefixOpt   string
	Include     string
	Ignore      string
	Directive   string
	Tag         string
}