zlog - remove zap

cmd/clutter/cmd_resolve.go

@@ -5,11 +5,11 @@ import (
 	"os"
 
 	cli "github.com/urfave/cli/v2"
-	"go.uber.org/zap"
 
 	"github.com/cluttercode/clutter/internal/pkg/index"
 	"github.com/cluttercode/clutter/internal/pkg/resolver"
 	"github.com/cluttercode/clutter/internal/pkg/scanner"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
 var (
@@ -163,7 +163,7 @@ var (
 
 			z.Info("resolved tag")
 
-			r := func(z *zap.SugaredLogger, what *index.Entry, idx *index.Index, _ bool) ([]*index.Entry, error) {
+			r := func(z *zlog.Logger, what *index.Entry, idx *index.Index, _ bool) ([]*index.Entry, error) {
 				return resolver.ResolveList(z, what, idx)
 			}
 

cmd/clutter/log.go

@@ -1,42 +1,22 @@
 package main
 
 import (
-	"fmt"
-	"time"
-
-	"go.uber.org/zap"
-	"go.uber.org/zap/zapcore"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
-var z *zap.SugaredLogger = zap.NewNop().Sugar()
+var z *zlog.Logger = zlog.NewNopLogger()
 
 func initLogger(level string, color bool) error {
-	zcfg := zap.NewDevelopmentConfig()
-
-	zcfg.DisableStacktrace = true
-
-	zcfg.EncoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder
-	if !color {
-		zcfg.EncoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
-	}
-
-	zcfg.EncoderConfig.EncodeTime = func(time.Time, zapcore.PrimitiveArrayEncoder) {}
+	b := zlog.NewDefaultBackend()
 
-	if level != "debug" {
-		zcfg.EncoderConfig.EncodeDuration = nil
-		zcfg.EncoderConfig.EncodeCaller = nil
-	}
-
-	if err := zcfg.Level.UnmarshalText([]byte(level)); err != nil {
-		return fmt.Errorf(`invalid log level "%s": %w`, level, err)
-	}
-
-	zz, err := zcfg.Build(zap.AddCaller())
+	lvl, err := zlog.ParseLevelString(level)
 	if err != nil {
-		return fmt.Errorf("failed initializing log: %w", err)
+		return err
 	}
 
-	z = zz.Sugar()
+	b.Level = lvl
+
+	z = &zlog.Logger{Backend: b}
 
 	return nil
 }

go.mod

@@ -4,10 +4,9 @@ go 1.15
 
 require (
 	github.com/fsnotify/fsnotify v1.4.9
-	github.com/stretchr/testify v1.7.0
+	github.com/kr/pretty v0.2.1 // indirect
 	github.com/urfave/cli/v2 v2.3.0
-	go.uber.org/zap v1.16.0
 	golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78 // indirect
-	golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5
+	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 	gopkg.in/yaml.v2 v2.4.0
 )

go.sum

@@ -1,73 +1,27 @@
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
 github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
-github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
-github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
-github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
-github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
-github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
 github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
-github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M=
 github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI=
-go.uber.org/atomic v1.6.0 h1:Ezj3JGmsOnG1MoRWQkPBsKLe9DwWD9QeXzTRzzldNVk=
-go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
-go.uber.org/multierr v1.5.0 h1:KCa4XfM8CWFCpxXRGok+Q0SS/0XBhMDbHHGABQLvD2A=
-go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee h1:0mgffUl7nfd+FpvXMVz4IDEaUSmT1ysygQC7qYo7sG4=
-go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA=
-go.uber.org/zap v1.16.0 h1:uFRZXykJGK9lLY4HtgSw44DnIcAM+kRBP7x5m+NpAOM=
-go.uber.org/zap v1.16.0/go.mod h1:MA8QOfq0BHJwdXa996Y4dYkAqRKB8/1K1QMMZVaNZjQ=
-golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de h1:5hukYrvBGR8/eNkX5mdUezrA6JiaEZDtJb9Ei+1LlBs=
-golang.org/x/lint v0.0.0-20190930215403-16217165b5de/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
-golang.org/x/mod v0.0.0-20190513183733-4bf6d317e70e/go.mod h1:mXi4GBBbnImb6dmsKGUJ2LatrhH/nqhxcFungHvyanc=
-golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
-golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78 h1:nVuTkr9L6Bq62qpUqKo/RnZCFfzDBL0bYo6w9OJUqZY=
 golang.org/x/sys v0.0.0-20210113181707-4bcb84eeeb78/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
-golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
-golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5 h1:hKsoRgsbwY1NafxrwTs+k64bikrLBkAgPir1TNCj3Zs=
-golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
-golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
-gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-honnef.co/go/tools v0.0.1-2019.2.3 h1:3JgtbtFHMiCmsznwGVTUWbgGov+pVqnlf1dEJTNAXeM=
-honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=

internal/pkg/linter/linter.go

@@ -8,10 +8,10 @@ import (
 	"regexp"
 	"strings"
 
-	"go.uber.org/zap"
-
 	"github.com/cluttercode/clutter/internal/pkg/index"
+
 	"github.com/cluttercode/clutter/pkg/strmatcher"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
 type internalRule struct {
@@ -20,7 +20,7 @@ type internalRule struct {
 }
 
 type Linter struct {
-	z *zap.SugaredLogger
+	z *zlog.Logger
 
 	config Config
 
@@ -79,7 +79,7 @@ func (ir *internalRule) init(l *Linter, r Rule) error {
 	return nil
 }
 
-func NewLinter(z *zap.SugaredLogger, cfg Config) (*Linter, error) {
+func NewLinter(z *zlog.Logger, cfg Config) (*Linter, error) {
 	l := &Linter{
 		z:      z,
 		config: cfg,

internal/pkg/parser/parser_test.go

@@ -1,10 +1,9 @@
 package parser
 
 import (
+	"reflect"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
-
 	"github.com/cluttercode/clutter/internal/pkg/scanner"
 )
 
@@ -206,19 +205,31 @@ func TestParseElement(t *testing.T) {
 			)
 
 			if test.err {
-				assert.Error(t, err)
+				if err == nil {
+					t.Errorf("error expected, but got nil")
+				}
+
 				return
 			}
 
-			if !assert.NoError(t, err) {
+			if err != nil {
+				t.Errorf("got error: %v", err)
 				return
 			}
 
-			assert.Equal(t, test.name, ent.Name)
-			assert.EqualValues(t, test.attrs, ent.Attrs)
+			if test.name != ent.Name {
+				t.Errorf("name: %q != %q", test.name, ent.Name)
+			}
+
+			if reflect.DeepEqual(test.attrs, ent.Attrs) {
+				t.Errorf("attrs: %v != %v", test.attrs, ent.Attrs)
+			}
 
 			_, s := ent.IsSearch()
-			assert.Equal(t, test.search, s)
+
+			if test.search != s {
+				t.Errorf("search: %v != %v", test.search, s)
+			}
 		})
 	}
 }

internal/pkg/resolver/resolver.go

@@ -3,26 +3,26 @@ package resolver
 import (
 	"fmt"
 
-	"go.uber.org/zap"
+	"github.com/cluttercode/clutter/pkg/zlog"
 
 	"github.com/cluttercode/clutter/internal/pkg/index"
 )
 
 type params struct{ next, prev, cycle, first, last bool }
 
-func ResolveList(z *zap.SugaredLogger, what *index.Entry, idx *index.Index) ([]*index.Entry, error) {
+func ResolveList(z *zlog.Logger, what *index.Entry, idx *index.Index) ([]*index.Entry, error) {
 	return resolve(z, what, idx, params{})
 }
 
-func ResolveNext(z *zap.SugaredLogger, what *index.Entry, idx *index.Index, cycle bool) ([]*index.Entry, error) {
+func ResolveNext(z *zlog.Logger, what *index.Entry, idx *index.Index, cycle bool) ([]*index.Entry, error) {
 	return resolve(z, what, idx, params{next: true, cycle: cycle})
 }
 
-func ResolvePrev(z *zap.SugaredLogger, what *index.Entry, idx *index.Index, cycle bool) ([]*index.Entry, error) {
+func ResolvePrev(z *zlog.Logger, what *index.Entry, idx *index.Index, cycle bool) ([]*index.Entry, error) {
 	return resolve(z, what, idx, params{prev: true, cycle: cycle})
 }
 
-func resolve(z *zap.SugaredLogger, what *index.Entry, idx *index.Index, p params) ([]*index.Entry, error) {
+func resolve(z *zlog.Logger, what *index.Entry, idx *index.Index, p params) ([]*index.Entry, error) {
 	if p.next && p.prev {
 		z.Panic("prev and next are mutually exclusive")
 	}

internal/pkg/scanner/filter.go

@@ -5,16 +5,15 @@ import (
 	"path/filepath"
 	"strings"
 
-	"go.uber.org/zap"
-
 	"github.com/cluttercode/clutter/pkg/gitignore"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
 var defaultIgnores = []string{
 	".git",
 }
 
-func NewFilter(z *zap.SugaredLogger, cfg Config) (func(string, os.FileInfo) (bool, error), error) {
+func NewFilter(z *zlog.Logger, cfg Config) (func(string, os.FileInfo) (bool, error), error) {
 	if len(cfg.Ignore) == 0 {
 		cfg.Ignore = defaultIgnores
 	}

internal/pkg/scanner/scan.go

@@ -5,14 +5,31 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"unicode/utf8"
 
-	"golang.org/x/tools/godoc/util"
-
-	"go.uber.org/zap"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
+func isText(s []byte) bool {
+	const max = 1024 // at least utf8.UTFMax
+	if len(s) > max {
+		s = s[0:max]
+	}
+	for i, c := range string(s) {
+		if i+utf8.UTFMax > len(s) {
+			// last char may be incomplete - ignore
+			break
+		}
+		if c == 0xFFFD || c < ' ' && c != '\n' && c != '\t' && c != '\f' {
+			// decoding error or control character - not a text file
+			return false
+		}
+	}
+	return true
+}
+
 func ScanFile(
-	z *zap.SugaredLogger,
+	z *zlog.Logger,
 	cfg BracketConfig,
 	path string,
 	f func(*RawElement) error,
@@ -37,7 +54,7 @@ func ScanFile(
 		return fmt.Errorf("read: %w", err)
 	}
 
-	if !util.IsText(buf[:n]) {
+	if !isText(buf[:n]) {
 		z.Debug("not a text file, ignoring")
 		return nil
 	}

internal/pkg/scanner/scan_raw.go

@@ -6,11 +6,11 @@ import (
 	"io"
 	"strings"
 
-	"go.uber.org/zap"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
 func ScanRawReader(
-	z *zap.SugaredLogger,
+	z *zlog.Logger,
 	cfg BracketConfig,
 	r io.Reader,
 	f func(*RawElement) error, // will not include path. path is filled in [# ./fill-path #].

internal/pkg/scanner/scan_sitter.go

@@ -4,11 +4,11 @@ import (
 	"fmt"
 	"io"
 
-	"go.uber.org/zap"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
 func ScanSitterReader(
-	z *zap.SugaredLogger,
+	z *zlog.Logger,
 	cfg BracketConfig,
 	r io.Reader,
 	f func(*RawElement) error, // will not include path. path is filled in [# ./fill-path #].

internal/pkg/scanner/scanner.go

@@ -5,10 +5,10 @@ import (
 	"os"
 	"path/filepath"
 
-	"go.uber.org/zap"
+	"github.com/cluttercode/clutter/pkg/zlog"
 )
 
-func NewScanner(z *zap.SugaredLogger, cfg Config) (func(root string, f func(*RawElement) error) ([]*RawElement, error), error) {
+func NewScanner(z *zlog.Logger, cfg Config) (func(root string, f func(*RawElement) error) ([]*RawElement, error), error) {
 	filter, err := NewFilter(z, cfg)
 	if err != nil {
 		return nil, err

pkg/zlog/backend.go

@@ -0,0 +1,7 @@
+package zlog
+
+type Backend interface {
+	Report(Level, string, []Pair)
+	Named(string) Backend
+	With([]Pair) Backend
+}