config

Documentation

Index

• type BuilderVar
• type BuilderVarDefault
• type DraftConfig
  • func NewConfigFromFS(fileSys fs.FS, path string) (*DraftConfig, error)
  • func (d *DraftConfig) ApplyDefaultVariables() error
  • func (d *DraftConfig) ApplyDefaultVariablesForVersion(version string) error
  • func (d *DraftConfig) GetVariable(name string) (*BuilderVar, error)
  • func (d *DraftConfig) GetVariableExampleValues() map[string][]string
  • func (d *DraftConfig) GetVariableMap() map[string]string
  • func (d *DraftConfig) GetVariableValue(name string) (string, error)
  • func (d *DraftConfig) SetVariable(name, value string)
  • func (d *DraftConfig) VariableMapToDraftConfig(flagVariablesMap map[string]string)
• type TemplateVariableRecorder

Types

type BuilderVar

type BuilderVar struct {
	Name          string            `yaml:"name"`
	Default       BuilderVarDefault `yaml:"default"`
	Description   string            `yaml:"description"`
	ExampleValues []string          `yaml:"exampleValues"`
	Type          string            `yaml:"type"`
	Value         string            `yaml:"value"`
	Versions      string            `yaml:"versions"`
}

type BuilderVarDefault

type BuilderVarDefault struct {
	IsPromptDisabled bool   `yaml:"disablePrompt"`
	ReferenceVar     string `yaml:"referenceVar"`
	Value            string `yaml:"value"`
}

type DraftConfig

type DraftConfig struct {
	TemplateName        string            `yaml:"template"`
	DisplayName         string            `yaml:"displayName"`
	Variables           []*BuilderVar     `yaml:"variables"`
	FileNameOverrideMap map[string]string `yaml:"filenameOverrideMap"`
	Versions            string            `yaml:"versions"`
	DefaultVersion      string            `yaml:"defaultVersion"`
}

func NewConfigFromFS

func NewConfigFromFS(fileSys fs.FS, path string) (*DraftConfig, error)

func (*DraftConfig) ApplyDefaultVariables

func (d *DraftConfig) ApplyDefaultVariables() error

ApplyDefaultVariables will apply the defaults to variables that are not already set

func (*DraftConfig) ApplyDefaultVariablesForVersion

func (d *DraftConfig) ApplyDefaultVariablesForVersion(version string) error

ApplyDefaultVariablesForVersion will apply the defaults to variables that are not already set

func (*DraftConfig) GetVariable

func (d *DraftConfig) GetVariable(name string) (*BuilderVar, error)

func (*DraftConfig) GetVariableExampleValues

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

func (*DraftConfig) GetVariableMap

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

Returns a map of variable names to values used in Gotemplate

func (*DraftConfig) GetVariableValue

func (d *DraftConfig) GetVariableValue(name string) (string, error)

func (*DraftConfig) SetVariable

func (d *DraftConfig) SetVariable(name, value string)

func (*DraftConfig) VariableMapToDraftConfig

func (d *DraftConfig) VariableMapToDraftConfig(flagVariablesMap map[string]string)

handles flags that are meant to represent template variables

type TemplateVariableRecorder

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

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