facts

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"`
	Traces        string            `yaml:"traces,omitempty"`
	Lore          string            `yaml:"lore,omitempty"`
	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
	ReportBack    string            `yaml:"report_back,omitempty"`
	Review        ReviewDecl        `yaml:"review,omitempty"`
	Standup       StandupDecl       `yaml:"standup,omitempty"`

	// 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 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"`
	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
	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
	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
	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

	// 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", "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>"
}

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

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"`
}