Skip to content

Commit aa4a24b

Browse files
committed
re-enable kitlog and zap by default
Signed-off-by: Timon Wong <[email protected]>
1 parent a492c92 commit aa4a24b

File tree

7 files changed

+23
-41
lines changed

7 files changed

+23
-41
lines changed

.golangci.reference.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,19 +1113,19 @@ linters-settings:
11131113

11141114
loggercheck:
11151115
# Allow check for the github.com/go-kit/log library.
1116-
# Default: false
1117-
kitlog: true
1116+
# Default: true
1117+
kitlog: false
11181118
# Allow check for the k8s.io/klog/v2 library.
11191119
# Default: true
11201120
klog: false
11211121
# Allow check for the github.com/go-logr/logr library.
11221122
# Default: true
11231123
logr: false
11241124
# Allow check for the "sugar logger" from go.uber.org/zap library.
1125-
# Default: false
1126-
zap: true
1125+
# Default: true
1126+
zap: false
11271127
# Require all logging keys to be inlined constant strings
1128-
# Default false
1128+
# Default: false
11291129
require-string-key: true
11301130
# List of custom rules to check against, where each rule is a single logger pattern.
11311131
# Default: empty

pkg/config/linters_settings.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ var defaultLintersSettings = LintersSettings{
6767
TabWidth: 1,
6868
},
6969
LoggerCheck: LoggerCheckSettings{
70-
Logr: true,
70+
Kitlog: true,
7171
Klog: true,
72-
Zap: false,
72+
Logr: true,
73+
Zap: true,
7374
RequireStringKey: false,
7475
Rules: nil,
7576
},

test/testdata/loggercheck/configs/loggercheck_all.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

test/testdata/loggercheck/loggercheck_all.go

Lines changed: 0 additions & 29 deletions
This file was deleted.

test/testdata/loggercheck/loggercheck_default.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ func ExampleDefaultKlog() {
2424
func ExampleZapSugarNotChecked() {
2525
sugar := zap.NewExample().Sugar()
2626
defer sugar.Sync()
27-
sugar.Infow("message", "key1", "value1", "key2")
27+
sugar.Infow("message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
2828
}

test/testdata/loggercheck/loggercheck_kitlogonly.go

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,21 @@ package loggercheck
44

55
import (
66
kitlog "github.com/go-kit/log"
7+
"github.com/go-logr/logr"
8+
"go.uber.org/zap"
9+
"k8s.io/klog/v2"
710
)
811

12+
func ExampleKitLogOnly_NoLogr() {
13+
log := logr.Discard()
14+
log.Info("message", "key1", "value1", "key2", "value2", "key3")
15+
klog.InfoS("message", "key1")
16+
17+
sugar := zap.NewExample().Sugar()
18+
sugar.Infow("message", "key1", "value1", "key2")
19+
sugar.Errorw("error message", "key1")
20+
}
21+
922
func ExampleKitLogOnly() {
1023
logger := kitlog.NewNopLogger()
1124

test/testdata/loggercheck/logrlint_compatiblity.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ func ExampleLogrlintKlog() {
2424
func ExampleLogrlintZapSugar() {
2525
sugar := zap.NewExample().Sugar()
2626
defer sugar.Sync()
27-
sugar.Infow("message", "key1", "value1", "key2")
27+
sugar.Infow("message", "key1", "value1", "key2") // want `odd number of arguments passed as key-value pairs for logging`
2828
}

0 commit comments

Comments
 (0)