cli

Documentation

Overview

Package cli provides consistent color formatting for CLI output across all tools in the monorepo.

Index

• func Error(s string) string
• func Errorf(format string, a ...any) string
• func Header(s string) string
• func Headerf(format string, a ...any) string
• func Key(s string) string
• func Keyf(format string, a ...any) string
• func Muted(s string) string
• func Mutedf(format string, a ...any) string
• func NewTable(output io.Writer) table.Writer
• func Path(s string) string
• func Pathf(format string, a ...any) string
• func PrintError(s string)
• func PrintHeader(s string)
• func PrintSuccess(s string)
• func PrintWarning(s string)
• func Secondary(s string) string
• func Secondaryf(format string, a ...any) string
• func Success(s string) string
• func Successf(format string, a ...any) string
• func Type(s string) string
• func Typef(format string, a ...any) string
• func Value(v any) string
• func Valuef(format string, a ...any) string
• func Warning(s string) string
• func Warningf(format string, a ...any) string

Functions

func Error

func Error(s string) string

Error returns a red-colored string for errors.

func Errorf

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

Errorf returns a formatted red-colored string.

func Header

func Header(s string) string

Header returns a bold string for section headers.

func Headerf

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

Headerf returns a formatted bold string.

func Key

func Key(s string) string

Key returns a cyan bold-colored string for configuration keys and identifiers.

func Keyf

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

Keyf returns a formatted cyan bold-colored string.

func Muted

func Muted(s string) string

Muted returns a bright-black-colored string for disabled or unset values.

func Mutedf

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

Mutedf returns a formatted bright-black-colored string.

func NewTable

func NewTable(output io.Writer) table.Writer

NewTable returns a go-pretty table.Writer configured with the monorepo defaults. It mirrors output to stdout, uses the light style, separates rows, and hides the outer border.

func Path

func Path(s string) string

Path returns a cyan-colored string for file paths.

func Pathf

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

Pathf returns a formatted cyan-colored string.

func PrintError

func PrintError(s string)

PrintError prints a red-colored message to stdout.

func PrintHeader

func PrintHeader(s string)

PrintHeader prints a bold header to stdout.

func PrintSuccess

func PrintSuccess(s string)

PrintSuccess prints a green-colored message to stdout.

func PrintWarning

func PrintWarning(s string)

PrintWarning prints a yellow-colored message to stdout.

func Secondary

func Secondary(s string) string

Secondary returns a blue-colored string for secondary information.

func Secondaryf

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

Secondaryf returns a formatted blue-colored string.

func Success

func Success(s string) string

Success returns a green-colored string for successful operations.

func Successf

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

Successf returns a formatted green-colored string.

func Type

func Type(s string) string

Type returns a yellow-colored string for type information.

func Typef

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

Typef returns a formatted yellow-colored string.

func Value

func Value(v any) string

Value returns a green-colored string for configured values.

func Valuef

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

Valuef returns a formatted green-colored string.

func Warning

func Warning(s string) string

Warning returns a yellow-colored string for warnings.

func Warningf

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

Warningf returns a formatted yellow-colored string.