v1beta4

type Append struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths             []model.String `yaml:"paths"`
	With              model.String   `yaml:"with"`
	SkipEnsureNewline model.Bool     `yaml:"skip_ensure_newline"`
}

type ForEach struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Iterator *ForEachIterator `yaml:"iterator"`
	Steps    []*Step          `yaml:"steps"`
}

type ForEachIterator struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	// The name by which the range value is accessed.
	Key model.String `yaml:"key"`

	// Values is a list to range over, e.g. ["dev", "prod"]
	Values []model.String `yaml:"values"`
	// ValuesFrom is a CEL expression returning a list of strings to range over.
	ValuesFrom *model.String `yaml:"values_from"`
}

type GoTemplate struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths []model.String `yaml:"paths"`
}

type Include struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths []*IncludePath `yaml:"paths"`
}

type IncludePath struct {
	Pos model.ConfigPos `yaml:"-"`

	As         []model.String `yaml:"as"`
	From       model.String   `yaml:"from"`
	OnConflict model.String   `yaml:"on_conflict"`
	Paths      []model.String `yaml:"paths"`
	Skip       []model.String `yaml:"skip"`
}

type Input struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Name    model.String  `yaml:"name"`
	Desc    model.String  `yaml:"desc"`
	Default *model.String `yaml:"default,omitempty"`
	Rules   []*Rule       `yaml:"rules"`
}

type Print struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Message model.String `yaml:"message"`
}

type RegexNameLookup struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths        []model.String          `yaml:"paths"`
	Replacements []*RegexNameLookupEntry `yaml:"replacements"`
}

type RegexNameLookupEntry struct {
	Pos   model.ConfigPos `yaml:"-"`
	Regex model.String    `yaml:"regex"`
}

type RegexReplace struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths        []model.String       `yaml:"paths"`
	Replacements []*RegexReplaceEntry `yaml:"replacements"`
}

type RegexReplaceEntry struct {
	Pos               model.ConfigPos `yaml:"-"`
	Regex             model.String    `yaml:"regex"`
	SubgroupToReplace model.String    `yaml:"subgroup_to_replace"`
	With              model.String    `yaml:"with"`
}

type Rule struct {
	Pos model.ConfigPos `yaml:"-"`

	Rule    model.String `yaml:"rule"`
	Message model.String `yaml:"message"` // optional
}

type Spec struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Desc   model.String `yaml:"desc"`
	Inputs []*Input     `yaml:"inputs"`
	Rules  []*Rule      `yaml:"rules"`
	Steps  []*Step      `yaml:"steps"`

	// Optional ignore section, adopting gitignore-like path matching.
	// Please be ware that there are some patterns that are always ignored such
	// as: '.DS_Store, '.bin', '.ssh'.
	Ignore []model.String `yaml:"ignore"`

	// Features configures which features to use depending on spec API version.
	Features features.Features `yaml:"-"`
}

type Step struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Desc   model.String `yaml:"desc"`
	If     model.String `yaml:"if"`
	Action model.String `yaml:"action"`

	// Each action type has a field below. Only one of these will be set.
	Append          *Append          `yaml:"-"`
	ForEach         *ForEach         `yaml:"-"`
	GoTemplate      *GoTemplate      `yaml:"-"`
	Include         *Include         `yaml:"-"`
	Print           *Print           `yaml:"-"`
	RegexNameLookup *RegexNameLookup `yaml:"-"`
	RegexReplace    *RegexReplace    `yaml:"-"`
	StringReplace   *StringReplace   `yaml:"-"`
}

type StringReplace struct {
	// Pos is the YAML file location where this object started.
	Pos model.ConfigPos `yaml:"-"`

	Paths        []model.String       `yaml:"paths"`
	Replacements []*StringReplacement `yaml:"replacements"`
}

type StringReplacement struct {
	Pos model.ConfigPos `yaml:"-"`

	ToReplace model.String `yaml:"to_replace"`
	With      model.String `yaml:"with"`
}