logger

package

v2.1.7 Latest Latest Go to latest Published: May 19, 2026 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/evilmartians/lefthook

Links

Open Source Insights

Documentation ¶

Index ¶

type Builder
- func NewBuilder(logger logger) *Builder
type Color
type ColorsSetting
type ExecutionLogger
type ExecutionSetting
type ExecutionSettings
- func NewExecutionSettings() *ExecutionSettings
type Level
type Logger
- func New(out io.Writer) *Logger
type Spinner
- func NewSpinner() *Spinner

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Builder ¶

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

Builder introduces a way to build a multiline log message and print it at once.

func NewBuilder ¶

func NewBuilder(logger logger) *Builder

func (*Builder) Log ¶

func (b *Builder) Log()

func (*Builder) WithLevel ¶

func (b *Builder) WithLevel(level Level) *Builder

func (*Builder) WithPrefix ¶

func (b *Builder) WithPrefix(prefix string) *Builder

func (*Builder) WriteLines ¶

func (b *Builder) WriteLines(prefix string, out any) *Builder

type Color ¶

type Color uint8

const (
	ColorWhite Color = iota
	ColorCyan
	ColorGray
	ColorGreen
	ColorRed
	ColorYellow
)

type ColorsSetting ¶

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

var DefaultColors ColorsSetting = ColorsSetting{
	// contains filtered or unexported fields
}

var NoColors ColorsSetting = ColorsSetting{
	// contains filtered or unexported fields
}

type ExecutionLogger ¶

type ExecutionLogger struct {
	// Inherit all Logger methods
	*Logger
	// contains filtered or unexported fields
}

ExecutionLogger wraps the Logger but also provides additional methods for logging execution with predefined style to simplify the caller side.

func (*ExecutionLogger) Enabled ¶

func (el *ExecutionLogger) Enabled(setting ExecutionSetting) bool

func (*ExecutionLogger) LogExecution ¶

func (el *ExecutionLogger) LogExecution(name string, err error, out io.Reader)

func (*ExecutionLogger) LogFailure ¶

func (el *ExecutionLogger) LogFailure(indent int, name, failText string, duration time.Duration)

func (*ExecutionLogger) LogMeta ¶

func (el *ExecutionLogger) LogMeta(hookName string)

func (*ExecutionLogger) LogSeparator ¶

func (el *ExecutionLogger) LogSeparator()

func (*ExecutionLogger) LogSetup ¶

func (el *ExecutionLogger) LogSetup(r io.Reader)

func (*ExecutionLogger) LogSkipped ¶

func (el *ExecutionLogger) LogSkipped(name, reason string)

func (*ExecutionLogger) LogSuccess ¶

func (el *ExecutionLogger) LogSuccess(indent int, name string, duration time.Duration)

type ExecutionSetting ¶

type ExecutionSetting = ExecutionSettings

type ExecutionSettings ¶

type ExecutionSettings int16

const (
	LogMeta            ExecutionSettings = 1 << iota // meta
	LogSuccess                                       // success
	LogFailure                                       // failure
	LogSummary                                       // summary
	LogEmptySummary                                  // empty_summary
	LogSkips                                         // skips
	LogExecution                                     // execution
	LogExecutionOutput                               // execution_output
	LogExecutionInfo                                 // execution_info
	LogSetup                                         // setup

)

func NewExecutionSettings ¶

func NewExecutionSettings() *ExecutionSettings

type Level ¶

type Level uint8

const (
	LevelError Level = iota
	LevelWarn
	LevelInfo
	LevelDebug
)

type Logger ¶

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

func New ¶

func New(out io.Writer) *Logger

func (*Logger) Debug ¶

func (l *Logger) Debug(args ...any)

func (*Logger) Debugf ¶

func (l *Logger) Debugf(format string, args ...any)

func (*Logger) DisableColors ¶

func (l *Logger) DisableColors()

func (*Logger) EnableColors ¶

func (l *Logger) EnableColors()

func (*Logger) Error ¶

func (l *Logger) Error(args ...any)

func (*Logger) Errorf ¶

func (l *Logger) Errorf(format string, args ...any)

func (*Logger) Info ¶

func (l *Logger) Info(args ...any)

func (*Logger) Infof ¶

func (l *Logger) Infof(format string, args ...any)

func (*Logger) NewExecutionLogger ¶

func (l *Logger) NewExecutionLogger(configs ...any) *ExecutionLogger

func (*Logger) NoColors ¶

func (l *Logger) NoColors() bool

func (*Logger) Paint ¶

func (l *Logger) Paint(color Color, s string) string

func (*Logger) SetColors ¶

func (l *Logger) SetColors(colors map[Color]color.Color)

func (*Logger) SetLevel ¶

func (l *Logger) SetLevel(level Level)

func (*Logger) Warn ¶

func (l *Logger) Warn(args ...any)

func (*Logger) Warnf ¶

func (l *Logger) Warnf(format string, args ...any)

type Spinner ¶

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

func NewSpinner ¶

func NewSpinner() *Spinner

func (*Spinner) AddName ¶

func (s *Spinner) AddName(name string)

func (*Spinner) RemoveName ¶

func (s *Spinner) RemoveName(nameToRemove string)

func (*Spinner) Start ¶

func (s *Spinner) Start()

func (*Spinner) Stop ¶

func (s *Spinner) Stop()

Source Files ¶

View all Source files

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