consolez

package

v0.2.0 Latest Latest Go to latest Published: Nov 25, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ibrt/golang-lib

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type CLI
- func NewCLI(addSpacing bool, exit func(int)) *CLI
type Coverage
type CoveragePrinter
- func NewCoveragePrinter() CoveragePrinter
type GoTestPrinter
- func NewGoTestPrinter() GoTestPrinter

Constants ¶

View Source

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

Known icons.

Variables ¶

View Source

var (
	// DefaultCLI is a default, shared instance of CLI.
	DefaultCLI = NewCLI(true, os.Exit)
)

Functions ¶

This section is empty.

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(addSpacing bool, exit func(int)) *CLI

NewCLI initializes a new CLI.

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 (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 Error on a recovered panic and exits.

func (*CLI) Tool ¶

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

Tool introduces a command line tool.

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL