Add gofactory linter

.golangci.reference.yml

@@ -665,6 +665,15 @@ linters-settings:
  - OPTIMIZE # marks code that should be optimized before merging
  - HACK # marks hack-around that should be removed before merging
 
+ gofactory:
+ # List of glob packages, which can create structures without factories inside the glob package.
+ # Default: []
+ packageGlobs:
+ - github.com/author/repository/path/to/package/**
+ # Use a factory to initiate a structure for glob packages only.
+ # Default: false
+ onlyPackageGlobs: true
+
  gofmt:
  # Simplify code: gofmt with `-s` option.
  # Default: true
@@ -2355,6 +2364,7 @@ linters:
  - godot
  - godox
  - goerr113
+ - gofactory
  - gofmt
  - gofumpt
  - goheader
@@ -2475,6 +2485,7 @@ linters:
  - godot
  - godox
  - goerr113
+ - gofactory
  - gofmt
  - gofumpt
  - goheader

go.mod

@@ -69,6 +69,7 @@ require (
  github.com/leonklingele/grouper v1.1.1
  github.com/lufeee/execinquery v1.2.1
  github.com/macabu/inamedparam v0.1.2
+ github.com/maranqz/go-factory-lint/v2 v2.0.0-beta.5
  github.com/maratori/testableexamples v1.0.0
  github.com/maratori/testpackage v1.1.1
  github.com/matoous/godox v0.0.0-20230222163458-006bad1f9d26

pkg/config/linters_settings.go

@@ -199,6 +199,7 @@ type LintersSettings struct {
  Gocyclo GoCycloSettings
  Godot GodotSettings
  Godox GodoxSettings
+ Gofactory GoFactoryLintSettings
  Gofmt GoFmtSettings
  Gofumpt GofumptSettings
  Goheader GoHeaderSettings
@@ -479,6 +480,11 @@ type GodoxSettings struct {
  Keywords []string
 }
 
+type GoFactoryLintSettings struct {
+ PackageGlobs []string `mapstructure:"packageGlobs"`
+ OnlyPackageGlobs bool `mapstructure:"onlyPackageGlobs"`
+}
+
 type GoFmtSettings struct {
  Simplify bool
  RewriteRules []GoFmtRewriteRule `mapstructure:"rewrite-rules"`

pkg/golinters/gofactorylint.go

@@ -0,0 +1,30 @@
+package golinters
+
+import (
+ "github.com/maranqz/go-factory-lint/v2"
+ "golang.org/x/tools/go/analysis"
+
+ "github.com/golangci/golangci-lint/pkg/config"
+ "github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewGoFactoryLint(settings *config.GoFactoryLintSettings) *goanalysis.Linter {
+ analyzer := factory.NewAnalyzer()
+
+ cfg := make(map[string]map[string]any)
+ if settings != nil {
+ cfg[analyzer.Name] = map[string]any{}
+
+ if len(settings.PackageGlobs) > 0 {
+ cfg[analyzer.Name]["packageGlobs"] = settings.PackageGlobs
+ cfg[analyzer.Name]["onlyPackageGlobs"] = settings.OnlyPackageGlobs
+ }
+ }
+
+ return goanalysis.NewLinter(
+ analyzer.Name,
+ analyzer.Doc,
+ []*analysis.Analyzer{analyzer},
+ cfg,
+ ).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/lint/lintersdb/manager.go

@@ -90,6 +90,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
  gocycloCfg *config.GoCycloSettings
  godotCfg *config.GodotSettings
  godoxCfg *config.GodoxSettings
+ goFactoryCfg *config.GoFactoryLintSettings
  gofmtCfg *config.GoFmtSettings
  gofumptCfg *config.GofumptSettings
  goheaderCfg *config.GoHeaderSettings
@@ -174,6 +175,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
  gocycloCfg = &m.cfg.LintersSettings.Gocyclo
  godotCfg = &m.cfg.LintersSettings.Godot
  godoxCfg = &m.cfg.LintersSettings.Godox
+ goFactoryCfg = &m.cfg.LintersSettings.Gofactory
  gofmtCfg = &m.cfg.LintersSettings.Gofmt
  gofumptCfg = &m.cfg.LintersSettings.Gofumpt
  goheaderCfg = &m.cfg.LintersSettings.Goheader
@@ -488,6 +490,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
  WithLoadForGoAnalysis().
  WithURL("https://github.com/Djarvur/go-err113"),
 
+ linter.NewConfig(golinters.NewGoFactoryLint(goFactoryCfg)).
+ WithSince("1.56.0").
+ WithPresets(linter.PresetStyle).
+ WithLoadForGoAnalysis().
+ WithURL("https://github.com/maranqz/go-factory-lint"),
+
  linter.NewConfig(golinters.NewGofmt(gofmtCfg)).
  WithSince("v1.0.0").
  WithPresets(linter.PresetFormatting).

test/linters_test.go

@@ -33,6 +33,7 @@ func TestSourcesFromTestdataSubDir(t *testing.T) {
  "ginkgolinter",
  "zerologlint",
  "protogetter",
+ "gofactory",
  }
 
  for _, dir := range subDirs {

test/testdata/gofactory/blocked.go

@@ -0,0 +1,46 @@
+//golangcitest:args -Egofactory
+//golangcitest:config_path configs/go_factory_only_blocked.yml
+package gofactory
+
+import (
+ "net/http"
+ "net/url"
+)
+
+var (
+ nestedGlobalRequest = http.Request{}
+ nestedGlobalRequestPtr = &http.Request{}
+
+ blockedGlobalURL = url.URL{} // want `Use factory for url.URL`
+ blockedGlobalURLPtr = &url.URL{} // want `Use factory for url.URL`
+)
+
+func Blocked() {
+ _ = http.Request{}
+ _ = &http.Request{}
+
+ _ = url.URL{} // want `Use factory for url.URL`
+ _ = &url.URL{} // want `Use factory for url.URL`
+}
+
+type URL struct {
+ Scheme string
+ Opaque string
+ User *url.Userinfo
+ Host string
+ Path string
+ RawPath string
+ OmitHost bool
+ ForceQuery bool
+ RawQuery string
+ Fragment string
+ RawFragment string
+}
+
+func Casting() {
+ _ = url.URL(URL{}) // want `Use factory for url.URL`
+
+ uPtr, _ := url.Parse("")
+ u := *uPtr
+ _ = URL(u)
+}

test/testdata/gofactory/configs/go_factory_only_blocked.yml

@@ -0,0 +1,5 @@
+linters-settings:
+ gofactory:
+ packageGlobs:
+ - net/url/**
+ onlyPackageGlobs: true

test/testdata/gofactory/default.go

@@ -0,0 +1,32 @@
+//golangcitest:args -Egofactory
+package gofactory
+
+import (
+ "net/http"
+ alias_blocked "net/http"
+)
+
+type Struct struct{}
+
+var (
+ defaultGlobalRequest = http.Request{} // want `Use factory for http.Request`
+ defaultGlobalRequestPtr = &http.Request{} // want `Use factory for http.Request`
+)
+
+func Default() {
+ _ = http.Request{} // want `Use factory for http.Request`
+ _ = &http.Request{} // want `Use factory for http.Request`
+
+ _ = []http.Request{{}, http.Request{}} // want `Use factory for http.Request`
+ _ = []*http.Request{{}, &http.Request{}} // want `Use factory for http.Request`
+
+ call(http.Request{}) // want `Use factory for http.Request`
+
+ _ = []Struct{{}, {}}
+}
+
+func call(_ http.Request) {}
+
+func alias() {
+ _ = alias_blocked.Request{} // want `Use factory for http.Request`
+}

test/testdata/gofactory/go.mod

@@ -0,0 +1,4 @@
+module gofactory
+
+go 1.18
+