make gci linter fixable

Author: Thirukumaran Vaseeharan

pkg/golinters/gci.go

@@ -1,10 +1,15 @@
 package golinters
 
 import (
+	"bytes"
 	"fmt"
-	"strings"
+	"sync"
 
-	gci "github.com/daixiang0/gci/pkg/analyzer"
+	gcicfg "github.com/daixiang0/gci/pkg/configuration"
+	"github.com/daixiang0/gci/pkg/gci"
+	gciio "github.com/daixiang0/gci/pkg/io"
+	"github.com/pkg/errors"
+	"github.com/shazow/go-diff/difflib"
 	"golang.org/x/tools/go/analysis"
 
 	"github.com/golangci/golangci-lint/pkg/config"
@@ -15,34 +20,94 @@ import (
 const gciName = "gci"
 
 func NewGci(settings *config.GciSettings) *goanalysis.Linter {
-	var linterCfg map[string]map[string]interface{}
+	var cfg *gci.GciConfiguration
+	var mu sync.Mutex
+	var resIssues []goanalysis.Issue
+	differ := difflib.New()
 
 	if settings != nil {
-		cfg := map[string]interface{}{
-			gci.NoInlineCommentsFlag:  settings.NoInlineComments,
-			gci.NoPrefixCommentsFlag:  settings.NoPrefixComments,
-			gci.SectionsFlag:          strings.Join(settings.Sections, gci.SectionDelimiter),
-			gci.SectionSeparatorsFlag: strings.Join(settings.SectionSeparator, gci.SectionDelimiter),
+		strcfg := gci.GciStringConfiguration{
+			Cfg: gcicfg.FormatterConfiguration{
+				NoInlineComments: settings.NoInlineComments,
+				NoPrefixComments: settings.NoPrefixComments,
+			},
+			SectionStrings:          settings.Sections,
+			SectionSeparatorStrings: settings.SectionSeparator,
 		}
-
 		if settings.LocalPrefixes != "" {
 			prefix := []string{"standard", "default", fmt.Sprintf("prefix(%s)", settings.LocalPrefixes)}
-			cfg[gci.SectionsFlag] = strings.Join(prefix, gci.SectionDelimiter)
+			strcfg.SectionStrings = prefix
 		}
 
-		linterCfg = map[string]map[string]interface{}{
-			gci.Analyzer.Name: cfg,
-		}
+		cfg, _ = strcfg.Parse()
 	}
 
+	analyzer := &analysis.Analyzer{
+		Name: gciName,
+		Doc:  goanalysis.TheOnlyanalyzerDoc,
+	}
 	return goanalysis.NewLinter(
 		gciName,
 		"Gci controls golang package import order and makes it always deterministic.",
-		[]*analysis.Analyzer{gci.Analyzer},
-		linterCfg,
+		[]*analysis.Analyzer{analyzer},
+		nil,
 	).WithContextSetter(func(lintCtx *linter.Context) {
 		if settings.LocalPrefixes != "" {
 			lintCtx.Log.Warnf("gci: `local-prefixes` is deprecated, use `sections` and `prefix(%s)` instead.", settings.LocalPrefixes)
 		}
+
+		analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
+			var fileNames []string
+			for _, f := range pass.Files {
+				pos := pass.Fset.PositionFor(f.Pos(), false)
+				fileNames = append(fileNames, pos.Filename)
+			}
+
+			var issues []goanalysis.Issue
+			for _, f := range fileNames {
+				fio := gciio.File{FilePath: f}
+				source, result, err := gci.LoadFormatGoFile(fio, *cfg)
+				if err != nil {
+					return nil, err
+				}
+				if result == nil {
+					continue
+				}
+
+				if !bytes.Equal(source, result) {
+					diff := bytes.Buffer{}
+					_, err = diff.WriteString(fmt.Sprintf("--- %[1]s\n+++ %[1]s\n", f))
+					if err != nil {
+						return nil, fmt.Errorf("can't write diff header: %v", err)
+					}
+
+					err = differ.Diff(&diff, bytes.NewReader(source), bytes.NewReader(result))
+					if err != nil {
+						return nil, fmt.Errorf("can't get gci diff output: %v", err)
+					}
+
+					is, err := extractIssuesFromPatch(diff.String(), lintCtx.Log, lintCtx, gciName)
+					if err != nil {
+						return nil, errors.Wrapf(err, "can't extract issues from gci diff output %q", diff.String())
+					}
+
+					for i := range is {
+						issues = append(issues, goanalysis.NewIssue(&is[i], pass))
+					}
+				}
+			}
+
+			if len(issues) == 0 {
+				return nil, nil
+			}
+
+			mu.Lock()
+			resIssues = append(resIssues, issues...)
+			mu.Unlock()
+
+			return nil, nil
+		}
+	}).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
+		return resIssues
 	}).WithLoadMode(goanalysis.LoadModeSyntax)
 }

pkg/golinters/gofmt_common.go

@@ -210,6 +210,27 @@ func (p *hunkChangesParser) parse(h *diffpkg.Hunk) []Change {
 func getErrorTextForLinter(lintCtx *linter.Context, linterName string) string {
 	text := "File is not formatted"
 	switch linterName {
+	case gciName:
+		text = "File is not `gci`-ed"
+		noInLineComments := lintCtx.Settings().Gci.NoInlineComments
+		noPrefixComments := lintCtx.Settings().Gci.NoPrefixComments
+		sections := lintCtx.Settings().Gci.Sections
+		sectionSeparator := lintCtx.Settings().Gci.SectionSeparator
+		if noInLineComments || noPrefixComments || len(sections) > 0 || len(sectionSeparator) > 0 {
+			text += " with"
+		}
+		if noInLineComments {
+			text += " -NoInlineComments"
+		}
+		if noPrefixComments {
+			text += " -NoPrefixComments"
+		}
+		if len(sections) > 0 {
+			text += " -s " + strings.Join(sections, ",")
+		}
+		if len(sectionSeparator) > 0 {
+			text += " -x " + strings.Join(sectionSeparator, ",")
+		}
 	case gofumptName:
 		text = "File is not `gofumpt`-ed"
 		if lintCtx.Settings().Gofumpt.ExtraRules {