ruler

Documentation

Index

• Variables
• func RunBuild(inPath, outPath, vers string) error
• func RunId(num int) error
• func Semver() string
• type BuildCmd
• type RuleIncludeT
• type TagT

Variables

var (
	ErrInvalidType     = errors.New("invalid type")
	ErrDuplicateRuleId = errors.New("duplicate rule id")
)

var (
	ErrMissingId             = errors.New("missing id field")
	ErrEmptyId               = errors.New("empty id field")
	ErrMissingName           = errors.New("missing name field")
	ErrEmptyName             = errors.New("empty name field")
	ErrMissingDisplayName    = errors.New("missing display name field")
	ErrEmptyDisplayName      = errors.New("empty display name field")
	ErrMissingDescription    = errors.New("missing description field")
	ErrEmptyDescription      = errors.New("empty description field")
	ErrInvalidTagsKind       = errors.New("invalid tags kind")
	ErrInvalidCategoriesKind = errors.New("invalid categories kind")
	ErrDuplicateName         = errors.New("duplicate name")
	ErrUnknownTag            = errors.New("unknown tag")
	ErrUnknownCategory       = errors.New("unknown category")
	ErrMissingCategory       = errors.New("missing category field")
)

var (
	Githash string
	Version string
)

Functions

func RunBuild

func RunBuild(inPath, outPath, vers string) error

func RunId

func RunId(num int) error

func Semver

func Semver() string

Types

type BuildCmd

type BuildCmd struct {
	InPath  string `name:"path" short:"p" help:"Path to read rules" default:"rules"`
	OutPath string `name:"out" short:"o" help:"Optional path to write files; default curdir"`
	Version string `name:"vers" short:"v" help:"Optional semantic version override"`
}

type RuleIncludeT

type RuleIncludeT struct {
	Metadata   parser.ParseRuleMetadataT `yaml:"metadata"`
	Tags       []TagT                    `yaml:"tags,omitempty"`
	Categories []TagT                    `yaml:"categories,omitempty"`
	Rules      []parser.ParseRuleT       `yaml:"rule"`
}

type TagT

type TagT struct {
	Name        string `yaml:"name" binding:"required"`
	DisplayName string `yaml:"displayName" binding:"required"`
	Description string `yaml:"description" binding:"required"`
}