feat: add linter gocheckerrbeforeuse

Signed-off-by: voloshina <[email protected]>

Author: T-Sh

.golangci.next.reference.yml

@@ -52,6 +52,7 @@ linters:
     - funlen
     - ginkgolinter
     - gocheckcompilerdirectives
+    - gocheckerrbeforeuse
     - gochecknoglobals
     - gochecknoinits
     - gochecksumtype
@@ -163,6 +164,7 @@ linters:
     - funlen
     - ginkgolinter
     - gocheckcompilerdirectives
+    - gocheckerrbeforeuse
     - gochecknoglobals
     - gochecknoinits
     - gochecksumtype
@@ -657,6 +659,12 @@ linters:
       # Default: false
       force-assertion-description: true
 
+    gocheckerrbeforeuse:
+      # Maximum allowable distance between receiving an error and handling it.
+      # Value must always be greater than or equal to 1.
+      # Default: 1
+      max-allowed-distance: 1
+
     gochecksumtype:
       # Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed.
       # Default: true

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/BurntSushi/toml v1.5.0
 	github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24
 	github.com/OpenPeeDeeP/depguard/v2 v2.2.1
+	github.com/T-Sh/go-check-err-before-use v1.0.0
 	github.com/alecthomas/chroma/v2 v2.20.0
 	github.com/alecthomas/go-check-sumtype v0.3.1
 	github.com/alexkohler/nakedret/v2 v2.0.6

go.sum

@@ -788,6 +788,7 @@
             "funlen",
             "ginkgolinter",
             "gocheckcompilerdirectives",
+            "gocheckerrbeforeuse",
             "gochecknoglobals",
             "gochecknoinits",
             "gochecksumtype",

jsonschema/golangci.next.jsonschema.json

@@ -238,6 +238,7 @@ type LintersSettings struct {
 	Funlen                   FunlenSettings                   `mapstructure:"funlen"`
 	GinkgoLinter             GinkgoLinterSettings             `mapstructure:"ginkgolinter"`
 	Gocognit                 GocognitSettings                 `mapstructure:"gocognit"`
+	GoCheckErrBeforeUse      GoCheckErrBeforeUseSettings      `mapstructure:"gocheckerrbeforeuse"`
 	GoChecksumType           GoChecksumTypeSettings           `mapstructure:"gochecksumtype"`
 	Goconst                  GoConstSettings                  `mapstructure:"goconst"`
 	Gocritic                 GoCriticSettings                 `mapstructure:"gocritic"`
@@ -478,6 +479,10 @@ type GinkgoLinterSettings struct {
 	ForceAssertionDescription  bool `mapstructure:"force-assertion-description"`
 }
 
+type GoCheckErrBeforeUseSettings struct {
+	MaxAllowedDistance int `mapstructure:"max-allowed-distance"`
+}
+
 type GoChecksumTypeSettings struct {
 	DefaultSignifiesExhaustive bool `mapstructure:"default-signifies-exhaustive"`
 	IncludeSharedInterfaces    bool `mapstructure:"include-shared-interfaces"`

pkg/config/linters_settings.go

@@ -0,0 +1,13 @@
+package gocheckerrbeforeuse
+
+import (
+	"github.com/T-Sh/go-check-err-before-use/pkg/analyzer"
+	"github.com/golangci/golangci-lint/v2/pkg/config"
+	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
+)
+
+func New(settings *config.GoCheckErrBeforeUseSettings) *goanalysis.Linter {
+	analyzerSettings := analyzer.Settings{Distance: settings.MaxAllowedDistance}
+
+	return goanalysis.NewLinterFromAnalyzer(analyzer.NewAnalyzer(analyzerSettings))
+}

pkg/golinters/gocheckerrbeforeuse/gocheckerrbeforeuse.go

@@ -0,0 +1,11 @@
+package gocheckerrbeforeuse
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/v2/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/gocheckerrbeforeuse/gocheckerrbeforeuse_test.go

@@ -0,0 +1,6 @@
+version: "2"
+
+linters:
+  settings:
+    gocheckerrbeforeuse:
+      max-allowed-distance: 2

pkg/golinters/gocheckerrbeforeuse/testdata/custom.yml

@@ -0,0 +1,25 @@
+//golangcitest:args -Egocheckerrbeforeuse
+package testdata
+
+func returns2Values() (int, error) {
+	return 0, nil
+}
+
+func Negative() {
+	i, err := returns2Values() // want "error must be checked right after receiving"
+
+	print(i)
+
+	if err != nil {
+		return
+	}
+}
+
+func Positive() {
+	i, err := returns2Values()
+	if err != nil {
+		return
+	}
+
+	print(i)
+}

pkg/golinters/gocheckerrbeforeuse/testdata/gocheckerrbeforeuse.go

@@ -0,0 +1,17 @@
+//golangcitest:args -Egocheckerrbeforeuse
+//golangcitest:config_path testdata/custom.yml
+package testdata
+
+func returns2Values() (int, error) {
+	return 0, nil
+}
+
+func PositiveWithCustomDistance() {
+	i, err := returns2Values()
+
+	print(i)
+
+	if err != nil {
+		return
+	}
+}