notify

Documentation

Index

• Constants
• Variables
• func Debugf(format string, args ...any)
• func Errorf(format string, args ...any)
• func Infof(format string, args ...any)
• func IsDebug() bool
• func Print(m Message)
• func PrintBye()
• func PrintHighlighted(what string)
• func PrintKeyValue(b io.Writer, k string, v any)
• func PrintWelcome(version string)
• func Prompt() string
• func RuntimePanic(err error) error
• func SetANSIColorsEnabled(enabled bool)
• func ToggleDebug() bool
• func Warnf(format string, args ...any)
• type ConsoleWriter
  • func (c ConsoleWriter) Errorf(format string, args ...any)
  • func (c ConsoleWriter) Warnf(format string, args ...any)
• type Message
  • func NewError(err error) Message
  • func NewErrorf(format string, args ...any) Message
  • func NewInfof(format string, args ...any) Message
  • func NewWarningf(format string, args ...any) Message
• type Notification
  • func (n Notification) Message() string
  • func (n Notification) Type() int

Constants

const (
	NotifyInfo = iota
	NotifyWarning
	NotifyError
)

Variables

var Console = ConsoleWriter{
	StandardOut:   os.Stdout,
	StandardError: os.Stderr,
}

var Panic = RuntimePanic

var Println = fmt.Println

Println is to inject a function that can report info,error and warning

Functions

func Debugf

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

func Errorf

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

func Infof

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

func IsDebug

func IsDebug() bool

func Print

func Print(m Message)

func PrintBye

func PrintBye()

func PrintHighlighted

func PrintHighlighted(what string)

func PrintKeyValue

func PrintKeyValue(b io.Writer, k string, v any)

func PrintWelcome

func PrintWelcome(version string)

func Prompt

func Prompt() string

func RuntimePanic

func RuntimePanic(err error) error

func SetANSIColorsEnabled

func SetANSIColorsEnabled(enabled bool)

func ToggleDebug

func ToggleDebug() bool

func Warnf

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

Types

type ConsoleWriter

type ConsoleWriter struct {
	StandardOut   io.Writer
	StandardError io.Writer
}

func (ConsoleWriter) Errorf

func (c ConsoleWriter) Errorf(format string, args ...any)

func (ConsoleWriter) Warnf

func (c ConsoleWriter) Warnf(format string, args ...any)

type Message

type Message interface {
	Message() string
	Type() int
}

func NewError

func NewError(err error) Message

func NewErrorf

func NewErrorf(format string, args ...any) Message

func NewInfof

func NewInfof(format string, args ...any) Message

func NewWarningf

func NewWarningf(format string, args ...any) Message

type Notification

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

func (Notification) Message

func (n Notification) Message() string

func (Notification) Type

func (n Notification) Type() int