render

Documentation

Overview

Package render provides terminal output helpers: optional ANSI color, simple aligned tables, and an ASCII commit-graph used to visualize rebases. Color is disabled when color-mode:none is passed or when output is not a terminal.

Index

• func Plain(format string, a ...any) string
• type Colors
  • func NewColors(colorMode string, isTTY bool) Colors
  • func (c Colors) Bold(s string) string
  • func (c Colors) Cyan(s string) string
  • func (c Colors) Dim(s string) string
  • func (c Colors) Enabled() bool
  • func (c Colors) Green(s string) string
  • func (c Colors) Magenta(s string) string
  • func (c Colors) Red(s string) string
  • func (c Colors) Yellow(s string) string
• type Commit
• type RebasePlan
  • func (p RebasePlan) Render(c Colors) string
  • func (p RebasePlan) RenderAfter(c Colors) string
  • func (p RebasePlan) RenderBefore(c Colors) string
• type Stepper
  • func (s Stepper) Run(label string, fn func() error) error
• type Table
  • func NewTable(header ...string) *Table
  • func (t *Table) Add(cells ...string)
  • func (t *Table) String() string

Functions

func Plain

func Plain(format string, a ...any) string

Plain is a convenience for fmt.Sprintf used by callers.

Types

type Colors

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

Colors holds whether ANSI styling is enabled.

func NewColors

func NewColors(colorMode string, isTTY bool) Colors

NewColors decides whether to colorize. Precedence: an explicit colorMode wins ("none" forces plain, "always" forces color); otherwise a non-empty NO_COLOR environment variable disables color (https://no-color.org); otherwise color follows isTTY.

func (Colors) Bold

func (c Colors) Bold(s string) string

func (Colors) Cyan

func (c Colors) Cyan(s string) string

func (Colors) Dim

func (c Colors) Dim(s string) string

func (Colors) Enabled

func (c Colors) Enabled() bool

Enabled reports whether ANSI styling is on.

func (Colors) Green

func (c Colors) Green(s string) string

func (Colors) Magenta

func (c Colors) Magenta(s string) string

func (Colors) Red

func (c Colors) Red(s string) string

func (Colors) Yellow

func (c Colors) Yellow(s string) string

type Commit

type Commit struct {
	Short   string // abbreviated sha
	Subject string // first line of the commit message
}

Commit is one node in a rebase visualization.

type RebasePlan

type RebasePlan struct {
	Feature   string // feature branch name (for labels)
	Trunk     string // trunk branch name (for labels)
	Fork      Commit
	TrunkLine []Commit
	FeatLine  []Commit
}

RebasePlan describes the move a rebase performs: the feature commits currently hanging off Fork are replayed on top of the trunk commits that landed since.

Trunk   = commits on trunk after Fork, up to trunk head (newest first)
Feature = the feature's own commits after Fork (newest first)
Fork    = the common ancestor the feature forked from

func (RebasePlan) Render

func (p RebasePlan) Render(c Colors) string

Render draws a before/after ASCII graph of the rebase. The "before" picture shows the feature diverged from trunk; the "after" picture shows it replayed on top of trunk head. Colors are applied when enabled.

Render uses the plan's FeatLine for both halves, so the "after" SHAs are a projection (the pre-rebase commits). Callers that want the "after" graph to show the real post-rebase SHAs should render the halves separately (RenderBefore, then re-read the new SHAs into the plan, then RenderAfter).

func (RebasePlan) RenderAfter

func (p RebasePlan) RenderAfter(c Colors) string

RenderAfter draws the "after" half: the feature replayed on top of trunk head. It draws the replayed nodes from FeatLine, so callers should set FeatLine to the real post-rebase commits before calling it (see visualizeRebase).

func (RebasePlan) RenderBefore

func (p RebasePlan) RenderBefore(c Colors) string

RenderBefore draws the "before" half: the feature diverged from trunk.

type Stepper

type Stepper struct {
	W      io.Writer
	TTY    bool
	Colors Colors
}

Stepper telegraphs the procedure tbd is about to run and, on a terminal, animates a spinner for its duration. Progress is meant for stderr so stdout stays clean for piping.

func (Stepper) Run

func (s Stepper) Run(label string, fn func() error) error

Run announces label, runs fn, and returns fn's error. On a TTY it shows an animated spinner ONLY if fn runs longer than spinDelay, erasing it when done (the command prints its own result). Off a TTY it prints the label once, so the procedure is still telegraphed in logs and CI.

type Table

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

Table renders rows of cells into a left-aligned, space-padded table.

func NewTable

func NewTable(header ...string) *Table

NewTable creates a table with the given header.

func (*Table) Add

func (t *Table) Add(cells ...string)

Add appends a row.

func (*Table) String

func (t *Table) String() string

String renders the table. Width is computed from visible (un-styled) length, so cells may carry ANSI color and still align.