Documentation
¶
Overview ¶
Package report contains the structured, headless read-model for JACU state. Markdown is an output projection; it is never used as an input source.
Index ¶
- Constants
- func Digest(report Report) (string, error)
- func EncodeJSON(report Report) ([]byte, error)
- func Statusline(root string) (string, error)
- func Validate(report Report) error
- type ChartPoint
- type DecisionPoint
- type FlowBlock
- type FlowEdge
- type FlowNode
- type Metric
- type Report
- type ReportBlocks
- type ReportStep
- type TableBlock
Constants ¶
View Source
const ( SchemaVersion = "1" KindAdhoc = "adhoc" KindPlan = "plan" KindAudit = "audit" QualityJSONName = "quality.json" )
Variables ¶
This section is empty.
Functions ¶
func EncodeJSON ¶ added in v0.4.0
func Statusline ¶
Types ¶
type ChartPoint ¶
type DecisionPoint ¶
type Report ¶
type Report struct {
SchemaVersion string `json:"schema_version"`
Kind string `json:"kind"`
Title string `json:"title"`
Summary string `json:"summary"`
Blocks ReportBlocks `json:"blocks"`
}
func BuildAudit ¶
type ReportBlocks ¶
type ReportBlocks struct {
Summary []string `json:"summary"`
Steps []ReportStep `json:"steps"`
Decision []DecisionPoint `json:"decision"`
Risks []string `json:"risks"`
Flow FlowBlock `json:"flow"`
Chart []ChartPoint `json:"chart"`
Table TableBlock `json:"table"`
Metrics []Metric `json:"metrics"`
}
type ReportStep ¶
type TableBlock ¶
Click to show internal directories.
Click to hide internal directories.