README
¶
cmdlog
cmdlog implements colored leveled logging for command line tools.
cmdlog supports arbitrary randomly colored prefixes just like
terrastruct/ci.
l := cmdlog.New(xos.NewEnv(os.Environ()), os.Stderr)
l = l.WithCCPrefix("lochness")
l = l.WithCCPrefix("imgbundler")
l = l.WithCCPrefix("cache")
l.NoLevel.Println("Somehow, the world always affects you more than you affect it.")
l.SetDebug(true)
l.Debug.Println("Man is a rational animal who always loses his temper when he is called upon.")
l.SetDebug(false)
l.Debug.Println("You can never trust a woman; she may be true to you.")
l.SetTS(true)
l.Success.Println("An alcoholic is someone you don't like who drinks as much as you do.")
l.Info.Println("There once was this swami who lived above a delicatessan.")
l.SetTSFormat(time.UnixDate)
l.Warn.Println("Telephone books are like dictionaries -- if you know the answer before.")
l.SetTS(false)
l.Error.Println("Nothing can be done in one trip.")
Output is the screenshot above. You can run the example yourself. It's in ./example/main.go.
See ./cmdlog_test.go for further usage.
You can log in tests with NewTB.
You may also find the ./xterm package useful for outputting formatted text to the terminal.
$COLORis obeyed to force enable/disable colored output.$DEBUGis obeyed to enable/disable debug logs.
Install
go get oss.terrastruct.com/cmdlog@latest
Documentation
¶
Overview ¶
Package cmdlog implements color leveled logging for command line tools.
Index ¶
- type Logger
- func (l *Logger) GetDebug() bool
- func (l *Logger) GetTS() bool
- func (l *Logger) GetTSFormat() string
- func (l *Logger) SetDebug(enabled bool)
- func (l *Logger) SetTS(enabled bool)
- func (l *Logger) SetTSFormat(tsfmt string)
- func (l *Logger) WithCCPrefix(s string) *Logger
- func (l *Logger) WithPrefix(caps, s string) *Logger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Logger ¶
type Logger struct {
NoLevel *log.Logger
Debug *log.Logger
Success *log.Logger
Info *log.Logger
Warn *log.Logger
Error *log.Logger
// contains filtered or unexported fields
}
func (*Logger) GetTSFormat ¶
func (*Logger) SetTSFormat ¶
func (*Logger) WithCCPrefix ¶
func (*Logger) WithPrefix ¶
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.