message

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package message provides a rich set of functions for displaying messages to the user.

Package message provides a rich set of functions for displaying messages to the user.

Package message provides a rich set of functions for displaying messages to the user.

Package message provides a rich set of functions for displaying messages to the user.

Index

Constants

This section is empty.

Variables

View Source 
var LogWriter io.Writer = os.Stderr

LogWriter is the stream to write logs to.

View Source 
var NoProgress bool

NoProgress tracks whether spinner/progress bars show updates.

View Source 
var RuleLine = strings.Repeat("━", TermWidth)

RuleLine creates a line of ━ as wide as the terminal

Functions

func Debug 

func Debug(payload ...any)

Debug prints a debug message.

func Debugf 

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

Debugf prints a debug message with a given format.

func Detail added in v0.4.4 

func Detail(message string)

Detail prints detail message.

func Detailf added in v0.4.4 

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

Detailf prints a detail message preserving newlines

func DisableColor 

func DisableColor()

DisableColor disables color in output

func ErrorWebf 

func ErrorWebf(err any, w http.ResponseWriter, format string, a ...any)

ErrorWebf prints an error message and returns a web response.

func Fatal 

func Fatal(err any, message string)

Fatal prints a fatal error message and exits with a 1.

func Fatalf 

func Fatalf(err any, format string, a ...any)

Fatalf prints a fatal error message and exits with a 1 with a given format.

func HeaderInfof 

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

HeaderInfof prints a large header with a formatted message.

func HorizontalRule 

func HorizontalRule()

HorizontalRule prints a white horizontal rule to separate the terminal

func Info 

func Info(message string)

Info prints an info message.

func Infof 

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

Infof prints an info message with a given format.

func JSONValue 

func JSONValue(value any) string

JSONValue prints any value as JSON.

func Note 

func Note(text string)

Note prints a note message.

func Notef 

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

Notef prints a note message with a given format.

func Paragraph 

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

Paragraph formats text into a paragraph matching the TermWidth

func Paragraphn 

func Paragraphn(n int, format string, a ...any) string

Paragraphn formats text into an n column paragraph

func PrintDiff 

func PrintDiff(textA, textB string)

PrintDiff prints the differences between a and b with a as original and b as new

func PromptForConfirmation added in v0.4.0 

func PromptForConfirmation(spinner *Spinner) bool

func Question 

func Question(text string)

Question prints a user prompt description message.

func Questionf 

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

Questionf prints a user prompt description message with a given format.

func SetLogLevel 

func SetLogLevel(lvl LogLevel)

SetLogLevel sets the log level.

func Success 

func Success(message string)

Success prints a success message.

func Successf 

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

Successf prints a success message with a given format.

func Table 

func Table(header []string, data [][]string, columnSize []int)

Table prints a padded table containing the specified header and data Note - columnSize should be an array of ints that add up to 100

func Title 

func Title(title string, help string)

Title prints a title and an optional help description for that section

func Truncate 

func Truncate(text string, length int, invert bool) string

Truncate truncates provided text to the requested length

func UseLogFile 

func UseLogFile()

UseLogFile writes output to stderr and a logFile.

func Warn 

func Warn(message string)

Warn prints a warning message.

func WarnErr 

func WarnErr(err any, message string)

WarnErr prints an error message as a warning.

func WarnErrf 

func WarnErrf(err any, format string, a ...any)

WarnErrf prints an error message as a warning with a given format.

func Warnf 

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

Warnf prints a warning message with a given format.

Types

type DebugWriter 

type DebugWriter struct{}

DebugWriter represents a writer interface that writes to message.Debug

func (*DebugWriter) Write 

func (d *DebugWriter) Write(raw []byte) (int, error)

type Generic 

type Generic struct{}

Generic is used to implement the io.Writer interface for generic messages.

func (*Generic) Write 

func (g *Generic) Write(p []byte) (n int, err error)

type LogLevel 

type LogLevel int

LogLevel is the level of logging to display. 

const (
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel LogLevel = iota
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel

	// TermWidth sets the width of full width elements like progressbars and headers
	TermWidth = 100
)

func GetLogLevel 

func GetLogLevel() LogLevel

GetLogLevel returns the current log level.

type ProgressBar 

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

ProgressBar is a struct used to drive a pterm ProgressbarPrinter.

func NewProgressBar 

func NewProgressBar(total int64, text string) *ProgressBar

NewProgressBar creates a new ProgressBar instance from a total value and a format.

func (*ProgressBar) Add 

func (p *ProgressBar) Add(n int)

Add updates the ProgressBar with completed progress.

func (*ProgressBar) Errorf 

func (p *ProgressBar) Errorf(err error, format string, a ...any)

Errorf marks the ProgressBar as failed in the CLI.

func (*ProgressBar) Stop 

func (p *ProgressBar) Stop()

Stop stops the ProgressBar from continuing.

func (*ProgressBar) Successf 

func (p *ProgressBar) Successf(format string, a ...any)

Successf marks the ProgressBar as successful in the CLI.

func (*ProgressBar) Update 

func (p *ProgressBar) Update(complete int64, text string)

Update updates the ProgressBar with completed progress and new text.

func (*ProgressBar) UpdateTitle 

func (p *ProgressBar) UpdateTitle(text string)

UpdateTitle updates the ProgressBar with new text.

func (*ProgressBar) Write 

func (p *ProgressBar) Write(data []byte) (int, error)

Write updates the ProgressBar with the number of bytes in a buffer as the completed progress.

type Spinner 

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

Spinner is a wrapper around pterm.SpinnerPrinter.

func NewProgressSpinner 

func NewProgressSpinner(format string, a ...any) *Spinner

NewProgressSpinner creates a new progress spinner.

func (*Spinner) DisablePreserveWrites 

func (p *Spinner) DisablePreserveWrites()

DisablePreserveWrites disables preserving writes to the terminal.

func (*Spinner) EnablePreserveWrites 

func (p *Spinner) EnablePreserveWrites()

EnablePreserveWrites enables preserving writes to the terminal.

func (*Spinner) Errorf 

func (p *Spinner) Errorf(err error, format string, a ...any)

Errorf prints an error message with the spinner.

func (*Spinner) Fatal 

func (p *Spinner) Fatal(err error)

Fatal calls message.Fatalf with the given error.

func (*Spinner) Fatalf 

func (p *Spinner) Fatalf(err error, format string, a ...any)

Fatalf calls message.Fatalf with the given error and format.

func (*Spinner) Pause added in v0.4.0 

func (p *Spinner) Pause() string

Pause the spinner.

func (*Spinner) Stop 

func (p *Spinner) Stop()

Stop the spinner.

func (*Spinner) Success 

func (p *Spinner) Success()

Success prints a success message and stops the spinner.

func (*Spinner) Successf 

func (p *Spinner) Successf(format string, a ...any)

Successf prints a success message with the spinner and stops it.

func (*Spinner) Updatef 

func (p *Spinner) Updatef(format string, a ...any)

Updatef updates the spinner text.

func (*Spinner) Warnf 

func (p *Spinner) Warnf(format string, a ...any)

Warnf prints a warning message with the spinner.

func (*Spinner) Write 

func (p *Spinner) Write(raw []byte) (int, error)

Write the given text to the spinner.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.