Merge pull request #18 from thockin/master

Logr 1.1.0 and implement stdr in terms of funcr

example/example_test.go

@@ -0,0 +1,58 @@
+/*
+Copyright 2021 The logr Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+	"errors"
+	"log"
+	"os"
+
+	"github.com/go-logr/stdr"
+)
+
+var errSome = errors.New("some error")
+
+func newStdLogger(flags int) stdr.StdLogger {
+	return log.New(os.Stdout, "", flags)
+}
+
+func ExampleNew() {
+	log := stdr.New(newStdLogger(log.Lshortfile))
+	log.Info("info message with default options")
+	log.Error(errSome, "error message with default options")
+	log.Info("invalid key", 42, "answer")
+	log.Info("missing value", "answer")
+	// Output:
+	// example_test.go:35: "level"=0 "msg"="info message with default options"
+	// example_test.go:36: "msg"="error message with default options" "error"="some error"
+	// example_test.go:37: "level"=0 "msg"="invalid key" "<non-string-key-2>"="answer"
+	// example_test.go:38: "level"=0 "msg"="missing value" "answer"="<no-value>"
+}
+
+func ExampleNew_withName() {
+	log := stdr.New(newStdLogger(0))
+	log.WithName("hello").WithName("world").Info("thanks for the fish")
+	// Output:
+	// hello/world: "level"=0 "msg"="thanks for the fish"
+}
+
+func ExampleNewWithOptions() {
+	log := stdr.NewWithOptions(newStdLogger(0), stdr.Options{LogCaller: stdr.All})
+	log.Info("with LogCaller=All")
+	// Output:
+	// "caller"={"file":"example_test.go","line":55} "level"=0 "msg"="with LogCaller=All"
+}

go.mod

@@ -2,4 +2,4 @@ module github.com/go-logr/stdr
 
 go 1.16
 
-require github.com/go-logr/logr v1.0.0
+require github.com/go-logr/logr v1.1.0

go.sum

@@ -1,2 +1,2 @@
-github.com/go-logr/logr v1.0.0 h1:kH951GinvFVaQgy/ki/B3YYmQtRpExGigSJg6O8z5jo=
-github.com/go-logr/logr v1.0.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/go-logr/logr v1.1.0 h1:nAbevmWlS2Ic4m4+/An5NXkaGqlqpbBgdcuThZxnZyI=
+github.com/go-logr/logr v1.1.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=