Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gofactory linter #4196

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions .golangci.reference.yml
Expand Up @@ -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
Expand Down Expand Up @@ -2355,6 +2364,7 @@ linters:
- godot
- godox
- goerr113
- gofactory
- gofmt
- gofumpt
- goheader
Expand Down Expand Up @@ -2475,6 +2485,7 @@ linters:
- godot
- godox
- goerr113
- gofactory
- gofmt
- gofumpt
- goheader
Expand Down
1 change: 1 addition & 0 deletions go.mod
Expand Up @@ -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.4
maranqz marked this conversation as resolved.
Show resolved Hide resolved
github.com/maratori/testableexamples v1.0.0
github.com/maratori/testpackage v1.1.1
github.com/matoous/godox v0.0.0-20230222163458-006bad1f9d26
Expand Down
2 changes: 2 additions & 0 deletions go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions pkg/config/linters_settings.go
Expand Up @@ -199,6 +199,7 @@ type LintersSettings struct {
Gocyclo GoCycloSettings
Godot GodotSettings
Godox GodoxSettings
Gofactory GoFactoryLintSettings
Gofmt GoFmtSettings
Gofumpt GofumptSettings
Goheader GoHeaderSettings
Expand Down Expand Up @@ -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"`
Expand Down
30 changes: 30 additions & 0 deletions 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)
}
8 changes: 8 additions & 0 deletions pkg/lint/lintersdb/manager.go
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).
ldez marked this conversation as resolved.
Show resolved Hide resolved
WithLoadForGoAnalysis().
WithURL("https://github.com/maranqz/go-factory-lint"),

linter.NewConfig(golinters.NewGofmt(gofmtCfg)).
WithSince("v1.0.0").
WithPresets(linter.PresetFormatting).
Expand Down
1 change: 1 addition & 0 deletions test/linters_test.go
Expand Up @@ -33,6 +33,7 @@ func TestSourcesFromTestdataSubDir(t *testing.T) {
"ginkgolinter",
"zerologlint",
"protogetter",
"gofactory",
}

for _, dir := range subDirs {
Expand Down
24 changes: 24 additions & 0 deletions test/testdata/gofactory/blocked.go
@@ -0,0 +1,24 @@
//golangcitest:args -Egofactory
//golangcitest:config_path configs/go_factory_only_blocked.yml
package gofactory

import (
"gofactory/blocked"
"gofactory/nested"
)

var (
nestedGlobalStruct = nested.Struct{}
nestedGlobalStructPtr = &nested.Struct{}

blockedGlobalStruct = blocked.Struct{} // want `Use factory for blocked.Struct`
blockedGlobalStructPtr = &blocked.Struct{} // want `Use factory for blocked.Struct`
)

func Blocked() {
_ = nested.Struct{}
_ = &nested.Struct{}

_ = blocked.Struct{} // want `Use factory for blocked.Struct`
_ = &blocked.Struct{} // want `Use factory for blocked.Struct`
}
3 changes: 3 additions & 0 deletions test/testdata/gofactory/blocked/blocked.go
@@ -0,0 +1,3 @@
package blocked

type Struct struct{}
5 changes: 5 additions & 0 deletions test/testdata/gofactory/configs/go_factory_only_blocked.yml
@@ -0,0 +1,5 @@
linters-settings:
gofactory:
packageGlobs:
- gofactory/blocked/**
onlyPackageGlobs: true
32 changes: 32 additions & 0 deletions test/testdata/gofactory/default.go
@@ -0,0 +1,32 @@
//golangcitest:args -Egofactory
package gofactory

import (
alias_blocked "gofactory/blocked"
"gofactory/nested"
)

type Struct struct{}

var (
defaultGlobalStruct = nested.Struct{} // want `Use factory for nested.Struct`
defaultGlobalStructPtr = &nested.Struct{} // want `Use factory for nested.Struct`
)

func Default() {
_ = nested.Struct{} // want `Use factory for nested.Struct`
_ = &nested.Struct{} // want `Use factory for nested.Struct`

_ = []nested.Struct{{}, nested.Struct{}} // want `Use factory for nested.Struct`
_ = []*nested.Struct{{}, &nested.Struct{}} // want `Use factory for nested.Struct`

call(nested.Struct{}) // want `Use factory for nested.Struct`

_ = []Struct{{}, {}}
}

func call(_ nested.Struct) {}

func alias() {
_ = alias_blocked.Struct{} // want `Use factory for blocked.Struct`
}
4 changes: 4 additions & 0 deletions test/testdata/gofactory/go.mod
@@ -0,0 +1,4 @@
module gofactory

go 1.18

3 changes: 3 additions & 0 deletions test/testdata/gofactory/nested/nested.go
@@ -0,0 +1,3 @@
package nested

type Struct struct{}