render

Documentation

Index

• func TermWidth() int
• type OutputMode
  • func DetectMode(jsonFlag bool, noColorFlag bool) OutputMode
• type Renderer
  • func New(mode OutputMode, width int) *Renderer
  • func (r *Renderer) RenderBrief(b *domain.Brief) string
  • func (r *Renderer) RenderCreateIterationResult(result *domain.CreateIterationResult) string
  • func (r *Renderer) RenderCreateResult(result *domain.CreateResult) string
  • func (r *Renderer) RenderDocTree(docs []domain.Document) string
  • func (r *Renderer) RenderDoctor(report *domain.DoctorReport) string
  • func (r *Renderer) RenderDocumentList(list *domain.DocumentList) string
  • func (r *Renderer) RenderGraph(graph *domain.Graph, stale map[string]string) string
  • func (r *Renderer) RenderHealth(h *domain.ProjectHealth) string
  • func (r *Renderer) RenderInitResult(result *domain.InitResult) string
  • func (r *Renderer) RenderIterations(iters []domain.Iteration) string
  • func (r *Renderer) RenderReconcileResult(result *domain.ReconcileResult) string
  • func (r *Renderer) RenderSearchResults(results *domain.SearchResults) string
  • func (r *Renderer) RenderStubList(list *domain.StubList) string
  • func (r *Renderer) RenderUnifiedValidation(report *domain.UnifiedValidationReport) string
  • func (r *Renderer) RenderValidation(report *domain.ValidationReport) string
  • func (r *Renderer) RenderVersionInfo(info *domain.VersionInfo) string
  • func (r *Renderer) RenderWorkflowHistory(history *domain.WorkflowHistory) string
  • func (r *Renderer) RenderWorkflowStatus(ws *domain.WorkflowState) string

Functions

func TermWidth

func TermWidth() int

TermWidth returns the terminal width or 80 as default.

Types

type OutputMode

type OutputMode int

OutputMode determines how results are displayed.

const (
	ModeInteractive OutputMode = iota
	ModePlain
	ModeJSON
)

func DetectMode

func DetectMode(jsonFlag bool, noColorFlag bool) OutputMode

DetectMode checks TTY and flags.

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer formats domain results for display.

func New

func New(mode OutputMode, width int) *Renderer

New creates a Renderer.

func (*Renderer) RenderBrief

func (r *Renderer) RenderBrief(b *domain.Brief) string

RenderBrief formats a Brief for display.

func (*Renderer) RenderCreateIterationResult

func (r *Renderer) RenderCreateIterationResult(result *domain.CreateIterationResult) string

RenderCreateIterationResult formats a CreateIterationResult for display.

func (*Renderer) RenderCreateResult

func (r *Renderer) RenderCreateResult(result *domain.CreateResult) string

RenderCreateResult formats a CreateResult for display.

func (*Renderer) RenderDocTree

func (r *Renderer) RenderDocTree(docs []domain.Document) string

RenderDocTree formats a docs tree for display.

func (*Renderer) RenderDoctor

func (r *Renderer) RenderDoctor(report *domain.DoctorReport) string

RenderDoctor formats a DoctorReport for display.

func (*Renderer) RenderDocumentList

func (r *Renderer) RenderDocumentList(list *domain.DocumentList) string

RenderDocumentList formats a DocumentList for display.

func (*Renderer) RenderGraph

func (r *Renderer) RenderGraph(graph *domain.Graph, stale map[string]string) string

RenderGraph formats a dependency graph as an ASCII tree (FR-54). stale is a map of document IDs to stale reasons (may be nil).

func (*Renderer) RenderHealth

func (r *Renderer) RenderHealth(h *domain.ProjectHealth) string

RenderHealth formats a ProjectHealth for display.

func (*Renderer) RenderInitResult

func (r *Renderer) RenderInitResult(result *domain.InitResult) string

RenderInitResult formats an InitResult for display.

func (*Renderer) RenderIterations

func (r *Renderer) RenderIterations(iters []domain.Iteration) string

RenderIterations formats an iteration list for display.

func (*Renderer) RenderReconcileResult

func (r *Renderer) RenderReconcileResult(result *domain.ReconcileResult) string

RenderReconcileResult formats a ReconcileResult for display (FR-51..FR-53).

func (*Renderer) RenderSearchResults

func (r *Renderer) RenderSearchResults(results *domain.SearchResults) string

RenderSearchResults formats SearchResults for display.

func (*Renderer) RenderStubList

func (r *Renderer) RenderStubList(list *domain.StubList) string

RenderStubList formats a StubList for display.

func (*Renderer) RenderUnifiedValidation

func (r *Renderer) RenderUnifiedValidation(report *domain.UnifiedValidationReport) string

RenderUnifiedValidation formats a UnifiedValidationReport for display.

func (*Renderer) RenderValidation

func (r *Renderer) RenderValidation(report *domain.ValidationReport) string

RenderValidation formats a ValidationReport for display.

func (*Renderer) RenderVersionInfo

func (r *Renderer) RenderVersionInfo(info *domain.VersionInfo) string

RenderVersionInfo formats a VersionInfo for display.

func (*Renderer) RenderWorkflowHistory

func (r *Renderer) RenderWorkflowHistory(history *domain.WorkflowHistory) string

RenderWorkflowHistory formats a WorkflowHistory for display.

func (*Renderer) RenderWorkflowStatus

func (r *Renderer) RenderWorkflowStatus(ws *domain.WorkflowState) string

RenderWorkflowStatus formats a WorkflowState for display.