facts

type By struct {
	Local, CI, CIOptional bool
}

type Ceiling struct {
	Pace   Pace     `yaml:"-"` // read and written by the methods below
	Except []string `yaml:"-"`
}

type Declared struct {
	Visibility     string            `yaml:"visibility,omitempty"`
	Storage        string            `yaml:"storage,omitempty"`
	Layering       string            `yaml:"layering,omitempty"`
	Tracker        TrackerDecl       `yaml:"tracker,omitempty"`
	MergeMethod    string            `yaml:"merge_method,omitempty"`
	Catchup        string            `yaml:"catchup,omitempty"`
	CatchupStacked string            `yaml:"catchup_stacked,omitempty"` // how a branch catches up with a base that is another task's branch
	Traces         string            `yaml:"traces,omitempty"`
	Lore           string            `yaml:"lore,omitempty"`
	LoreGate       string            `yaml:"lore_gate,omitempty"`      // what finish does with a failing lore check before a merge
	StaleAfter     string            `yaml:"stale_after,omitempty"`    // a task older than this is judged before it is planned
	DriverTimeout  string            `yaml:"driver_timeout,omitempty"` // one driver verb's limit, a Go duration
	ReviewTraces   string            `yaml:"review_traces,omitempty"`  // the old spelling of traces, read and folded in
	Flows          map[string]Flow   `yaml:"flows,omitempty"`
	FlowByArea     map[string]string `yaml:"flow_by_area,omitempty"` // an area, in Roles' plain words, to the flow its tasks run
	DriveFinish    string            `yaml:"drive_finish,omitempty"`
	DriveEnv       []string          `yaml:"drive_env,omitempty"`     // environment keys a drive passes to its commands, beyond the built-in ones
	Watch          string            `yaml:"watch,omitempty"`         // what the daemon does for tasks no drive owns
	WatchCatchup   string            `yaml:"watch_catchup,omitempty"` // the watcher also catches an undriven open PR up with its target
	ReportBack     string            `yaml:"report_back,omitempty"`
	Review         ReviewDecl        `yaml:"review,omitempty"`
	Standup        StandupDecl       `yaml:"standup,omitempty"`
	Verify         []VerifyDecl      `yaml:"verify,omitempty"`  // verify commands, each scoped to the paths it checks
	Agents         map[string]string `yaml:"agents,omitempty"`  // a step, `default` or `step.kind` to the agent profile it runs on
	Paces          map[string]Pace   `yaml:"paces,omitempty"`   // a pace's name to its dials, laid over the built-ins key by key
	Pace           string            `yaml:"pace,omitempty"`    // the pace a run takes when it names none
	Ceiling        *Ceiling          `yaml:"ceiling,omitempty"` // the cap on every pace but the ones it excepts

	// The keys flows replaces, read and converted with a warning.
	Pipelines  map[string]Steps  `yaml:"pipelines,omitempty"`
	Planless   []string          `yaml:"planless,omitempty"`
	ByArea     map[string]string `yaml:"pipeline_by_area,omitempty"`
	DriveChain Steps             `yaml:"drive_chain,omitempty"`
}

type Dial struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Origin string `json:"origin"`
	Capped string `json:"capped,omitempty"` // what the pace had before the ceiling replaced it
}

type Dials struct {
	Off    bool   `yaml:"-"`
	On     bool   `yaml:"-"` // a ceiling's word: the step runs under every pace
	Finish string `yaml:"-"` // on or off, the finish key only
	By     string `yaml:"by,omitempty"`
	Rounds int    `yaml:"rounds,omitempty"`
	Depth  string `yaml:"depth,omitempty"`
	Effort string `yaml:"effort,omitempty"`
	Marker string `yaml:"marker,omitempty"`
	// contains filtered or unexported fields
}

type Draft struct {
	Markdown string
	Keys     []string
	Sections []string
	Omitted  []string
}

