adding gofuncor linter

Author: manuelarte

go.mod

@@ -73,6 +73,7 @@ require (
 	github.com/ldez/usetesting v0.4.2
 	github.com/leonklingele/grouper v1.1.2
 	github.com/macabu/inamedparam v0.2.0
+	github.com/manuelarte/gofuncor v0.0.3
 	github.com/maratori/testableexamples v1.0.0
 	github.com/maratori/testpackage v1.1.1
 	github.com/matoous/godox v1.1.0

go.sum

@@ -19,6 +19,7 @@ type FormatterSettings struct {
 	Gci       GciSettings       `mapstructure:"gci"`
 	GoFmt     GoFmtSettings     `mapstructure:"gofmt"`
 	GoFumpt   GoFumptSettings   `mapstructure:"gofumpt"`
+	GoFuncOr  GoFuncOrSettings  `mapstructure:"gofuncor"`
 	GoImports GoImportsSettings `mapstructure:"goimports"`
 	GoLines   GoLinesSettings   `mapstructure:"golines"`
 }
@@ -48,6 +49,8 @@ type GoFumptSettings struct {
 	LangVersion string `mapstructure:"-"`
 }
 
+type GoFuncOrSettings struct{}
+
 type GoImportsSettings struct {
 	LocalPrefixes []string `mapstructure:"local-prefixes"`
 }

pkg/config/formatters_settings.go

@@ -0,0 +1,19 @@
+package gofuncor
+
+import (
+	"github.com/golangci/golangci-lint/v2/pkg/config"
+	"github.com/golangci/golangci-lint/v2/pkg/goanalysis"
+	"github.com/manuelarte/gofuncor/pkg/analyzer"
+	"golang.org/x/tools/go/analysis"
+)
+
+func New(_ *config.GoFuncOrSettings) *goanalysis.Linter {
+	a := analyzer.NewAnalyzer()
+
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/gofuncor/gofuncor.go

@@ -0,0 +1,24 @@
+package simple
+
+//nolint:recvcheck // testing linter
+type MyStruct2 struct {
+	Name string
+}
+
+func (m MyStruct2) GetName() string {
+	return m.Name
+}
+
+func (m *MyStruct2) SetName(name string) {
+	m.Name = name
+}
+
+//nolint:nonamedreturns // testing linter
+func NewOtherMyStruct2() (m *MyStruct2) { // want `constructor 'NewOtherMyStruct2' for struct 'MyStruct2' should be placed before struct method 'GetName'`
+	m = &MyStruct2{Name: "John"}
+	return
+}
+
+func NewMyStruct2() *MyStruct2 { // want `constructor \"NewMyStruct2\" for struct \"MyStruct2\" should be placed before struct method \"GetName\"`
+	return &MyStruct2{Name: "John"}
+}

pkg/golinters/gofuncor/testdata/constructors_after_struct_methods.go

@@ -0,0 +1,33 @@
+package simple
+
+//nolint:nonamedreturns // testing linter
+func NewOtherMyStruct() (m *MyStruct) { // want "should be placed after the struct declaration"
+	m = &MyStruct{Name: "John"}
+	return
+}
+
+func NewMyStruct() *MyStruct { // want "should be placed after the struct declaration"
+	return &MyStruct{Name: "John"}
+}
+
+func MustMyStruct() *MyStruct { // want `function \"MustMyStruct\" for struct \"MyStruct\" should be placed after the struct declaration`
+	return NewMyStruct()
+}
+
+//nolint:recvcheck // testing linter
+type MyStruct struct {
+	Name string
+}
+
+//nolint:unused // testing linter
+func (m MyStruct) lenName() int { // want `unexported method "lenName" for struct "MyStruct" should be placed after the exported method "GetName"`
+	return len(m.Name)
+}
+
+func (m MyStruct) GetName() string {
+	return m.Name
+}
+
+func (m *MyStruct) SetName(name string) {
+	m.Name = name
+}

pkg/golinters/gofuncor/testdata/constructors_before_struct.go

@@ -0,0 +1,13 @@
+package simple
+
+import (
+	"time"
+)
+
+func NewOtherWayMyStruct() MyStruct {
+	return MyStruct{Name: "John"}
+}
+
+func NewTimeStruct() time.Time {
+	return time.Now()
+}

pkg/golinters/gofuncor/testdata/struct_not_declared_in_file.go

@@ -44,6 +44,7 @@ import (
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/godox"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/gofmt"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/gofumpt"
+	"github.com/golangci/golangci-lint/v2/pkg/golinters/gofuncor"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/goheader"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/goimports"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/golines"
@@ -335,6 +336,11 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithAutoFix().
 			WithURL("https://github.com/mvdan/gofumpt"),
 
+		linter.NewConfig(gofuncor.New(&cfg.Linters.Settings.GoFuncOr)).
+			WithSince("v1.65.0").
+			WithAutoFix().
+			WithURL("https://github.com/manuelarte/gofuncor"),
+
 		linter.NewConfig(golines.New(&cfg.Linters.Settings.GoLines)).
 			WithSince("v2.0.0").
 			WithAutoFix().