banner

Documentation

Overview

Package banner provides the figlet + lolcat startup banner shared between the CLI REPL and the TUI.

The rainbow coloring algorithm is vendored from github.com/flaviocopes/gololcat (which is package main and not importable as a library).

Index

• Constants
• func Generate() (string, int)
• func GeneratePlain() (art string, tagline string, lineCount int)
• func Lolcat(art string) string
• func LolcatRGB(i int) (int, int, int)
• func Render(version string) string

Constants

const Title = "yaah"

Functions

func Generate

func Generate() (string, int)

Generate renders "yaah" as figlet ASCII art with lolcat rainbow coloring, followed by the tagline and subtitle. Picks a random font from the curated list on each call. Returns the styled banner string and its line count. Falls back to plain "yaah" if figlet fails. Respects the NO_COLOR environment variable.

func GeneratePlain

func GeneratePlain() (art string, tagline string, lineCount int)

GeneratePlain renders "yaah" as plain figlet ASCII art (no ANSI coloring) plus a random tagline. Returns the art, the tagline, and the line count.

Use this when you need to apply your own color markup (e.g. tview color tags) instead of ANSI escape codes — call LolcatRGB for each character index to get the same rainbow gradient.

func Lolcat

func Lolcat(art string) string

Lolcat applies lolcat rainbow coloring to arbitrary ASCII art text. Each character receives an RGB color from the sine-wave algorithm. Respects the NO_COLOR environment variable.

func LolcatRGB

func LolcatRGB(i int) (int, int, int)

lolcatRGB maps a character index to an RGB triple using the same sine-wave algorithm as gololcat / the original lolcat. LolcatRGB maps a character index to a rainbow RGB triple (same algorithm used by Lolcat). Useful for consumers that need to apply their own color markup (e.g. tview color tags instead of ANSI escape codes).

func Render

func Render(version string) string

Render returns the full CLI startup banner: figlet art with subtitle, a dim version line, and trailing blank lines. Respects NO_COLOR.