Help us shape the future of Go! Take the 2026 Go Developer Survey

render

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 24, 2026 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package render holds the semantic styles orchard uses for all user-facing terminal output. Call sites reference styles by what they mean ("Success", "Error", "Muted") rather than by color names, so the palette can evolve without touching every cmd/.

Styles are lipgloss values. Their no-op fallback on non-TTY output (via termenv auto-detection) means the same helpers work in pipes, CI, and plain terminals without a separate code path. Respecting NO_COLOR is automatic.

Index

Constants

This section is empty.

Variables

View Source
var (
	// Success marks a completed node or a "plan is valid" summary.
	Success = lipgloss.NewStyle().Foreground(colorSuccess).Bold(true)

	// SuccessMark is the ✓ glyph styled for a completed action.
	SuccessMark = lipgloss.NewStyle().Foreground(colorSuccess)

	// Error marks a failed node or a plan-time validation error.
	Error = lipgloss.NewStyle().Foreground(colorError).Bold(true)

	// ErrorMark is the ✗ glyph styled for a failed action.
	ErrorMark = lipgloss.NewStyle().Foreground(colorError)

	// Warn is for non-fatal diagnostics — teardown warnings, etc.
	Warn = lipgloss.NewStyle().Foreground(colorWarn)

	// Header styles a top-level section heading (Scenario, Plan).
	Header = lipgloss.NewStyle().Foreground(colorLabel).Bold(true)

	// Label styles a minor heading inside a section (Variables,
	// Providers, Execution plan, Outputs).
	Label = lipgloss.NewStyle().Foreground(colorLabel).Bold(true)

	// Kind styles node-type badges ([action], [component]) and
	// provider source indicators.
	Kind = lipgloss.NewStyle().Foreground(colorKind)

	// Ref styles references to other nodes (dependencies, source-
	// of-output links).
	Ref = lipgloss.NewStyle().Foreground(colorAccent)

	// Muted styles low-priority text: timings, node IDs in summary
	// lines, dim dependency arrows, file coords.
	Muted = lipgloss.NewStyle().Foreground(colorMuted)

	// Value styles scenario variable values, action output values.
	Value = lipgloss.NewStyle().Foreground(colorSuccess)

	// Bold is a plain bold with default foreground — for emphasis
	// that should not take on a semantic color.
	Bold = lipgloss.NewStyle().Bold(true)
)

Semantic styles. Each is a lipgloss.Style value; call .Render to apply, or use as-is in text templates.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL