filters

Documentation

Index

• Constants
• type Instance
  • func (i *Instance) Render(out io.Writer, repo repository) error
• type List
  • func (l *List) Render(out io.Writer, logger logger, repo repository) error
  • func (l *List) Validate() error
• type ParamType
• type Parameter
  • func (p *Parameter) BuildPresetParamName(preset string) string
• type Preset
• type Repository
  • func Load(templates, presets fs.FS) (*Repository, error)
  • func (r *Repository) Get(name string) (*Template, error)
  • func (r *Repository) GetAll() []*Template
  • func (r *Repository) GetTags() []string
  • func (r *Repository) Has(name string) bool
  • func (r *Repository) Render(w io.Writer, instance *Instance) error
• type Template
  • func (f *Template) HasTag(tag string) bool
• type TestModeTransformer
  • func NewTestModeTransformer(out io.Writer) *TestModeTransformer
  • func (t *TestModeTransformer) Write(p []byte) (int, error)

Constants

const (
	CustomRulesFilterName = "custom-rules"
	CustomTagName         = "custom"
)

Types

type Instance

type Instance struct {
	Template string                 `yaml:"template" validate:"required"`
	Params   map[string]interface{} `yaml:"params,omitempty"`
	TestMode bool                   `yaml:"test_mode,omitempty"`
}

func (*Instance) Render

func (i *Instance) Render(out io.Writer, repo repository) error

type List

type List struct {
	Title     string      `yaml:"title" validate:"required"`
	Instances []*Instance `yaml:"instances" validate:"dive,required"`
	TestMode  bool        `yaml:"test_mode,omitempty"`
}

func (*List) Render

func (l *List) Render(out io.Writer, logger logger, repo repository) error

func (*List) Validate

func (l *List) Validate() error

type ParamType

type ParamType string

const (
	BooleanParam    ParamType = "checkbox"
	StringParam     ParamType = "string"
	StringListParam ParamType = "list"
	MultiLineParam  ParamType = "multiline"
)

type Parameter

type Parameter struct {
	Name        string      `validate:"required"`
	Description string      `validate:"required"`
	Link        string      `validate:"omitempty,url" yaml:",omitempty"`
	Type        ParamType   `validate:"required,oneof=checkbox string list multiline"`
	OnlyIf      string      `validate:"omitempty,valid_only_if" yaml:",omitempty"`
	Default     interface{} `validate:"valid_default"`
	Rules       string      `validate:"omitempty,raw_rules_allowed" yaml:",omitempty"`
	Presets     []Preset    `validate:"omitempty,preset_allowed,dive" yaml:",omitempty"`
}

func (*Parameter) BuildPresetParamName

func (p *Parameter) BuildPresetParamName(preset string) string

type Preset

type Preset struct {
	Name        string   `validate:"required"`
	Description string   `validate:"required"`
	Source      string   `validate:"omitempty,url" yaml:",omitempty"`
	License     string   `validate:"required_with=Source" yaml:",omitempty"`
	Values      []string `validate:"required_without=Source"`
	Default     bool     `yaml:",omitempty"`
}

type Repository

type Repository struct {
	// contains filtered or unexported fields
}

Repository holds parsed Templates ready for use

func Load

func Load(templates, presets fs.FS) (*Repository, error)

Load parses template definitions from the given filesystem

func (*Repository) Get

func (r *Repository) Get(name string) (*Template, error)

func (*Repository) GetAll

func (r *Repository) GetAll() []*Template

func (*Repository) GetTags

func (r *Repository) GetTags() []string

func (*Repository) Has

func (r *Repository) Has(name string) bool

func (*Repository) Render

func (r *Repository) Render(w io.Writer, instance *Instance) error

type Template

type Template struct {
	Name         string      `validate:"required" yaml:"-"`
	Title        string      `validate:"required"`
	Params       []Parameter `validate:"dive" yaml:",omitempty"`
	Tags         []string    `validate:"dive,alphaunicode" yaml:",omitempty"`
	Template     string      `validate:"required_without=rawRules,excluded_with=rawRules"`
	Tests        []testCase
	Description  string `validate:"required" yaml:"-"`
	Contributors []string
	Sponsors     []string
	// contains filtered or unexported fields
}

func (*Template) HasTag

func (f *Template) HasTag(tag string) bool

type TestModeTransformer

type TestModeTransformer struct {
	// contains filtered or unexported fields
}

func NewTestModeTransformer

func NewTestModeTransformer(out io.Writer) *TestModeTransformer

func (*TestModeTransformer) Write

func (t *TestModeTransformer) Write(p []byte) (int, error)