feat: adding embeddedcheck linter

Author: manuelarte

.golangci.next.reference.yml

@@ -32,6 +32,7 @@ linters:
     - dupl
     - dupword
     - durationcheck
+    - embeddedcheck
     - err113
     - errcheck
     - errchkjson
@@ -140,6 +141,7 @@ linters:
     - dupl
     - dupword
     - durationcheck
+    - embeddedcheck
     - err113
     - errcheck
     - errchkjson

go.mod

@@ -176,6 +176,7 @@ require (
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
 	github.com/magiconair/properties v1.8.6 // indirect
+	github.com/manuelarte/embeddedcheck v0.1.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect

go.sum

@@ -0,0 +1,19 @@
+package embeddedcheck
+
+import (
+	"github.com/manuelarte/embeddedcheck/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.LoadModeSyntax)
+}

pkg/golinters/embeddedcheck/embeddedcheck.go

@@ -0,0 +1,11 @@
+package embeddedcheck
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/v2/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/embeddedcheck/embeddedcheck_integration_test.go

@@ -0,0 +1,27 @@
+//golangcitest:args -Eembeddedcheck
+package simple
+
+import "time"
+
+type ValidStructWithSingleLineComments struct {
+	// time.Time Single line comment
+	time.Time
+
+	// version Single line comment
+	version int
+}
+
+type StructWithSingleLineComments struct {
+	// time.Time Single line comment
+	time.Time // want `there must be an empty line separating embedded fields from regular fields`
+	// version Single line comment
+	version int
+}
+
+type StructWithMultiLineComments struct {
+	// time.Time Single line comment
+	time.Time // want `there must be an empty line separating embedded fields from regular fields`
+	// version Single line comment
+	// very long comment
+	version int
+}

pkg/golinters/embeddedcheck/testdata/comments.go

@@ -0,0 +1,39 @@
+//golangcitest:args -Eembeddedcheck
+package simple
+
+import (
+	"context"
+	"time"
+)
+
+type ValidStruct struct {
+	time.Time
+
+	version int
+}
+
+type NoSpaceStruct struct {
+	time.Time // want `there must be an empty line separating embedded fields from regular fields`
+	version   int
+}
+
+type NotSortedStruct struct {
+	version int
+
+	time.Time // want `embedded types should be listed before non embedded types`
+}
+
+type MixedEmbeddedAndNotEmbedded struct {
+	context.Context
+
+	name string
+
+	time.Time // want `embedded types should be listed before non embedded types`
+
+	age int
+}
+
+type EmbeddedWithPointers struct {
+	*time.Time // want `there must be an empty line separating embedded fields from regular fields`
+	version    int
+}

pkg/golinters/embeddedcheck/testdata/simple.go

@@ -0,0 +1,11 @@
+//golangcitest:args -Eembeddedcheck
+package simple
+
+import "time"
+
+func myFunction() {
+	type myType struct {
+		version   int
+		time.Time // want `embedded types should be listed before non embedded types`
+	}
+}

pkg/golinters/embeddedcheck/testdata/special-cases.go

@@ -18,6 +18,7 @@ import (
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/dupl"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/dupword"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/durationcheck"
+	"github.com/golangci/golangci-lint/v2/pkg/golinters/embeddedcheck"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/err113"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/errcheck"
 	"github.com/golangci/golangci-lint/v2/pkg/golinters/errchkjson"
@@ -205,6 +206,11 @@ func (LinterBuilder) Build(cfg *config.Config) ([]*linter.Config, error) {
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/charithe/durationcheck"),
 
+		linter.NewConfig(embeddedcheck.New()).
+			WithSince("v2.2.0").
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/manuelarte/embeddedcheck"),
+
 		linter.NewConfig(errcheck.New(&cfg.Linters.Settings.Errcheck)).
 			WithGroups(config.GroupStandard).
 			WithSince("v1.0.0").