ref(log): use log options to initialize new loggers

- remove interface
- remove functional options
- add options struct

context.go

@@ -3,18 +3,15 @@ package log
 import "context"
 
 // WithContext wraps the given logger in context.
-func WithContext(ctx context.Context, logger Logger, keyvals ...interface{}) context.Context {
- if len(keyvals) > 0 {
- logger = logger.With(keyvals...)
- }
+func WithContext(ctx context.Context, logger *Logger) context.Context {
  return context.WithValue(ctx, loggerContextKey, logger)
 }
 
 // FromContext returns the logger from the given context.
 // This will return the default package logger if no logger
 // found in context.
-func FromContext(ctx context.Context) Logger {
- if logger, ok := ctx.Value(loggerContextKey).(Logger); ok {
+func FromContext(ctx context.Context) *Logger {
+ if logger, ok := ctx.Value(loggerContextKey).(*Logger); ok {
  return logger
  }
  return defaultLogger

context_test.go

@@ -3,6 +3,7 @@ package log
 import (
  "bytes"
  "context"
+ "io/ioutil"
  "testing"
 
  "github.com/stretchr/testify/require"
@@ -13,15 +14,16 @@ func TestLogContext_empty(t *testing.T) {
 }
 
 func TestLogContext_simple(t *testing.T) {
- l := New()
+ l := New(ioutil.Discard)
  ctx := WithContext(context.Background(), l)
  require.Equal(t, l, FromContext(ctx))
 }
 
 func TestLogContext_fields(t *testing.T) {
  var buf bytes.Buffer
- l := New(WithOutput(&buf), WithLevel(DebugLevel))
- ctx := WithContext(context.Background(), l, "foo", "bar")
+ l := New(&buf)
+ l.SetLevel(DebugLevel)
+ ctx := WithContext(context.Background(), l.With("foo", "bar"))
  l = FromContext(ctx)
  require.NotNil(t, l)
  l.Debug("test")

examples/batch2/batch2.go

@@ -1,14 +1,12 @@
 package main
 
 import (
- "time"
-
  "github.com/charmbracelet/log"
 )
 
 func main() {
- logger := log.New(log.WithTimestamp(), log.WithTimeFormat(time.Kitchen),
-  log.WithCaller(), log.WithPrefix("baking 🍪 ")).With("batch", 2, "chocolateChips", true)
+ logger := log.Default().With("batch", 2, "chocolateChips", true)
+ logger.SetPrefix("baking 🍪 ")
  logger.SetReportTimestamp(false)
  logger.SetReportCaller(false)
  logger.SetLevel(log.DebugLevel)

examples/chocolate-chips/chocolate-chips.go

@@ -1,15 +1,13 @@
 package main
 
 import (
- "time"
-
  "github.com/charmbracelet/log"
 )
 
 func main() {
- logger := log.New(log.WithTimestamp(), log.WithTimeFormat(time.Kitchen),
- log.WithCaller(), log.WithPrefix("Baking 🍪 "))
+ logger := log.Default().With()
 
+ logger.SetPrefix("Baking 🍪 ")
  logger.SetReportTimestamp(false)
  logger.SetReportCaller(false)
  logger.SetLevel(log.DebugLevel)

examples/new/new.go

@@ -1,8 +1,12 @@
 package main
 
-import "github.com/charmbracelet/log"
+import (
+ "os"
+
+ "github.com/charmbracelet/log"
+)
 
 func main() {
- logger := log.New()
+ logger := log.New(os.Stderr)
  logger.Warn("chewy!", "butter", true)
 }

examples/options/options.go

@@ -1,14 +1,18 @@
 package main
 
 import (
+ "os"
  "time"
 
  "github.com/charmbracelet/log"
 )
 
 func main() {
- logger := log.New(log.WithTimestamp(), log.WithTimeFormat(time.Kitchen),
- log.WithCaller(), log.WithPrefix("Baking 🍪 "))
+ logger := log.New(os.Stderr)
+ logger.SetPrefix("Baking 🍪 ")
+ logger.SetTimeFormat(time.Kitchen)
+ logger.SetReportTimestamp(true)
+ logger.SetReportCaller(true)
  logger.Info("Starting oven!", "degree", 375)
  time.Sleep(3 * time.Second)
  logger.Info("Finished baking")

examples/styles/styles.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+ "os"
  "time"
 
  "github.com/charmbracelet/lipgloss"
@@ -18,7 +19,7 @@ func main() {
  Foreground(lipgloss.Color("0"))
  log.KeyStyles["err"] = lipgloss.NewStyle().Foreground(lipgloss.Color("204"))
  log.ValueStyles["err"] = lipgloss.NewStyle().Bold(true)
- logger := log.New()
+ logger := log.New(os.Stderr)
  logger.Error("Whoops!", "err", "kitchen on fire")
  time.Sleep(3 * time.Second)
 }

json.go

@@ -6,7 +6,7 @@ import (
  "time"
 )
 
-func (l *logger) jsonFormatter(keyvals ...interface{}) {
+func (l *Logger) jsonFormatter(keyvals ...interface{}) {
  m := make(map[string]interface{}, len(keyvals)/2)
  for i := 0; i < len(keyvals); i += 2 {
  switch keyvals[i] {

json_test.go

@@ -13,7 +13,8 @@ import (
 
 func TestJson(t *testing.T) {
  var buf bytes.Buffer
- l := New(WithOutput(&buf), WithFormatter(JSONFormatter))
+ l := New(&buf)
+ l.SetFormatter(JSONFormatter)
  cases := []struct {
  name string
  expected string
@@ -124,8 +125,10 @@ func TestJson(t *testing.T) {
 
 func TestJsonCaller(t *testing.T) {
  var buf bytes.Buffer
- l := New(WithOutput(&buf), WithLevel(DebugLevel),
- WithFormatter(JSONFormatter), WithCaller())
+ l := New(&buf)
+ l.SetFormatter(JSONFormatter)
+ l.SetReportCaller(true)
+ l.SetLevel(DebugLevel)
  _, file, line, _ := runtime.Caller(0)
  cases := []struct {
  name string
@@ -169,8 +172,10 @@ func TestJsonCustomKey(t *testing.T) {
  TimestampKey = oldTsKey
  }()
  TimestampKey = "time"
- logger := New(WithOutput(&buf), WithTimestamp(),
- WithTimeFunction(_zeroTime), WithFormatter(JSONFormatter))
+ logger := New(&buf)
+ logger.SetTimeFunction(_zeroTime)
+ logger.SetFormatter(JSONFormatter)
+ logger.SetReportTimestamp(true)
  logger.Info("info")
  require.Equal(t, "{\"lvl\":\"info\",\"msg\":\"info\",\"time\":\"0001/01/01 00:00:00\"}\n", buf.String())
 }