dev: use analyzer fields for name, doc instead of hardcoded strings (#4214)

alexandear · ldez · web-flow · commit ce020c6be1b8 · 2023-11-20T20:53:18.000+01:00
Co-authored-by: Fernandez Ludovic &lt;ldez@users.noreply.github.com&gt;
diff --git a/pkg/golinters/asciicheck.go b/pkg/golinters/asciicheck.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewAsciicheck() *goanalysis.Linter {
+	a := asciicheck.NewAnalyzer()
+
 	return goanalysis.NewLinter(
-		"asciicheck",
-		"Simple linter to check that your code does not contain non-ASCII identifiers",
-		[]*analysis.Analyzer{asciicheck.NewAnalyzer()},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
diff --git a/pkg/golinters/bidichk.go b/pkg/golinters/bidichk.go
@@ -51,7 +51,7 @@ func NewBiDiChkFuncName(cfg *config.BiDiChkSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		"bidichk",
+		a.Name,
 		"Checks for dangerous unicode character sequences",
 		[]*analysis.Analyzer{a},
 		cfgMap,
diff --git a/pkg/golinters/cyclop.go b/pkg/golinters/cyclop.go
@@ -8,8 +8,6 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
 )
 
-const cyclopName = "cyclop"
-
 func NewCyclop(settings *config.Cyclop) *goanalysis.Linter {
 	a := analyzer.NewAnalyzer()
 
@@ -31,7 +29,7 @@ func NewCyclop(settings *config.Cyclop) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		cyclopName,
+		a.Name,
 		"checks function and package cyclomatic complexity",
 		[]*analysis.Analyzer{a},
 		cfg,
diff --git a/pkg/golinters/errchkjson.go b/pkg/golinters/errchkjson.go
@@ -23,10 +23,8 @@ func NewErrChkJSONFuncName(cfg *config.ErrChkJSONSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		"errchkjson",
-		"Checks types passed to the json encoding functions. "+
-			"Reports unsupported types and optionally reports occasions, "+
-			"where the check for the returned error can be omitted.",
+		a.Name,
+		a.Doc,
 		[]*analysis.Analyzer{a},
 		cfgMap,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
diff --git a/pkg/golinters/errname.go b/pkg/golinters/errname.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewErrName() *goanalysis.Linter {
+	a := analyzer.New()
+
 	return goanalysis.NewLinter(
-		"errname",
-		"Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.",
-		[]*analysis.Analyzer{analyzer.New()},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/goprintffuncname.go b/pkg/golinters/goprintffuncname.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewGoPrintfFuncName() *goanalysis.Linter {
+	a := analyzer.Analyzer
+
 	return goanalysis.NewLinter(
-		"goprintffuncname",
-		"Checks that printf-like functions are named with `f` at the end",
-		[]*analysis.Analyzer{analyzer.Analyzer},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
diff --git a/pkg/golinters/grouper.go b/pkg/golinters/grouper.go
@@ -25,7 +25,7 @@ func NewGrouper(settings *config.GrouperSettings) *goanalysis.Linter {
 
 	return goanalysis.NewLinter(
 		"grouper",
-		"An analyzer to analyze expression groups.",
+		"Analyze expression groups.",
 		[]*analysis.Analyzer{grouper.New()},
 		linterCfg,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
diff --git a/pkg/golinters/ifshort.go b/pkg/golinters/ifshort.go
@@ -19,10 +19,12 @@ func NewIfshort(settings *config.IfshortSettings) *goanalysis.Linter {
 		}
 	}
 
+	a := analyzer.Analyzer
+
 	return goanalysis.NewLinter(
-		"ifshort",
-		"Checks that your code uses short syntax for if-statements whenever possible",
-		[]*analysis.Analyzer{analyzer.Analyzer},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		cfg,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
diff --git a/pkg/golinters/ineffassign.go b/pkg/golinters/ineffassign.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewIneffassign() *goanalysis.Linter {
+	a := ineffassign.Analyzer
+
 	return goanalysis.NewLinter(
-		"ineffassign",
+		a.Name,
 		"Detects when assignments to existing variables are not used",
-		[]*analysis.Analyzer{ineffassign.Analyzer},
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
diff --git a/pkg/golinters/nakedret.go b/pkg/golinters/nakedret.go
@@ -8,20 +8,18 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
 )
 
-const nakedretName = "nakedret"
-
 func NewNakedret(settings *config.NakedretSettings) *goanalysis.Linter {
 	var maxLines int
 	if settings != nil {
 		maxLines = settings.MaxFuncLines
 	}
 
-	analyzer := nakedret.NakedReturnAnalyzer(uint(maxLines))
+	a := nakedret.NakedReturnAnalyzer(uint(maxLines))
 
 	return goanalysis.NewLinter(
-		nakedretName,
-		"Finds naked returns in functions greater than a specified function length",
-		[]*analysis.Analyzer{analyzer},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeSyntax)
 }
diff --git a/pkg/golinters/noctx.go b/pkg/golinters/noctx.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewNoctx() *goanalysis.Linter {
+	a := noctx.Analyzer
+
 	return goanalysis.NewLinter(
-		"noctx",
-		"noctx finds sending http request without context.Context",
-		[]*analysis.Analyzer{noctx.Analyzer},
+		a.Name,
+		"Detects test helpers which is not start with t.Helper() method",
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/paralleltest.go b/pkg/golinters/paralleltest.go
@@ -22,8 +22,8 @@ func NewParallelTest(settings *config.ParallelTestSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		"paralleltest",
-		"paralleltest detects missing usage of t.Parallel() method in your Go test",
+		a.Name,
+		"Detects missing usage of t.Parallel() method in your Go test",
 		[]*analysis.Analyzer{a},
 		cfg,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
diff --git a/pkg/golinters/rowserrcheck.go b/pkg/golinters/rowserrcheck.go
@@ -14,12 +14,12 @@ func NewRowsErrCheck(settings *config.RowsErrCheckSettings) *goanalysis.Linter {
 		pkgs = settings.Packages
 	}
 
-	analyzer := rowserr.NewAnalyzer(pkgs...)
+	a := rowserr.NewAnalyzer(pkgs...)
 
 	return goanalysis.NewLinter(
-		"rowserrcheck",
-		"checks whether Err of rows is checked successfully",
-		[]*analysis.Analyzer{analyzer},
+		a.Name,
+		"checks whether Rows.Err of rows is checked successfully",
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/sqlclosecheck.go b/pkg/golinters/sqlclosecheck.go
@@ -8,12 +8,12 @@ import (
 )
 
 func NewSQLCloseCheck() *goanalysis.Linter {
+	a := analyzer.NewAnalyzer()
+
 	return goanalysis.NewLinter(
-		"sqlclosecheck",
-		"Checks that sql.Rows and sql.Stmt are closed.",
-		[]*analysis.Analyzer{
-			analyzer.NewAnalyzer(),
-		},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/thelper.go b/pkg/golinters/thelper.go
@@ -54,8 +54,8 @@ func NewThelper(cfg *config.ThelperSettings) *goanalysis.Linter {
 	}
 
 	return goanalysis.NewLinter(
-		"thelper",
-		"thelper detects Go test helpers without t.Helper() call and checks the consistency of test helpers",
+		a.Name,
+		a.Doc,
 		[]*analysis.Analyzer{a},
 		cfgMap,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
diff --git a/pkg/golinters/tparallel.go b/pkg/golinters/tparallel.go
@@ -8,10 +8,11 @@ import (
 )
 
 func NewTparallel() *goanalysis.Linter {
+	a := tparallel.Analyzer
 	return goanalysis.NewLinter(
-		"tparallel",
-		"tparallel detects inappropriate usage of t.Parallel() method in your Go test codes",
-		[]*analysis.Analyzer{tparallel.Analyzer},
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/wastedassign.go b/pkg/golinters/wastedassign.go
@@ -8,10 +8,12 @@ import (
 )
 
 func NewWastedAssign() *goanalysis.Linter {
+	a := wastedassign.Analyzer
+
 	return goanalysis.NewLinter(
-		"wastedassign",
-		"wastedassign finds wasted assignment statements.",
-		[]*analysis.Analyzer{wastedassign.Analyzer},
+		a.Name,
+		"Finds wasted assignment statements",
+		[]*analysis.Analyzer{a},
 		nil,
 	).WithLoadMode(goanalysis.LoadModeTypesInfo)
 }
diff --git a/pkg/golinters/wrapcheck.go b/pkg/golinters/wrapcheck.go
@@ -8,8 +8,6 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
 )
 
-const wrapcheckName = "wrapcheck"
-
 func NewWrapcheck(settings *config.WrapcheckSettings) *goanalysis.Linter {
 	cfg := wrapcheck.NewDefaultConfig()
 	if settings != nil {
@@ -30,7 +28,7 @@ func NewWrapcheck(settings *config.WrapcheckSettings) *goanalysis.Linter {
 	a := wrapcheck.NewAnalyzer(cfg)
 
 	return goanalysis.NewLinter(
-		wrapcheckName,
+		a.Name,
 		a.Doc,
 		[]*analysis.Analyzer{a},
 		nil,

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ func NewBiDiChkFuncName(cfg config.BiDiChkSettings) goanalysis.Linter {`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`return goanalysis.NewLinter(`
`54`		`- "bidichk",`
	`54`	`+ a.Name,`
`55`	`55`	`"Checks for dangerous unicode character sequences",`
`56`	`56`	`[]*analysis.Analyzer{a},`
`57`	`57`	`cfgMap,`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,6 @@ import (`
`8`	`8`	`"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"`
`9`	`9`	`)`
`10`	`10`
`11`		`-const cyclopName = "cyclop"`
`12`		`-`
`13`	`11`	`func NewCyclop(settings config.Cyclop) goanalysis.Linter {`
`14`	`12`	`a := analyzer.NewAnalyzer()`
`15`	`13`
`@@ -31,7 +29,7 @@ func NewCyclop(settings config.Cyclop) goanalysis.Linter {`
`31`	`29`	`}`
`32`	`30`
`33`	`31`	`return goanalysis.NewLinter(`
`34`		`- cyclopName,`
	`32`	`+ a.Name,`
`35`	`33`	`"checks function and package cyclomatic complexity",`
`36`	`34`	`[]*analysis.Analyzer{a},`
`37`	`35`	`cfg,`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,12 @@ func NewIfshort(settings config.IfshortSettings) goanalysis.Linter {`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`
	`22`	`+ a := analyzer.Analyzer`
	`23`	`+`
`22`	`24`	`return goanalysis.NewLinter(`
`23`		`- "ifshort",`
`24`		`- "Checks that your code uses short syntax for if-statements whenever possible",`
`25`		`- []*analysis.Analyzer{analyzer.Analyzer},`
	`25`	`+ a.Name,`
	`26`	`+ a.Doc,`
	`27`	`+ []*analysis.Analyzer{a},`
`26`	`28`	`cfg,`
`27`	`29`	`).WithLoadMode(goanalysis.LoadModeSyntax)`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,12 @@ import (`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`func NewIneffassign() *goanalysis.Linter {`
	`11`	`+ a := ineffassign.Analyzer`
	`12`	`+`
`11`	`13`	`return goanalysis.NewLinter(`
`12`		`- "ineffassign",`
	`14`	`+ a.Name,`
`13`	`15`	`"Detects when assignments to existing variables are not used",`
`14`		`- []*analysis.Analyzer{ineffassign.Analyzer},`
	`16`	`+ []*analysis.Analyzer{a},`
`15`	`17`	`nil,`
`16`	`18`	`).WithLoadMode(goanalysis.LoadModeSyntax)`
`17`	`19`	`}`