README
¶
termlog: Logging for interactive terminals
Basic usage
l := termlog.NewLog()
l.Say("Log")
l.Notice("Notice!")
l.Warn("Warn!")
l.Shout("Error!")
Each log entry gets a timestamp.
Groups
Groups collect entries together under a single timestamp, with subsequent lines indented:
g = l.Group()
g.Say("This line gets a timestamp")
g.Say("This line will be indented with no timestamp")
g.Done()
Groups produce no output until the .Done() method is called - a good use for defer. Termlog ensures that all grouped entries appear together in output.
Streams
Streams associate log entries with a header. New stream log entries only get a header if another log source (i.e. a different stream, group, or plain log) has produced output in the meantime. Each stream log entry gets its own timestamp.
g = l.Stream("This is the header")
g.Say("The header will be printed before this line")
g.Say("But not before this one")
g.Done()
Named logs
Log entries can be named using the *As methods:
l := termlog.NewLog()
l.Say("hello")
l.SayAs("debug", "Some debugging info")
Named entries are always silenced, unless they've been enabled specifically, like so:
l.Enable("debug")
Specified colors
The package is compatible with the color specifications from github.com/fatih/color, which means that colors can be composed like this:
l.Say("Here are some composed colors...")
l.Say(
"%s %s %s",
color.RedString("red"),
color.GreenString("green"),
color.BlueString("blue"),
)
Documentation
¶
Overview ¶
Package termlog provides facilities for logging to a terminal geared towards interactive use.
Index ¶
- Variables
- func NewContext(ctx context.Context, logger Logger) context.Context
- func SetOutput(w io.Writer)
- type Group
- type Log
- func (*Log) Color(state bool)
- func (l *Log) Enable(name string)
- func (l *Log) Group() Group
- func (l *Log) Notice(format string, args ...interface{})
- func (l *Log) NoticeAs(name string, format string, args ...interface{})
- func (l *Log) Quiet()
- func (l *Log) Say(format string, args ...interface{})
- func (l *Log) SayAs(name string, format string, args ...interface{})
- func (l *Log) Shout(format string, args ...interface{})
- func (l *Log) ShoutAs(name string, format string, args ...interface{})
- func (l *Log) Stream(header string) Stream
- func (l *Log) Warn(format string, args ...interface{})
- func (l *Log) WarnAs(name string, format string, args ...interface{})
- type LogTest
- type Logger
- type Palette
- type Stream
- type TermLog
Constants ¶
This section is empty.
Variables ¶
var DefaultPalette = Palette{ Say: color.New(), Notice: color.New(color.FgBlue), Warn: color.New(color.FgYellow), Shout: color.New(color.FgRed), Timestamp: color.New(color.FgCyan), Header: color.New(color.FgBlue), }
DefaultPalette is a sensbile default palette, with the following foreground colours:
Say: Terminal default Notice: Blue Warn: Yellow Shout: Red Timestamp: Cyan
Functions ¶
func NewContext ¶
NewContext creates a new context with an included Logger
Types ¶
type Group ¶
type Group interface {
Logger
Done()
Quiet()
}
Group is a collected group of log entries. Logs are only displayed once the Done method is called.
type Log ¶
Log is the top-level log structure
func NewLog ¶
func NewLog() *Log
NewLog creates a new Log instance and initialises it with a set of defaults.
type LogTest ¶
type LogTest struct {
Log *Log
// contains filtered or unexported fields
}
LogTest lets test suites work with log output
type Logger ¶
type Logger interface {
Say(format string, args ...interface{})
Notice(format string, args ...interface{})
Warn(format string, args ...interface{})
Shout(format string, args ...interface{})
SayAs(name string, format string, args ...interface{})
NoticeAs(name string, format string, args ...interface{})
WarnAs(name string, format string, args ...interface{})
ShoutAs(name string, format string, args ...interface{})
}
Logger logs things
func FromContext ¶
FromContext retrieves a Logger from a context. If no logger is present, we return a new silenced logger that will produce no output.
type Palette ¶
type Palette struct {
Timestamp *color.Color
Say *color.Color
Notice *color.Color
Warn *color.Color
Shout *color.Color
Header *color.Color
}
Palette defines the colour of output
Source Files
Directories