Skip to content

Commit dfb01c8

Browse files
authored
docs(govet): add settings for shadow and unusedresult (#2890)
docs(govet): add missing settings for `shadow` and `unusedresult`
1 parent d43e480 commit dfb01c8

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

.golangci.reference.yml

+21-2
Original file line numberDiff line numberDiff line change
@@ -792,18 +792,36 @@ linters-settings:
792792
settings:
793793
# Analyzer name, run `go tool vet help` to see all analyzers.
794794
printf:
795-
# Run `go tool vet help printf` to see available settings for `printf` analyzer.
795+
# Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`).
796+
# Default: []
796797
funcs:
797798
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
798799
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
799800
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
800801
- (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
802+
shadow:
803+
# Whether to be strict about shadowing; can be noisy.
804+
# Default: false
805+
strict: true
806+
unusedresult:
807+
# Comma-separated list of functions whose results must be used
808+
# (in addition to defaults context.WithCancel,context.WithDeadline,context.WithTimeout,context.WithValue,
809+
# errors.New,fmt.Errorf,fmt.Sprint,fmt.Sprintf,sort.Reverse)
810+
# Default []
811+
funcs:
812+
- pkg.MyFunc
813+
# Comma-separated list of names of methods of type func() string whose results must be used
814+
# (in addition to default Error,String)
815+
# Default []
816+
stringmethods:
817+
- MyMethod
801818

802819
# Disable all analyzers.
803820
# Default: false
804821
disable-all: true
805-
# Enable analyzers by name.
822+
# Enable analyzers by name (in addition to default).
806823
# Run `go tool vet help` to see all analyzers.
824+
# Default: []
807825
enable:
808826
- asmdecl
809827
- assign
@@ -847,6 +865,7 @@ linters-settings:
847865
enable-all: true
848866
# Disable analyzers by name.
849867
# Run `go tool vet help` to see all analyzers.
868+
# Default: []
850869
disable:
851870
- asmdecl
852871
- assign

0 commit comments

Comments
 (0)