Add the ginkgolinter linter (#3369)

Author: nunnatsa

.golangci.reference.yml

@@ -402,8 +402,21 @@ linters-settings:
     # Default: false
     custom-order: true
 
+  ginkgolinter:
+    # Suppress the wrong length assertion warning.
+    # Default: false
+    suppress-len-assertion: true
+
+    # Suppress the wrong nil assertion warning.
+    # Default: false
+    suppress-nil-assertion: true
+
+    # Suppress the wrong error assertion warning.
+    # Default: false
+    suppress-err-assertion: true
+
   gocognit:
-    # Minimal code complexity to report
+    # Minimal code complexity to report.
     # Default: 30 (but we recommend 10-20)
     min-complexity: 10
 
@@ -1989,6 +2002,7 @@ linters:
     - forcetypeassert
     - funlen
     - gci
+    - ginkgolinter
     - gochecknoglobals
     - gochecknoinits
     - gocognit
@@ -2096,6 +2110,7 @@ linters:
     - forcetypeassert
     - funlen
     - gci
+    - ginkgolinter
     - gochecknoglobals
     - gochecknoinits
     - gocognit

go.mod

@@ -72,6 +72,7 @@ require (
 	github.com/nakabonne/nestif v0.3.1
 	github.com/nishanths/exhaustive v0.9.3
 	github.com/nishanths/predeclared v0.2.2
+	github.com/nunnatsa/ginkgolinter v0.6.0
 	github.com/pkg/errors v0.9.1
 	github.com/polyfloyd/go-errorlint v1.0.6
 	github.com/quasilyte/go-ruleguard/dsl v0.3.21

go.sum

@@ -150,6 +150,7 @@ type LintersSettings struct {
 	Forbidigo        ForbidigoSettings
 	Funlen           FunlenSettings
 	Gci              GciSettings
+	GinkgoLinter     GinkgoLinterSettings
 	Gocognit         GocognitSettings
 	Goconst          GoConstSettings
 	Gocritic         GoCriticSettings
@@ -321,6 +322,12 @@ type GciSettings struct {
 	CustomOrder   bool     `mapstructure:"custom-order"`
 }
 
+type GinkgoLinterSettings struct {
+	SuppressLenAssertion bool `mapstructure:"suppress-len-assertion"`
+	SuppressNilAssertion bool `mapstructure:"suppress-nil-assertion"`
+	SuppressErrAssertion bool `mapstructure:"suppress-err-assertion"`
+}
+
 type GocognitSettings struct {
 	MinComplexity int `mapstructure:"min-complexity"`
 }

pkg/config/linters_settings.go

@@ -0,0 +1,29 @@
+package golinters
+
+import (
+	"github.com/nunnatsa/ginkgolinter"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewGinkgoLinter(cfg *config.GinkgoLinterSettings) *goanalysis.Linter {
+	a := ginkgolinter.NewAnalyzer()
+
+	cfgMap := make(map[string]map[string]interface{})
+	if cfg != nil {
+		cfgMap[a.Name] = map[string]interface{}{
+			"suppress-len-assertion": cfg.SuppressLenAssertion,
+			"suppress-nil-assertion": cfg.SuppressNilAssertion,
+			"suppress-err-assertion": cfg.SuppressErrAssertion,
+		}
+	}
+
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		cfgMap,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/golinters/ginkgolinter.go

@@ -118,6 +118,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		forbidigoCfg        *config.ForbidigoSettings
 		funlenCfg           *config.FunlenSettings
 		gciCfg              *config.GciSettings
+		ginkgolinterCfg     *config.GinkgoLinterSettings
 		gocognitCfg         *config.GocognitSettings
 		goconstCfg          *config.GoConstSettings
 		gocriticCfg         *config.GoCriticSettings
@@ -194,6 +195,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		forbidigoCfg = &m.cfg.LintersSettings.Forbidigo
 		funlenCfg = &m.cfg.LintersSettings.Funlen
 		gciCfg = &m.cfg.LintersSettings.Gci
+		ginkgolinterCfg = &m.cfg.LintersSettings.GinkgoLinter
 		gocognitCfg = &m.cfg.LintersSettings.Gocognit
 		goconstCfg = &m.cfg.LintersSettings.Goconst
 		gocriticCfg = &m.cfg.LintersSettings.Gocritic
@@ -430,6 +432,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetFormatting, linter.PresetImport).
 			WithURL("https://github.com/daixiang0/gci"),
 
+		linter.NewConfig(golinters.NewGinkgoLinter(ginkgolinterCfg)).
+			WithSince("v1.51.0").
+			WithLoadForGoAnalysis().
+			WithPresets(linter.PresetStyle).
+			WithURL("https://github.com/nunnatsa/ginkgolinter"),
+
 		linter.NewConfig(golinters.NewGochecknoglobals()).
 			WithSince("v1.12.0").
 			WithPresets(linter.PresetStyle).

pkg/lint/lintersdb/manager.go

@@ -30,6 +30,7 @@ func TestTypecheck(t *testing.T) {
 func TestSourcesFromTestdataSubDir(t *testing.T) {
 	subDirs := []string{
 		"loggercheck",
+		"ginkgolinter",
 	}
 
 	for _, dir := range subDirs {

test/linters_test.go

@@ -0,0 +1,2 @@
+linters-settings:
+  ginkgolinter: {}

test/testdata/ginkgolinter/configs/ginkgolinter_default.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  ginkgolinter:
+    suppress-err-assertion: true

test/testdata/ginkgolinter/configs/ginkgolinter_suppress_err.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  ginkgolinter:
+    suppress-len-assertion: true