type Effective struct {
	Fields       []Field `json:"fields"`
	Unrecognized []Field `json:"unrecognized,omitempty"`

	// The fixed-vocabulary sub-facts.
	Layering        string `json:"layering"`
	Visibility      string `json:"visibility"`
	Storage         string `json:"storage"`
	TrackerKind     string `json:"trackerKind,omitempty"`
	IDPrefix        string `json:"idPrefix,omitempty"`        // "ABC", "F10" - the task id format's letters
	IDPrefixOrigin  string `json:"idPrefixOrigin,omitempty"`  // "declared (<layer>)" or "derived from project name <name>"
	IDPrefixDerived bool   `json:"idPrefixDerived,omitempty"` // the prefix came from the project's name, not a declaration

	// PriorityLabels is tracker.priority inverted: a lower-cased host label
	// to the level it carries; nil when none is declared.
	PriorityLabels map[string]string `json:"priorityLabels,omitempty"`

	// TitleTemplate is tracker.title, the template a task's title is written
	// through on the tracker; "" when none is declared, and titles stay bare.
	TitleTemplate tasktitle.Template `json:"titleTemplate,omitempty"`

	// TrackerStatus is tracker.status: `started` and `shipped` to the
	// tracker's own word; nil when none is declared, and f10 moves no status.
	TrackerStatus map[string]string `json:"trackerStatus,omitempty"`

	// The remote review's four facts (review.go); zero when Review declares
	// no remote reviewer.
	Review Review `json:"review"`

	// The rest of the typed facts (resolve.go). MergeMethod "" means none
	// declared: finish asks the repo.
	MergeMethod    string              `json:"mergeMethod,omitempty"`
	Catchup        string              `json:"catchup"`
	CatchupStacked string              `json:"catchupStacked"`        // catchup_stacked: the method for a base that is another task's branch
	Traces         bool                `json:"traces"`                // traces: on; a step's commits carry trailers, the squash commit keeps the task, a review or judge after the PR leaves a status and a comment
	Lore           string              `json:"lore"`                  // local: lore under the storage root; committed: .lore/ at the checkout root
	LoreGate       string              `json:"loreGate"`              // lore_gate: warn or block, what f10 finish does with a failing lore check before a merge
	StaleAfter     string              `json:"staleAfter,omitempty"`  // stale_after: a task older than this is judged before it is planned; "" is off
	DriverTimeout  time.Duration       `json:"driverTimeout"`         // driver_timeout: one driver verb's limit
	Flows          map[string][]string `json:"flows"`                 // a flow's name to its entries, in the colon form
	FlowLabels     map[string][]string `json:"flowLabels,omitempty"`  // a flow's name to its entries' display labels by index; only flows with one
	FlowByArea     map[string]string   `json:"flowByArea,omitempty"`  // flow_by_area: an area to the flow its tasks run
	DriveFinish    bool                `json:"driveFinish"`           // drive_finish: f10 drive ends each task with finish
	DriveEnv       []string            `json:"driveEnv,omitempty"`    // drive_env: environment keys a drive passes on, beyond the built-in ones
	Watch          string              `json:"watch"`                 // watch: report, finish or off, for tasks no drive owns; finish unless declared
	WatchCatchup   bool                `json:"watchCatchup"`          // watch_catchup: on; a watch pass also catches an undriven open PR up with its target and pushes it
	ReportBack     bool                `json:"reportBack"`            // report_back: a ship run posts its shipment on the task; on unless declared off
	UpkeepPaths    []string            `json:"upkeepPaths,omitempty"` // standup.upkeep: globs on top of the defaults
	// Verify is the frontmatter's verify list, which f10 config verify
	// scopes to the diff; VerifyOrigin names its layer. Nil when undeclared,
	// and the Verify field is the whole of verify.
	Verify       []VerifyDecl `json:"verify,omitempty"`
	VerifyOrigin string       `json:"verifyOrigin,omitempty"`
	// Agents is agents: a step, `default` or `step.kind` to the profile it
	// runs on, the layers merged key by key; AgentsOrigin names each key's
	// layer. Nil when none is declared.
	Agents       map[string]string `json:"agents,omitempty"`
	AgentsOrigin map[string]string `json:"agentsOrigin,omitempty"`
	// Paces is the project's paces: merged across its layers per pace and
	// key, PacesOrigin naming each <pace>.<key>'s layer; nil when none is
	// declared. Pace is the declared default, "" for none.
	Paces       map[string]Pace   `json:"paces,omitempty"`
	PacesOrigin map[string]string `json:"pacesOrigin,omitempty"`
	Pace        string            `json:"pace,omitempty"`
	PaceOrigin  string            `json:"paceOrigin,omitempty"`
	// Ceiling caps every pace but those CeilingExcept names, merged key by
	// key across the layers; nil when none is declared.
	Ceiling             Pace              `json:"ceiling,omitempty"`
	CeilingOrigin       map[string]string `json:"ceilingOrigin,omitempty"`
	CeilingExcept       []string          `json:"ceilingExcept,omitempty"`
	CeilingExceptOrigin string            `json:"ceilingExceptOrigin,omitempty"`

	// Facts is every typed value with its origin; Problems what is wrong
	// with how they were declared.
	Facts    []Fact    `json:"facts"`
	Problems []Problem `json:"problems,omitempty"`
	// contains filtered or unexported fields
}

