feat: migrate gci

Author: ldez

.golangci.yml

@@ -178,7 +178,7 @@ issues:
     - path: pkg/golinters/godot/godot.go
       linters: [staticcheck]
       text: "SA1019: settings.CheckAll is deprecated: use Scope instead"
-    - path: pkg/golinters/gci/gci.go
+    - path: pkg/goformatters/gci/gci.go
       linters: [staticcheck]
       text: "SA1019: settings.LocalPrefixes is deprecated: use Sections instead."
     - path: pkg/golinters/mnd/mnd.go

go.mod

@@ -95,7 +95,6 @@ require (
 	github.com/sashamelentyev/interfacebloat v1.1.0
 	github.com/sashamelentyev/usestdlibvars v1.28.0
 	github.com/securego/gosec/v2 v2.21.4
-	github.com/shazow/go-diff v0.0.0-20160112020656-b6b7b6733b8c
 	github.com/shirou/gopsutil/v4 v4.24.12
 	github.com/sirupsen/logrus v1.9.3
 	github.com/sivchari/containedctx v1.0.3

go.sum

@@ -1,116 +1,33 @@
 package gci
 
 import (
-	"bytes"
-	"fmt"
-	"io"
-	"os"
-
-	gcicfg "github.com/daixiang0/gci/pkg/config"
-	"github.com/daixiang0/gci/pkg/gci"
-	"github.com/daixiang0/gci/pkg/log"
-	"github.com/shazow/go-diff/difflib"
 	"golang.org/x/tools/go/analysis"
 
 	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
+	"github.com/golangci/golangci-lint/pkg/goformatters"
+	gcibase "github.com/golangci/golangci-lint/pkg/goformatters/gci"
 	"github.com/golangci/golangci-lint/pkg/golinters/internal"
-	"github.com/golangci/golangci-lint/pkg/lint/linter"
 )
 
 const linterName = "gci"
 
-type differ interface {
-	Diff(out io.Writer, a io.ReadSeeker, b io.ReadSeeker) error
-}
-
 func New(settings *config.GciSettings) *goanalysis.Linter {
-	log.InitLogger()
-	_ = log.L().Sync()
-
-	diff := difflib.New()
-
-	a := &analysis.Analyzer{
-		Name: linterName,
-		Doc:  goanalysis.TheOnlyanalyzerDoc,
-		Run:  goanalysis.DummyRun,
+	formatter, err := gcibase.New(settings)
+	if err != nil {
+		internal.LinterLogger.Fatalf("%s: create analyzer: %v", linterName, err)
 	}
 
+	a := goformatters.NewAnalyzer(
+		internal.LinterLogger.Child(linterName),
+		"Checks if code and import statements are formatted, with additional rules.",
+		formatter,
+	)
+
 	return goanalysis.NewLinter(
-		linterName,
-		"Checks if code and import statements are formatted, it makes import statements always deterministic.",
+		a.Name,
+		a.Doc,
 		[]*analysis.Analyzer{a},
 		nil,
-	).WithContextSetter(func(lintCtx *linter.Context) {
-		a.Run = func(pass *analysis.Pass) (any, error) {
-			err := run(lintCtx, pass, settings, diff)
-			if err != nil {
-				return nil, err
-			}
-
-			return nil, nil
-		}
-	}).WithLoadMode(goanalysis.LoadModeSyntax)
-}
-
-func run(lintCtx *linter.Context, pass *analysis.Pass, settings *config.GciSettings, diff differ) error {
-	cfg := gcicfg.YamlConfig{
-		Cfg: gcicfg.BoolConfig{
-			NoInlineComments: settings.NoInlineComments,
-			NoPrefixComments: settings.NoPrefixComments,
-			SkipGenerated:    settings.SkipGenerated,
-			CustomOrder:      settings.CustomOrder,
-			NoLexOrder:       settings.NoLexOrder,
-		},
-		SectionStrings: settings.Sections,
-		ModPath:        pass.Module.Path,
-	}
-
-	if settings.LocalPrefixes != "" {
-		cfg.SectionStrings = []string{
-			"standard",
-			"default",
-			fmt.Sprintf("prefix(%s)", settings.LocalPrefixes),
-		}
-	}
-
-	parsedCfg, err := cfg.Parse()
-	if err != nil {
-		return err
-	}
-
-	for _, file := range pass.Files {
-		position, isGoFile := goanalysis.GetGoFilePosition(pass, file)
-		if !isGoFile {
-			continue
-		}
-
-		input, err := os.ReadFile(position.Filename)
-		if err != nil {
-			return fmt.Errorf("unable to open file %s: %w", position.Filename, err)
-		}
-
-		_, output, err := gci.LoadFormat(input, position.Filename, *parsedCfg)
-		if err != nil {
-			return fmt.Errorf("error while running gci: %w", err)
-		}
-
-		if !bytes.Equal(input, output) {
-			out := bytes.NewBufferString(fmt.Sprintf("--- %[1]s\n+++ %[1]s\n", position.Filename))
-
-			err := diff.Diff(out, bytes.NewReader(input), bytes.NewReader(output))
-			if err != nil {
-				return fmt.Errorf("error while running gci: %w", err)
-			}
-
-			diff := out.String()
-
-			err = internal.ExtractDiagnosticFromPatch(pass, file, diff, lintCtx)
-			if err != nil {
-				return fmt.Errorf("can't extract issues from gci diff output %q: %w", diff, err)
-			}
-		}
-	}
-
-	return nil
+	).WithLoadMode(goanalysis.LoadModeSyntax)
 }

pkg/golinters/gci/gci.go

@@ -2,9 +2,9 @@
 //golangcitest:config_path testdata/gci.yml
 package testdata
 
-import ( // want "File is not properly formatted"
-	"golang.org/x/tools/go/analysis"
-	"github.com/golangci/golangci-lint/pkg/config" // want "File is not properly formatted"
+import (
+	"golang.org/x/tools/go/analysis" // want "File is not properly formatted"
+	"github.com/golangci/golangci-lint/pkg/config"
 	"fmt"
 	"errors"
 	gcicfg "github.com/daixiang0/gci/pkg/config"

pkg/golinters/gci/testdata/gci.go

@@ -12,10 +12,9 @@ package testdata
 */
 import "C"
 
-import ( // want "File is not properly formatted"
-	"golang.org/x/tools/go/analysis"
-	"github.com/golangci/golangci-lint/pkg/config" // want "File is not properly formatted"
-	"unsafe"
+import (
+	"golang.org/x/tools/go/analysis" // want "File is not properly formatted"
+	"github.com/golangci/golangci-lint/pkg/config"
 	"fmt"
 	"errors"
 	gcicfg "github.com/daixiang0/gci/pkg/config"

pkg/golinters/gci/testdata/gci_cgo.go

@@ -20,6 +20,7 @@ func NewMaxPerFileFromLinter(cfg *config.Config) *MaxPerFileFromLinter {
 		// otherwise we need to fix all issues in the file at once
 		maxPerFileFromLinterConfig["gofmt"] = 1
 		maxPerFileFromLinterConfig["goimports"] = 1
+		maxPerFileFromLinterConfig["gci"] = 1
 	}
 
 	return &MaxPerFileFromLinter{