display

Documentation

Overview

Package display provides simple, colorful console output functions for CLI applications.

Example usage:

display.Error("Failed to connect: %v", err)
display.Info("Starting process...")
display.Step("Processing file %s", filename)
display.Done("All tasks completed successfully")

Index

• Variables
• func Copyright() string
• func DockerList(dockers []sqlc.Docker, title string)
• func Done(format string, a ...any)
• func Error(format string, a ...any)
• func ImageUpdatesAvailable(updates []ImageUpdateInfo, envName string)
• func Info(format string, a ...any)
• func InfraList(rows [][]any, headers []string, title string)
• func K8sList(kubes []sqlc.K8s, title string)
• func Step(format string, a ...any)
• func UpdateAvailable(currentVersion, latestVersion string)
• func UpdateStarting(oldVersion, newVersion string)
• func Urls(portalURL, gatewayURL, backofficeURL, title string)
• func Warn(format string, a ...any)
• type ImageUpdateInfo

Variables

var (
	Stdout io.Writer = os.Stdout
	Stderr io.Writer = os.Stderr
)

Functions

func Copyright

func Copyright() string

func DockerList

func DockerList(dockers []sqlc.Docker, title string)

func Done

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

func Error

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

func ImageUpdatesAvailable

func ImageUpdatesAvailable(updates []ImageUpdateInfo, envName string)

ImageUpdatesAvailable prints a notification when Docker images have updates available

func Info

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

func InfraList

func InfraList(rows [][]any, headers []string, title string)

func K8sList

func K8sList(kubes []sqlc.K8s, title string)

func Step

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

func UpdateAvailable

func UpdateAvailable(currentVersion, latestVersion string)

UpdateAvailable prints a notification when a newer version of the CLI is available

func UpdateStarting

func UpdateStarting(oldVersion, newVersion string)

UpdateStarting prints a table indicating the start of an update with version details

func Urls

func Urls(portalURL, gatewayURL, backofficeURL, title string)

Urls prints the URLs for the data portal, API gateway, and backoffice for a specific environment

func Warn

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

Types

type ImageUpdateInfo

type ImageUpdateInfo struct {
	Name       string
	LastUpdate time.Time
}

ImageUpdateInfo holds information about an image update.