type Fact struct {
	Key    string `json:"key"`
	Value  string `json:"value"`
	Origin string `json:"origin"`
}

type Field struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Prose  bool   `json:"prose,omitempty"`  // multi-line prose, not a scalar
	Origin string `json:"origin"`           // "detected", "declared (<layer>)", "default", "judgment", "absent"
	Source string `json:"source,omitempty"` // file for declared, evidence for detected
}

type Flow []string

type Labels []string

type Migration struct {
	Content    string
	Moved      []string // the frontmatter keys written
	Superseded []string // "<key>: <where in the prose>"
	Notes      []string // advice the move raised, such as a ceiling for drive_finish off
}

type Pace map[string]Dials

type PaceSet struct {
	Remote        bool // Review declares a remote reviewer, which an optional CI review needs
	Paces         map[string]Pace
	Origins       map[string]string // <pace>.<key> to the layer that set it
	Default       string            // pace: the pace a run takes when it names none; "" for none
	DefaultOrigin string

	Ceiling        Pace              // the project's cap on every pace Except does not name
	CeilingOrigins map[string]string // <key> to the layer that set it
	Except         []string
	ExceptOrigin   string
}

type Problem struct {
	Error   bool   `json:"error,omitempty"`
	Message string `json:"message"`
}

type Resolved struct {
	Flow    string          `json:"flow"`
	Pace    string          `json:"pace,omitempty"`
	Entries []ResolvedEntry `json:"entries"`
	Finish  *Dial           `json:"finish,omitempty"` // set only when the pace says and the run ends at a PR
}

type ResolvedEntry struct {
	Entry    string `json:"entry"` // as it runs: review:local when the pace named who reviews
	Declared string `json:"declared"`
	Step     string `json:"step"`
	Label    string `json:"label,omitempty"`   // the entry's display name, from its [label]
	Skipped  string `json:"skipped,omitempty"` // why it does not run: the pace's off, or an optional CI review dropped; "" when it runs
	Dials    []Dial `json:"dials,omitempty"`
}

type Review struct {
	Reviewer     string `json:"reviewer,omitempty"`     // the identity: a login, or a check's name
	ReviewerKind string `json:"reviewerKind,omitempty"` // bot | human | check
	Arrives      string `json:"arrives,omitempty"`      // issue comment | inline review | check run
	Trigger      string `json:"trigger,omitempty"`      // automatic | manual | automatic, manual
	TriggerHow   string `json:"triggerHow,omitempty"`   // the rest of the line: how a human fires it
	ManualHow    string `json:"manualHow,omitempty"`    // the manual part alone, when the line names both
	Done         string `json:"done,omitempty"`         // posted | marker | submitted | concluded
	DoneText     string `json:"doneText,omitempty"`     // the marker's text
	Handled      string `json:"handled,omitempty"`      // reaction | marker | checkbox | thread resolved
	HandledText  string `json:"handledText,omitempty"`  // the reaction's emoji, or the marker's text
	Settled      string `json:"settled,omitempty"`      // reaction | marker
	SettledText  string `json:"settledText,omitempty"`  // the reaction's emoji, or the marker's text
	// contains filtered or unexported fields
}

type ReviewDecl struct {
	Reviewer string `yaml:"reviewer,omitempty"`
	Arrives  string `yaml:"arrives,omitempty"`
	Trigger  string `yaml:"trigger,omitempty"`
	Done     string `yaml:"done,omitempty"`
	Settled  string `yaml:"settled,omitempty"`
}

type StandupDecl struct {
	Upkeep []string `yaml:"upkeep,omitempty"`
}

type Steps []string

type TrackerDecl struct {
	Kind     string            `yaml:"kind,omitempty"`
	ID       string            `yaml:"id,omitempty"`
	Priority map[string]Labels `yaml:"priority,omitempty"`
	Status   map[string]string `yaml:"status,omitempty"`
	Title    string            `yaml:"title,omitempty"`
}

type VerifyDecl struct {
	Run   string   `yaml:"run"`
	Paths []string `yaml:"paths,omitempty"`
}

type VerifyPick struct {
	VerifyDecl

	Pattern string
	File    string
}