config

Documentation

Index

• type BuilderVar
• type BuilderVarDefault
• type DraftConfig
  • func (d *DraftConfig) GetNameOverride(path string) string
  • func (d *DraftConfig) GetVariableExampleValues() map[string][]string
• type FileNameOverride
• type TemplateVariableRecorder

Types

type BuilderVar

type BuilderVar struct {
	Name          string   `yaml:"name"`
	Description   string   `yaml:"description"`
	VarType       string   `yaml:"type"`
	ExampleValues []string `yaml:"exampleValues"`
}

type BuilderVarDefault

type BuilderVarDefault struct {
	Name         string `yaml:"name"`
	Value        string `yaml:"value"`
	ReferenceVar string `yaml:"referenceVar"`
}

type DraftConfig

type DraftConfig struct {
	DisplayName      string              `yaml:"displayName"`
	NameOverrides    []FileNameOverride  `yaml:"nameOverrides"`
	Variables        []BuilderVar        `yaml:"variables"`
	VariableDefaults []BuilderVarDefault `yaml:"variableDefaults"`
	// contains filtered or unexported fields
}

TODO: remove Name Overrides since we don't need them anymore

func (*DraftConfig) GetNameOverride

func (d *DraftConfig) GetNameOverride(path string) string

func (*DraftConfig) GetVariableExampleValues

func (d *DraftConfig) GetVariableExampleValues() map[string][]string

type FileNameOverride

type FileNameOverride struct {
	Path   string `yaml:"path"`
	Prefix string `yaml:"prefix"`
}

type TemplateVariableRecorder

type TemplateVariableRecorder interface {
	Record(key, value string)
}

TemplateVariableRecorder is an interface for recording variables that are used read using draft configs