fix bugs when sections mismatch (#94)

Signed-off-by: Loong <[email protected]>

Author: daixiang0

pkg/config/config.go

@@ -11,11 +11,11 @@ import (
 )
 
 var defaultOrder = map[string]int{
-	"standard": 0,
-	"default":  1,
-	"custom":   2,
-	"blank":    3,
-	"dot":      4,
+	section.StandardType: 0,
+	section.DefaultType:  1,
+	section.CustomType:   2,
+	section.BlankType:    3,
+	section.DotType:      4,
 }
 
 type BoolConfig struct {
@@ -52,16 +52,11 @@ func (g YamlConfig) Parse() (*Config, error) {
 	// if default order sorted sections
 	if !g.Cfg.CustomOrder {
 		sort.Slice(sections, func(i, j int) bool {
-			sectionI, sectionJ := sections[i].String(), sections[j].String()
+			sectionI, sectionJ := sections[i].Type(), sections[j].Type()
 
-			if strings.HasPrefix(sectionI, "prefix(") {
-				sectionI = "custom"
+			if strings.Compare(sectionI, sectionJ) == 0 {
+				return strings.Compare(sections[i].String(), sections[j].String()) < 0
 			}
-
-			if strings.HasPrefix(sectionJ, "prefix(") {
-				sectionJ = "custom"
-			}
-
 			return defaultOrder[sectionI] < defaultOrder[sectionJ]
 		})
 	}

pkg/config/config_test.go

@@ -14,7 +14,6 @@ var testFilesPath = "../gci/internal/testdata"
 func TestInitGciConfigFromEmptyYAML(t *testing.T) {
 	gciCfg, err := InitializeGciConfigFromYAML(path.Join(testFilesPath, "defaultValues.cfg.yaml"))
 	assert.NoError(t, err)
-	_ = gciCfg
 	assert.Equal(t, section.DefaultSections(), gciCfg.Sections)
 	assert.Equal(t, section.DefaultSectionSeparators(), gciCfg.SectionSeparators)
 	assert.False(t, gciCfg.Debug)
@@ -25,9 +24,30 @@ func TestInitGciConfigFromEmptyYAML(t *testing.T) {
 func TestInitGciConfigFromYAML(t *testing.T) {
 	gciCfg, err := InitializeGciConfigFromYAML(path.Join(testFilesPath, "configTest.cfg.yaml"))
 	assert.NoError(t, err)
-	_ = gciCfg
 	assert.Equal(t, section.SectionList{section.Default{}}, gciCfg.Sections)
 	assert.False(t, gciCfg.Debug)
 	assert.True(t, gciCfg.SkipGenerated)
 	assert.False(t, gciCfg.CustomOrder)
 }
+
+// the custom sections sort alphabetically as default.
+func TestParseOrder(t *testing.T) {
+	cfg := YamlConfig{
+		SectionStrings: []string{"default", "prefix(github/daixiang0/gci)", "prefix(github/daixiang0/gai)"},
+	}
+	gciCfg, err := cfg.Parse()
+	assert.NoError(t, err)
+	assert.Equal(t, section.SectionList{section.Default{}, section.Custom{Prefix: "github/daixiang0/gai"}, section.Custom{Prefix: "github/daixiang0/gci"}}, gciCfg.Sections)
+}
+
+func TestParseCustomOrder(t *testing.T) {
+	cfg := YamlConfig{
+		SectionStrings: []string{"default", "prefix(github/daixiang0/gci)", "prefix(github/daixiang0/gai)"},
+		Cfg: BoolConfig{
+			CustomOrder: true,
+		},
+	}
+	gciCfg, err := cfg.Parse()
+	assert.NoError(t, err)
+	assert.Equal(t, section.SectionList{section.Default{}, section.Custom{Prefix: "github/daixiang0/gci"}, section.Custom{Prefix: "github/daixiang0/gai"}}, gciCfg.Sections)
+}

pkg/gci/gci.go

@@ -5,8 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"sort"
-	"strings"
 	"sync"
 
 	"github.com/hexops/gotextdiff"
@@ -143,39 +141,12 @@ func LoadFormatGoFile(file io.FileObj, cfg config.Config) (src, dist []byte, err
 	head := src[:headEnd]
 	tail := src[tailStart:]
 
-	// sort for custom sections
-	customKeys := make([]string, 0, len(result))
-	for k := range result {
-		if strings.HasPrefix(k, "prefix(") {
-			customKeys = append(customKeys, k)
-		}
-	}
-
 	firstWithIndex := true
 
 	var body []byte
 
 	// order by section list
 	for _, s := range cfg.Sections {
-		if strings.HasPrefix(s.String(), "prefix(") {
-			if len(customKeys) > 0 {
-				if body != nil && len(body) > 0 {
-					body = append(body, utils.Linebreak)
-				}
-				sort.Sort(sort.StringSlice(customKeys))
-				for _, k := range customKeys {
-					if !strings.Contains(s.String(), k) {
-						continue
-					}
-					for _, d := range result[k] {
-						AddIndent(&body, &firstWithIndex)
-						body = append(body, src[d.Start:d.End]...)
-					}
-				}
-			}
-
-			continue
-		}
 		if len(result[s.String()]) > 0 {
 			if body != nil && len(body) > 0 {
 				body = append(body, utils.Linebreak)

pkg/gci/internal/testdata/mismatch-section.cfg.yaml

@@ -0,0 +1,5 @@
+sections:
+  - Standard
+  - Default
+  - Prefix(github.com/daixiang0)
+  - Prefix(github.com/daixiang0/gci)

pkg/gci/internal/testdata/mismatch-section.in.go

@@ -0,0 +1,8 @@
+package main
+import (
+	"fmt"
+
+	g "github.com/golang"
+
+	"github.com/daixiang0/gci"
+)

pkg/gci/internal/testdata/mismatch-section.out.go

@@ -0,0 +1,8 @@
+package main
+import (
+	"fmt"
+
+	g "github.com/golang"
+
+	"github.com/daixiang0/gci"
+)

pkg/section/blank.go

@@ -7,6 +7,8 @@ import (
 
 type Blank struct{}
 
+const BlankType = "blank"
+
 func (b Blank) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity {
 	if spec.Name == "_" {
 		return specificity.NameMatch{}
@@ -15,5 +17,9 @@ func (b Blank) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecifi
 }
 
 func (b Blank) String() string {
-	return "blank"
+	return BlankType
+}
+
+func (b Blank) Type() string {
+	return BlankType
 }

pkg/section/commentline.go

@@ -18,3 +18,7 @@ func (c CommentLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchS
 func (c CommentLine) String() string {
 	return fmt.Sprintf("commentline(%s)", c.Comment)
 }
+
+func (c CommentLine) Type() string {
+	return "commentline"
+}

pkg/section/default.go

@@ -5,7 +5,7 @@ import (
 	"github.com/daixiang0/gci/pkg/specificity"
 )
 
-const defaultName = "default"
+const DefaultType = "default"
 
 type Default struct{}
 
@@ -14,5 +14,9 @@ func (d Default) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpeci
 }
 
 func (d Default) String() string {
-	return defaultName
+	return DefaultType
+}
+
+func (d Default) Type() string {
+	return DefaultType
 }

pkg/section/dot.go

@@ -7,6 +7,8 @@ import (
 
 type Dot struct{}
 
+const DotType = "dot"
+
 func (d Dot) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity {
 	if spec.Name == "." {
 		return specificity.NameMatch{}
@@ -15,5 +17,9 @@ func (d Dot) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecifici
 }
 
 func (d Dot) String() string {
-	return "dot"
+	return DotType
+}
+
+func (d Dot) Type() string {
+	return DotType
 }

pkg/section/newline.go

@@ -16,3 +16,7 @@ func (n NewLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpeci
 func (n NewLine) String() string {
 	return newLineName
 }
+
+func (n NewLine) Type() string {
+	return newLineName
+}

pkg/section/prefix.go

@@ -12,6 +12,8 @@ type Custom struct {
 	Prefix string
 }
 
+const CustomType = "custom"
+
 func (c Custom) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity {
 	if strings.HasPrefix(spec.Path, c.Prefix) {
 		return specificity.Match{Length: len(c.Prefix)}
@@ -22,3 +24,7 @@ func (c Custom) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecif
 func (c Custom) String() string {
 	return fmt.Sprintf("prefix(%s)", c.Prefix)
 }
+
+func (c Custom) Type() string {
+	return CustomType
+}

pkg/section/section.go

@@ -12,6 +12,9 @@ type Section interface {
 
 	// String Implements the stringer interface
 	String() string
+
+	// return section type
+	Type() string
 }
 
 type SectionList []Section

pkg/section/standard.go

@@ -5,7 +5,7 @@ import (
 	"github.com/daixiang0/gci/pkg/specificity"
 )
 
-const StandardName = "standard"
+const StandardType = "standard"
 
 type Standard struct{}
 
@@ -17,7 +17,11 @@ func (s Standard) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpec
 }
 
 func (s Standard) String() string {
-	return StandardName
+	return StandardType
+}
+
+func (s Standard) Type() string {
+	return StandardType
 }
 
 func isStandard(pkg string) bool {