log

Documentation

Overview

Package log provides context-aware logging for wt.

Index

• func WithLogger(ctx context.Context, l *Logger) context.Context
• type Logger
  • func FromContext(ctx context.Context) *Logger
  • func New(out io.Writer, verbose, quiet bool) *Logger
  • func (l *Logger) Command(dir, name string, args ...string) func(time.Duration)
  • func (l *Logger) Debug(msg string, keyvals ...any)
  • func (l *Logger) IsVerbose() bool
  • func (l *Logger) Printf(format string, args ...any)
  • func (l *Logger) Println(args ...any)
  • func (l *Logger) Writer() io.Writer

Functions

func WithLogger

func WithLogger(ctx context.Context, l *Logger) context.Context

WithLogger attaches a logger to the context.

Types

type Logger

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

Logger provides output and verbose command logging.

func FromContext

func FromContext(ctx context.Context) *Logger

FromContext retrieves the logger from context. Returns a no-op logger if none is attached.

func New

func New(out io.Writer, verbose, quiet bool) *Logger

New creates a new logger.

func (*Logger) Command

func (l *Logger) Command(dir, name string, args ...string) func(time.Duration)

Command returns a function that logs an external command execution with duration. Call the returned function after the command completes. Only prints when verbose mode is enabled and quiet mode is disabled. If dir is non-empty, it's shown as a prefix: [dir] $ cmd args (duration)

func (*Logger) Debug

func (l *Logger) Debug(msg string, keyvals ...any)

Debug logs a debug message with key-value pairs. Only prints when verbose mode is enabled and quiet mode is disabled.

func (*Logger) IsVerbose

func (l *Logger) IsVerbose() bool

IsVerbose returns true if the logger is in verbose mode (and not quiet).

func (*Logger) Printf

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

Printf writes formatted output.

func (*Logger) Println

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

Println writes a line of output.

func (*Logger) Writer

func (l *Logger) Writer() io.Writer

Writer returns the underlying writer.