consolez

Documentation

Overview

Package consolez provides various utilities for building CLI tools.

Index

• Constants
• Variables
• func RestoreDefaultCLI()
• type CLI
  • func NewCLI() *CLI
  • func (c *CLI) Banner(title, tagLine string)
  • func (c *CLI) Command(cmd string, params ...string)
  • func (c *CLI) Error(err error, debug bool)
  • func (c *CLI) Header(format string, a ...any) func()
  • func (c *CLI) NewTable(columnHeaders ...any) table.Table
  • func (c *CLI) Notice(scope string, highlight string, secondary ...string)
  • func (c *CLI) Recover(debug bool)
  • func (c *CLI) SetExit(exit func(code int)) *CLI
  • func (c *CLI) SetStyles(styles outz.Styles) *CLI
  • func (c *CLI) Tool(toolName string, k *kong.Context)
  • func (c *CLI) WithHeader(format string, a []any, f func())
• type Coverage
• type CoveragePrinter
  • func NewCoveragePrinter() CoveragePrinter
• type GoTestPrinter
  • func NewGoTestPrinter() GoTestPrinter

Constants

const (
	IconRocket                     = "\U0001F680"
	IconHighVoltage                = "\U000026A1"
	IconBackhandIndexPointingRight = "\U0001F449"
	IconRunner                     = "\U0001F3C3"
	IconCollision                  = "\U0001F4A5"
)

Known icons.

Variables

var (
	DefaultCLI = defaultCLI
)

DefaultCLI is a default, shared instance of *CLI.

Functions

func RestoreDefaultCLI

func RestoreDefaultCLI()

RestoreDefaultCLI restores the default value of DefaultCLI.

Types

type CLI

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

CLI provides some utilities for printing messages in CLI tools.

func NewCLI

func NewCLI() *CLI

NewCLI initializes a new *CLI.

func (*CLI) Banner

func (c *CLI) Banner(title, tagLine string)

Banner prints a banner.

func (*CLI) Command

func (c *CLI) Command(cmd string, params ...string)

Command prints a command.

func (*CLI) Error

func (c *CLI) Error(err error, debug bool)

Error prints an error.

func (*CLI) Header

func (c *CLI) Header(format string, a ...any) func()

Header prints a header based on a nesting hierarchy. Always call the returned function to close the scope, for example by deferring it.

func (*CLI) NewTable

func (c *CLI) NewTable(columnHeaders ...any) table.Table

NewTable creates a new table.

func (*CLI) Notice

func (c *CLI) Notice(scope string, highlight string, secondary ...string)

Notice prints a notice.

func (*CLI) Recover

func (c *CLI) Recover(debug bool)

Recover calls *CLI.Error on a recovered panic and exits.

func (*CLI) SetExit

func (c *CLI) SetExit(exit func(code int)) *CLI

SetExit sets the exit implementation.

func (*CLI) SetStyles

func (c *CLI) SetStyles(styles outz.Styles) *CLI

SetStyles sets the styles.

func (*CLI) Tool

func (c *CLI) Tool(toolName string, k *kong.Context)

Tool introduces a command line tool.

func (*CLI) WithHeader

func (c *CLI) WithHeader(format string, a []any, f func())

WithHeader calls *CLI.Header and runs f() within its scope.

type Coverage

type Coverage struct {
	Packages []*gocov.Package
}

Coverage describes collected coverage.

type CoveragePrinter

type CoveragePrinter interface {
	Print(coverage *Coverage)
}

CoveragePrinter implements a printer for test coverage information.

func NewCoveragePrinter

func NewCoveragePrinter() CoveragePrinter

NewCoveragePrinter initializes a new CoveragePrinter.

type GoTestPrinter

type GoTestPrinter interface {
	PrintLine(line string)
	PrintDone()
}

GoTestPrinter implements a printer for "go test" output.

func NewGoTestPrinter

func NewGoTestPrinter() GoTestPrinter

NewGoTestPrinter initializes a new GoTestPrinter.