headless

Documentation

Index

• func DiagnosticLevelName(level DiagnosticLevel) string
• func FormatMappingNode(node *core.MappingNode) string
• func FormatScalarValue(scalar *core.ScalarValue) string
• func IsHeadless() bool
• func SetHeadlessForTesting(headless bool) func()
• func Validate(requirements ...Requirement) error
• type DiagnosticLevel
  • func DiagnosticLevelFromCore(level core.DiagnosticLevel) DiagnosticLevel
• type Flag
• type PrefixedWriter
  • func NewPrefixedWriter(w io.Writer, prefix string) *PrefixedWriter
  • func (pw *PrefixedWriter) DoubleSeparator(width int)
  • func (pw *PrefixedWriter) Prefix() string
  • func (pw *PrefixedWriter) Printf(format string, args ...any)
  • func (pw *PrefixedWriter) Println(s string)
  • func (pw *PrefixedWriter) PrintlnEmpty()
  • func (pw *PrefixedWriter) Separator(char rune, width int)
  • func (pw *PrefixedWriter) SingleSeparator(width int)
  • func (pw *PrefixedWriter) Writer() io.Writer
• type Printer
  • func NewPrinter(w *PrefixedWriter, width int) *Printer
  • func (p *Printer) CountSummary(count int, singular, plural, verb string)
  • func (p *Printer) Diagnostic(level string, message string, line, col int)
  • func (p *Printer) FieldAdd(path, value string)
  • func (p *Printer) FieldModify(path, oldValue, newValue string)
  • func (p *Printer) FieldRemove(path string)
  • func (p *Printer) ItemHeader(itemType, name, action string)
  • func (p *Printer) NextStep(description, command string)
  • func (p *Printer) NoChanges()
  • func (p *Printer) ProgressItem(icon, itemType, name, action, suffix string)
  • func (p *Printer) Width() int
  • func (p *Printer) Writer() *PrefixedWriter
• type Requirement
  • func OneOf(flags ...Flag) Requirement
  • func Required(f Flag) Requirement

Functions

func DiagnosticLevelName

func DiagnosticLevelName(level DiagnosticLevel) string

DiagnosticLevelName returns the display name for a diagnostic level.

func FormatMappingNode

func FormatMappingNode(node *core.MappingNode) string

FormatMappingNode formats a MappingNode for display.

func FormatScalarValue

func FormatScalarValue(scalar *core.ScalarValue) string

FormatScalarValue formats a ScalarValue for display.

func IsHeadless

func IsHeadless() bool

IsHeadless returns true if not running in an interactive terminal

func SetHeadlessForTesting

func SetHeadlessForTesting(headless bool) func()

SetHeadlessForTesting overrides IsHeadless for testing purposes. Returns a cleanup function that restores the original behavior.

func Validate

func Validate(requirements ...Requirement) error

Validate checks all requirements, but only if in headless mode. In interactive mode, returns nil (TUI will handle missing values).

Types

type DiagnosticLevel

type DiagnosticLevel int

DiagnosticLevel represents the level of a diagnostic.

const (
	DiagnosticLevelError DiagnosticLevel = iota
	DiagnosticLevelWarning
	DiagnosticLevelInfo
)

func DiagnosticLevelFromCore

func DiagnosticLevelFromCore(level core.DiagnosticLevel) DiagnosticLevel

DiagnosticLevelFromCore converts core.DiagnosticLevel to headless.DiagnosticLevel.

type Flag

type Flag struct {
	Name      string // Flag name for error messages (e.g., "blueprint-file")
	Value     string // Current value
	IsDefault bool   // True if using default value (not explicitly set)
}

Flag represents a flag value with its default status

type PrefixedWriter

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

PrefixedWriter wraps an io.Writer to auto-prefix all lines.

func NewPrefixedWriter

func NewPrefixedWriter(w io.Writer, prefix string) *PrefixedWriter

NewPrefixedWriter creates a writer that prefixes all output lines.

func (*PrefixedWriter) DoubleSeparator

func (pw *PrefixedWriter) DoubleSeparator(width int)

DoubleSeparator writes a double-line separator (═).

func (*PrefixedWriter) Prefix

func (pw *PrefixedWriter) Prefix() string

Prefix returns the prefix string.

func (*PrefixedWriter) Printf

func (pw *PrefixedWriter) Printf(format string, args ...any)

Printf writes a formatted line with the prefix.

func (*PrefixedWriter) Println

func (pw *PrefixedWriter) Println(s string)

Println writes a line with the prefix.

func (*PrefixedWriter) PrintlnEmpty

func (pw *PrefixedWriter) PrintlnEmpty()

PrintlnEmpty writes an empty line (no prefix).

func (*PrefixedWriter) Separator

func (pw *PrefixedWriter) Separator(char rune, width int)

Separator writes a separator line with the given character.

func (*PrefixedWriter) SingleSeparator

func (pw *PrefixedWriter) SingleSeparator(width int)

SingleSeparator writes a single-line separator (─).

func (*PrefixedWriter) Writer

func (pw *PrefixedWriter) Writer() io.Writer

Writer returns the underlying io.Writer.

type Printer

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

Printer provides common headless output patterns.

func NewPrinter

func NewPrinter(w *PrefixedWriter, width int) *Printer

NewPrinter creates a headless printer.

func (*Printer) CountSummary

func (p *Printer) CountSummary(count int, singular, plural, verb string)

CountSummary prints a count with pluralization.

func (*Printer) Diagnostic

func (p *Printer) Diagnostic(level string, message string, line, col int)

Diagnostic prints a diagnostic message with level, location, and wrapped text.

func (*Printer) FieldAdd

func (p *Printer) FieldAdd(path, value string)

FieldAdd prints an added field.

func (*Printer) FieldModify

func (p *Printer) FieldModify(path, oldValue, newValue string)

FieldModify prints a modified field.

func (*Printer) FieldRemove

func (p *Printer) FieldRemove(path string)

FieldRemove prints a removed field.

func (*Printer) ItemHeader

func (p *Printer) ItemHeader(itemType, name, action string)

ItemHeader prints an item header with type, name, and action.

func (*Printer) NextStep

func (p *Printer) NextStep(description, command string)

NextStep prints a "to do X, run:" instruction.

func (*Printer) NoChanges

func (p *Printer) NoChanges()

NoChanges prints a "no changes" message.

func (*Printer) ProgressItem

func (p *Printer) ProgressItem(icon, itemType, name, action, suffix string)

ProgressItem prints a progress event line. Format: icon type: name - action (suffix)

func (*Printer) Width

func (p *Printer) Width() int

Width returns the configured terminal width.

func (*Printer) Writer

func (p *Printer) Writer() *PrefixedWriter

Writer returns the underlying PrefixedWriter.

type Requirement

type Requirement interface {
	Validate() error
}

Requirement defines a validation rule

func OneOf

func OneOf(flags ...Flag) Requirement

OneOf creates a rule that at least one of the flags must be provided

func Required

func Required(f Flag) Requirement

Required creates a rule that the flag must be explicitly provided