ui

Documentation

Index

• Constants
• Variables
• func Divider(width int) string
• func IsTTY() bool
• func NoColor() bool
• func PrintJSON(w io.Writer, v any) error
• func RenderComparisonTable(licenses []license.License, rules license.Rules) string

Constants

const (
	IconCheck  = "✓"
	IconCross  = "✗"
	IconBullet = "●"
	IconDot    = "•"
	IconArrow  = "▸"
)

Variables

var (
	Teal       = lipgloss.Color("#2DD4BF")
	Green      = lipgloss.Color("#22C55E")
	Amber      = lipgloss.Color("#F59E0B")
	Red        = lipgloss.Color("#EF4444")
	White      = lipgloss.Color("#F8FAFC")
	SlateGray  = lipgloss.Color("#94A3B8")
	DarkSlate  = lipgloss.Color("#475569")
	LightSlate = lipgloss.Color("#CBD5E1")
	DeepSlate  = lipgloss.Color("#1E293B")
	Ink        = lipgloss.Color("#0F172A")
)

var (
	// HeadingStyle for section headers and emphasis.
	HeadingStyle = lipgloss.NewStyle().Bold(true).Foreground(White)

	// AccentStyle for links, SPDX IDs, URLs.
	AccentStyle = lipgloss.NewStyle().Foreground(Teal)

	// LinkStyle for clickable URLs — accent + underline.
	LinkStyle = lipgloss.NewStyle().Foreground(Teal).Underline(true)

	// SecondaryStyle for descriptions, hints, and secondary text.
	SecondaryStyle = lipgloss.NewStyle().Foreground(SlateGray)

	// PermissionStyle for permission tags (green).
	PermissionStyle = lipgloss.NewStyle().Foreground(Green)

	// ConditionStyle for condition tags (amber).
	ConditionStyle = lipgloss.NewStyle().Foreground(Amber)

	// LimitationStyle for limitation tags (red).
	LimitationStyle = lipgloss.NewStyle().Foreground(Red)

	// DividerStyle for section separators.
	DividerStyle = lipgloss.NewStyle().Foreground(DarkSlate)

	// BadgeStyle for count badges and highlighted inline text.
	BadgeStyle = lipgloss.NewStyle().Bold(true).Foreground(Teal)
)

var DefaultHuhTheme = createHuhTheme()

Functions

func Divider

func Divider(width int) string

Divider returns a styled horizontal rule of the given width.

func IsTTY

func IsTTY() bool

IsTTY returns true if stdout is a terminal.

func NoColor

func NoColor() bool

NoColor returns true if the NO_COLOR env var is set.

func PrintJSON

func PrintJSON(w io.Writer, v any) error

PrintJSON writes v as indented JSON to w.

func RenderComparisonTable

func RenderComparisonTable(licenses []license.License, rules license.Rules) string

RenderComparisonTable builds a side-by-side comparison table for the given licenses.