Add support for gci sections

Signed-off-by: Norman Gehrsitz <[email protected]>

Author: ngehrsitz

.golangci.example.yml

@@ -295,10 +295,18 @@ linters-settings:
     statements: -1
 
   gci:
-    # Put imports beginning with prefix after 3rd-party packages.
-    # Only support one prefix.
-    # If not set, use `goimports.local-prefixes`.
-    local-prefixes: github.com/org/project
+    # Checks that no inline Comments are present
+    no-inlineComments: false
+    # Checks that no prefix Comments(comment lines above an import) are present
+    no-prefixComments: false
+    # Section configuration to compare against.
+    # Run gci print -h for a detailed explanation
+    sections:
+      - Standard
+      - Default
+    # Separators that should be present between sections
+    sectionSeparators:
+      - Newline
 
   gocognit:
     # Minimal code complexity to report

.golangci.yml

@@ -12,8 +12,6 @@ linters-settings:
   funlen:
     lines: 100
     statements: 50
-  gci:
-    local-prefixes: github.com/golangci/golangci-lint
   goconst:
     min-len: 2
     min-occurrences: 3

go.mod

@@ -19,7 +19,7 @@ require (
 	github.com/breml/errchkjson v0.2.1
 	github.com/butuzov/ireturn v0.1.1
 	github.com/charithe/durationcheck v0.0.9
-	github.com/daixiang0/gci v0.2.9
+	github.com/daixiang0/gci v0.3.0
 	github.com/denis-tingajkin/go-header v0.4.2
 	github.com/esimonov/ifshort v1.0.4
 	github.com/fatih/color v1.13.0

go.sum

@@ -253,7 +253,10 @@ type FunlenSettings struct {
 }
 
 type GciSettings struct {
-	LocalPrefixes string `mapstructure:"local-prefixes"`
+	NoInlineComments bool     `mapstructure:"no-inlineComments"`
+	NoPrefixComments bool     `mapstructure:"no-prefixComments"`
+	Sections         []string `mapstructure:"sections"`
+	SectionSeparator []string `mapstructure:"sectionSeparators"`
 }
 
 type GocognitSettings struct {

pkg/config/linters_settings.go

@@ -1,96 +1,35 @@
 package golinters
 
 import (
-	"bytes"
-	"fmt"
-	"sync"
+	"strings"
 
-	"github.com/daixiang0/gci/pkg/gci"
-	"github.com/pkg/errors"
-	"github.com/shazow/go-diff/difflib"
+	gciAnalyzer "github.com/daixiang0/gci/pkg/analyzer"
 	"golang.org/x/tools/go/analysis"
 
+	"github.com/golangci/golangci-lint/pkg/config"
 	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
-	"github.com/golangci/golangci-lint/pkg/lint/linter"
 )
 
 const gciName = "gci"
 
-func NewGci() *goanalysis.Linter {
-	var mu sync.Mutex
-	var resIssues []goanalysis.Issue
-	differ := difflib.New()
-
-	analyzer := &analysis.Analyzer{
-		Name: gciName,
-		Doc:  goanalysis.TheOnlyanalyzerDoc,
+func NewGci(settings *config.GciSettings) *goanalysis.Linter {
+	analyzer := gciAnalyzer.Analyzer
+	var cfg map[string]map[string]interface{}
+	if settings != nil {
+		cfg = map[string]map[string]interface{}{
+			analyzer.Name: {
+				gciAnalyzer.NoInlineCommentsFlag:  settings.NoInlineComments,
+				gciAnalyzer.NoPrefixCommentsFlag:  settings.NoPrefixComments,
+				gciAnalyzer.SectionsFlag:          strings.Join(settings.Sections, gciAnalyzer.SectionDelimiter),
+				gciAnalyzer.SectionSeparatorsFlag: strings.Join(settings.SectionSeparator, gciAnalyzer.SectionDelimiter),
+			},
+		}
 	}
+
 	return goanalysis.NewLinter(
 		gciName,
-		"Gci control golang package import order and make it always deterministic.",
+		"Gci controls golang package import order and makes it always deterministic.",
 		[]*analysis.Analyzer{analyzer},
-		nil,
-	).WithContextSetter(func(lintCtx *linter.Context) {
-		localFlag := lintCtx.Settings().Gci.LocalPrefixes
-		goimportsFlag := lintCtx.Settings().Goimports.LocalPrefixes
-		if localFlag == "" && goimportsFlag != "" {
-			localFlag = goimportsFlag
-		}
-
-		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
-
-			flagSet := gci.FlagSet{
-				LocalFlag: gci.ParseLocalFlag(localFlag),
-			}
-
-			for _, f := range fileNames {
-				source, result, err := gci.Run(f, &flagSet)
-				if err != nil {
-					return nil, err
-				}
-				if result == nil {
-					continue
-				}
-
-				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)
+		cfg,
+	).WithLoadMode(goanalysis.LoadModeSyntax)
 }

pkg/golinters/gci.go

@@ -226,16 +226,14 @@ func getErrorTextForLinter(lintCtx *linter.Context, linterName string) string {
 			text += " with -local " + lintCtx.Settings().Goimports.LocalPrefixes
 		}
 	case gciName:
-		text = "File is not `gci`-ed"
-		localPrefixes := lintCtx.Settings().Gci.LocalPrefixes
-		goimportsFlag := lintCtx.Settings().Goimports.LocalPrefixes
-		if localPrefixes == "" && goimportsFlag != "" {
-			localPrefixes = goimportsFlag
+		optionsText := []string{}
+		if lintCtx.Settings().Gci.NoInlineComments {
+			optionsText = append(optionsText, "NoInlineComments")
 		}
-
-		if localPrefixes != "" {
-			text += " with -local " + localPrefixes
+		if lintCtx.Settings().Gci.NoPrefixComments {
+			optionsText = append(optionsText, "NoPrefixComments")
 		}
+		text = fmt.Sprintf("File does not conform to the import format configured for `Gci`(%s)", strings.Join(optionsText, ","))
 	}
 	return text
 }

pkg/golinters/gofmt_common.go

@@ -107,6 +107,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 	var errorlintCfg *config.ErrorLintSettings
 	var exhaustiveCfg *config.ExhaustiveSettings
 	var exhaustiveStructCfg *config.ExhaustiveStructSettings
+	var gciCfg *config.GciSettings
 	var goModDirectivesCfg *config.GoModDirectivesSettings
 	var goMndCfg *config.GoMndSettings
 	var gosecCfg *config.GoSecSettings
@@ -139,6 +140,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		errorlintCfg = &m.cfg.LintersSettings.ErrorLint
 		exhaustiveCfg = &m.cfg.LintersSettings.Exhaustive
 		exhaustiveStructCfg = &m.cfg.LintersSettings.ExhaustiveStruct
+		gciCfg = &m.cfg.LintersSettings.Gci
 		goModDirectivesCfg = &m.cfg.LintersSettings.GoModDirectives
 		goMndCfg = &m.cfg.LintersSettings.Gomnd
 		gosecCfg = &m.cfg.LintersSettings.Gosec
@@ -292,7 +294,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithPresets(linter.PresetComplexity).
 			WithURL("https://github.com/ultraware/funlen"),
 
-		linter.NewConfig(golinters.NewGci()).
+		linter.NewConfig(golinters.NewGci(gciCfg)).
 			WithSince("v1.30.0").
 			WithPresets(linter.PresetFormatting, linter.PresetImport).
 			WithAutoFix().

pkg/lint/lintersdb/manager.go

@@ -92,11 +92,11 @@ func TestGciLocal(t *testing.T) {
 	rc := extractRunContextFromComments(t, sourcePath)
 	args = append(args, rc.args...)
 
-	cfg, err := yaml.Marshal(rc.config)
+	cfg, err := os.ReadFile(rc.configPath)
 	require.NoError(t, err)
 
 	testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
-		ExpectHasIssue("testdata/gci/gci.go:7: File is not `gci`-ed")
+		ExpectHasIssue("testdata/gci/gci.go:9:1: Expected '\\n', Found '\\t'")
 }
 
 func TestMultipleOutputs(t *testing.T) {
@@ -108,11 +108,11 @@ func TestMultipleOutputs(t *testing.T) {
 	rc := extractRunContextFromComments(t, sourcePath)
 	args = append(args, rc.args...)
 
-	cfg, err := yaml.Marshal(rc.config)
+	cfg, err := os.ReadFile(rc.configPath)
 	require.NoError(t, err)
 
 	testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
-		ExpectHasIssue("testdata/gci/gci.go:7: File is not `gci`-ed").
+		ExpectHasIssue("testdata/gci/gci.go:9:1: Expected '\\n', Found '\\t'").
 		ExpectOutputContains(`"Issues":[`)
 }
 
@@ -125,11 +125,11 @@ func TestStderrOutput(t *testing.T) {
 	rc := extractRunContextFromComments(t, sourcePath)
 	args = append(args, rc.args...)
 
-	cfg, err := yaml.Marshal(rc.config)
+	cfg, err := os.ReadFile(rc.configPath)
 	require.NoError(t, err)
 
 	testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
-		ExpectHasIssue("testdata/gci/gci.go:7: File is not `gci`-ed").
+		ExpectHasIssue("testdata/gci/gci.go:9:1: Expected '\\n', Found '\\t'").
 		ExpectOutputContains(`"Issues":[`)
 }
 
@@ -145,11 +145,11 @@ func TestFileOutput(t *testing.T) {
 	rc := extractRunContextFromComments(t, sourcePath)
 	args = append(args, rc.args...)
 
-	cfg, err := yaml.Marshal(rc.config)
+	cfg, err := os.ReadFile(rc.configPath)
 	require.NoError(t, err)
 
 	testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
-		ExpectHasIssue("testdata/gci/gci.go:7: File is not `gci`-ed").
+		ExpectHasIssue("testdata/gci/gci.go:9:1: Expected '\\n', Found '\\t'").
 		ExpectOutputNotContains(`"Issues":[`)
 
 	b, err := os.ReadFile(resultPath)

test/linters_test.go

@@ -0,0 +1,6 @@
+linters-settings:
+  gci:
+    sections:
+      - Standard
+      - Prefix(github.com/golangci/golangci-lint)
+      - Default

test/testdata/configs/gci.yml

@@ -1,10 +1,12 @@
 //args: -Egci
+//config_path: testdata/configs/gci.yml
 package testdata
 
 import (
 	"fmt"
 
 	"github.com/golangci/golangci-lint/pkg/config"
+
 	"github.com/pkg/errors"
 )
 

test/testdata/gci.go

@@ -1,12 +1,11 @@
 //args: -Egci
-//config: linters-settings.gci.local-prefixes=github.com/golangci/golangci-lint
+//config_path: testdata/configs/gci.yml
 package gci
 
 import (
 	"fmt"
 
 	"github.com/golangci/golangci-lint/pkg/config"
-
 	"github.com/pkg/errors"
 )