Skip to content

dev: simplify linter constructors #5796

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

Merged
merged 1 commit into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 22 additions & 5 deletions pkg/goanalysis/linter.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ import (
"github.com/golangci/golangci-lint/v2/pkg/result"
)

const (
TheOnlyAnalyzerName = "the_only_name"
TheOnlyanalyzerDoc = "the_only_doc"
)

type LoadMode int

func (loadMode LoadMode) String() string {
Expand Down Expand Up @@ -55,6 +50,10 @@ func NewLinter(name, desc string, analyzers []*analysis.Analyzer, cfg map[string
return &Linter{name: name, desc: desc, analyzers: analyzers, cfg: cfg}
}

func NewLinterFromAnalyzer(analyzer *analysis.Analyzer) *Linter {
return NewLinter(analyzer.Name, analyzer.Doc, []*analysis.Analyzer{analyzer}, nil)
}

func (lnt *Linter) Run(_ context.Context, lintCtx *linter.Context) ([]result.Issue, error) {
if err := lnt.preRun(lintCtx); err != nil {
return nil, err
Expand All @@ -71,6 +70,24 @@ func (lnt *Linter) LoadMode() LoadMode {
return lnt.loadMode
}

func (lnt *Linter) WithDesc(desc string) *Linter {
lnt.desc = desc

return lnt
}

func (lnt *Linter) WithConfig(cfg map[string]any) *Linter {
if len(cfg) == 0 {
return lnt
}

lnt.cfg = map[string]map[string]any{
lnt.name: cfg,
}

return lnt
}

func (lnt *Linter) WithLoadMode(loadMode LoadMode) *Linter {
lnt.loadMode = loadMode
return lnt
Expand Down
12 changes: 3 additions & 9 deletions pkg/golinters/arangolint/arangolint.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ package arangolint

import (
"go.augendre.info/arangolint/pkg/analyzer"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := analyzer.NewAnalyzer()

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(analyzer.NewAnalyzer()).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
12 changes: 4 additions & 8 deletions pkg/golinters/asasalint/asasalint.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package asasalint

import (
"github.com/alingse/asasalint"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
Expand All @@ -19,15 +18,12 @@ func New(settings *config.AsasalintSettings) *goanalysis.Linter {
cfg.IgnoreTest = false
}

a, err := asasalint.NewAnalyzer(cfg)
analyzer, err := asasalint.NewAnalyzer(cfg)
if err != nil {
internal.LinterLogger.Fatalf("asasalint: create analyzer: %v", err)
}

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(analyzer).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
12 changes: 3 additions & 9 deletions pkg/golinters/asciicheck/asciicheck.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ package asciicheck

import (
"github.com/tdakkota/asciicheck"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := asciicheck.NewAnalyzer()

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeSyntax)
return goanalysis.
NewLinterFromAnalyzer(asciicheck.NewAnalyzer()).
WithLoadMode(goanalysis.LoadModeSyntax)
}
16 changes: 6 additions & 10 deletions pkg/golinters/bidichk/bidichk.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,14 @@ import (
"strings"

"github.com/breml/bidichk/pkg/bidichk"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New(settings *config.BiDiChkSettings) *goanalysis.Linter {
a := bidichk.NewAnalyzer()
var cfg map[string]any

cfg := map[string]map[string]any{}
if settings != nil {
var opts []string

Expand Down Expand Up @@ -45,15 +43,13 @@ func New(settings *config.BiDiChkSettings) *goanalysis.Linter {
opts = append(opts, "POP-DIRECTIONAL-ISOLATE")
}

cfg[a.Name] = map[string]any{
cfg = map[string]any{
"disallowed-runes": strings.Join(opts, ","),
}
}

return goanalysis.NewLinter(
a.Name,
"Checks for dangerous unicode character sequences",
[]*analysis.Analyzer{a},
cfg,
).WithLoadMode(goanalysis.LoadModeSyntax)
return goanalysis.
NewLinterFromAnalyzer(bidichk.NewAnalyzer()).
WithConfig(cfg).
WithLoadMode(goanalysis.LoadModeSyntax)
}
12 changes: 3 additions & 9 deletions pkg/golinters/bodyclose/bodyclose.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ package bodyclose

import (
"github.com/timakin/bodyclose/passes/bodyclose"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := bodyclose.Analyzer

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(bodyclose.Analyzer).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
12 changes: 3 additions & 9 deletions pkg/golinters/canonicalheader/canonicalheader.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ package canonicalheader

import (
"github.com/lasiar/canonicalheader"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := canonicalheader.Analyzer

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(canonicalheader.Analyzer).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
12 changes: 3 additions & 9 deletions pkg/golinters/containedctx/containedctx.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ package containedctx

import (
"github.com/sivchari/containedctx"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New() *goanalysis.Linter {
a := containedctx.Analyzer

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
nil,
).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(containedctx.Analyzer).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
15 changes: 6 additions & 9 deletions pkg/golinters/contextcheck/contextcheck.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package contextcheck

import (
"github.com/kkHAIKE/contextcheck"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
"github.com/golangci/golangci-lint/v2/pkg/lint/linter"
Expand All @@ -11,12 +10,10 @@ import (
func New() *goanalysis.Linter {
analyzer := contextcheck.NewAnalyzer(contextcheck.Configuration{})

return goanalysis.NewLinter(
analyzer.Name,
analyzer.Doc,
[]*analysis.Analyzer{analyzer},
nil,
).WithContextSetter(func(lintCtx *linter.Context) {
analyzer.Run = contextcheck.NewRun(lintCtx.Packages, false)
}).WithLoadMode(goanalysis.LoadModeTypesInfo)
return goanalysis.
NewLinterFromAnalyzer(analyzer).
WithContextSetter(func(lintCtx *linter.Context) {
analyzer.Run = contextcheck.NewRun(lintCtx.Packages, false)
}).
WithLoadMode(goanalysis.LoadModeTypesInfo)
}
20 changes: 7 additions & 13 deletions pkg/golinters/copyloopvar/copyloopvar.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,22 @@ package copyloopvar

import (
"github.com/karamaru-alpha/copyloopvar"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New(settings *config.CopyLoopVarSettings) *goanalysis.Linter {
a := copyloopvar.NewAnalyzer()
var cfg map[string]any

var cfg map[string]map[string]any
if settings != nil {
cfg = map[string]map[string]any{
a.Name: {
"check-alias": settings.CheckAlias,
},
cfg = map[string]any{
"check-alias": settings.CheckAlias,
}
}

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
cfg,
).WithLoadMode(goanalysis.LoadModeSyntax)
return goanalysis.
NewLinterFromAnalyzer(copyloopvar.NewAnalyzer()).
WithConfig(cfg).
WithLoadMode(goanalysis.LoadModeSyntax)
}
26 changes: 9 additions & 17 deletions pkg/golinters/cyclop/cyclop.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,29 @@ package cyclop

import (
"github.com/bkielbasa/cyclop/pkg/analyzer"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New(settings *config.CyclopSettings) *goanalysis.Linter {
a := analyzer.NewAnalyzer()
cfg := map[string]any{}

var cfg map[string]map[string]any
if settings != nil {
d := map[string]any{
// Should be managed with `linters.exclusions.rules`.
"skipTests": false,
}
// Should be managed with `linters.exclusions.rules`.
cfg["skipTests"] = false

if settings.MaxComplexity != 0 {
d["maxComplexity"] = settings.MaxComplexity
cfg["maxComplexity"] = settings.MaxComplexity
}

if settings.PackageAverage != 0 {
d["packageAverage"] = settings.PackageAverage
cfg["packageAverage"] = settings.PackageAverage
}

cfg = map[string]map[string]any{a.Name: d}
}

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
cfg,
).WithLoadMode(goanalysis.LoadModeSyntax)
return goanalysis.
NewLinterFromAnalyzer(analyzer.NewAnalyzer()).
WithConfig(cfg).
WithLoadMode(goanalysis.LoadModeSyntax)
}
13 changes: 4 additions & 9 deletions pkg/golinters/decorder/decorder.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,12 @@ import (
"strings"

"gitlab.com/bosi/decorder"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/v2/pkg/config"
"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
)

func New(settings *config.DecorderSettings) *goanalysis.Linter {
a := decorder.Analyzer

// disable all rules/checks by default
cfg := map[string]any{
"ignore-underscore-vars": false,
Expand All @@ -35,10 +32,8 @@ func New(settings *config.DecorderSettings) *goanalysis.Linter {
cfg["disable-init-func-first-check"] = settings.DisableInitFuncFirstCheck
}

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
map[string]map[string]any{a.Name: cfg},
).WithLoadMode(goanalysis.LoadModeSyntax)
return goanalysis.
NewLinterFromAnalyzer(decorder.Analyzer).
WithConfig(cfg).
WithLoadMode(goanalysis.LoadModeSyntax)
}
Loading
Loading