Initial commit

ammario · ammario · commit 800ac575032f · 2018-12-21T16:20:52.000-06:00
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# flog
+
+`flog` is a minimal, formatted, pretty logging package for Go.
+
+It's primarily for command line tools, and it's optimized for human readability.
+
+[Uber's Zap](https://github.com/uber-go/zap) is recommended for most robust logging.
+
+## Install
+
+`go get go.coder.com/flog`
+
+## Usage
+
+```go
+flog.Log(flog.INFO, "hello %.3f", 1/3.0)
+flog.Log(flog.SUCCESS, "finished that")
+flog.Log(flog.ERROR, "oops")
+
+log := flog.New().WithPrefix("user %v: ", 500)
+
+log.Log(flog.ERROR, "didn't work out")
+```
+
+produces
+
+![example](docs/usage.png)
+
+
diff --git a/docs/usage.png b/docs/usage.png
diff --git a/go.mod b/go.mod
@@ -0,0 +1,7 @@
+module go.coder.com/flog
+
+require (
+	github.com/fatih/color v1.7.0
+	github.com/mattn/go-colorable v0.0.9 // indirect
+	github.com/mattn/go-isatty v0.0.4 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,5 @@
+github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
+github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
+github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
+github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
+github.com/mattn/go-isatty v0.0.4/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
diff --git a/log.go b/log.go
@@ -0,0 +1,52 @@
+package flog
+
+import (
+	"fmt"
+	"github.com/fatih/color"
+	"io"
+	"os"
+	"time"
+)
+
+type Level string
+
+var (
+	INFO    = Level(color.HiBlueString("INFO"))
+	SUCCESS = Level(color.HiGreenString("SUCCESS"))
+	ERROR   = Level(color.RedString("ERROR"))
+	FATAL   = Level(color.RedString("FATAL"))
+)
+
+type Logger struct {
+	W      io.Writer
+	Prefix string
+}
+
+func (l *Logger) WithPrefix(p string, args ...interface{}) *Logger {
+	ll := *l
+	ll.Prefix += fmt.Sprintf(p, args...)
+	return &ll
+}
+
+func (l *Logger) Log(lvl Level, msg string, args ...interface{}) {
+	fmt.Fprintf(
+		l.W,
+		fmt.Sprintf("%v %v\t", time.Now().Format(`2006-01-02 15:04:05`), lvl)+
+			l.Prefix + msg+"\n", args...,
+	)
+	if lvl == FATAL {
+		os.Exit(1)
+	}
+}
+
+// New returns a new logger.
+func New() *Logger {
+	return &Logger{
+		W: os.Stderr,
+	}
+}
+
+// Log logs a message with the default logger.
+func Log(l Level, m string, args ...interface{}) {
+	New().Log(l, m, args...)
+}
diff --git a/log_test.go b/log_test.go
@@ -0,0 +1,16 @@
+package flog_test
+
+import (
+	"go.coder.com/flog"
+	"testing"
+)
+
+func TestLogger(t *testing.T) {
+	flog.Log(flog.INFO, "hello %.3f", 1/3.0)
+	flog.Log(flog.SUCCESS, "finished that")
+	flog.Log(flog.ERROR, "oops")
+
+	log := flog.New().WithPrefix("user %v: ", 500)
+
+	log.Log(flog.ERROR, "didn't work out")
+}
