chore: simplify and explain end of the rounds

Author: ldez

shorten/annotations.go

@@ -13,9 +13,11 @@ import (
 // If a line already has one of these comments from a previous shortening round,
 // then the comment contents are updated.
 func (s *Shortener) annotateLongLines(lines []string) ([]string, int) {
-	var annotatedLines []string
+	var (
+		annotatedLines   []string
+		nbLinesToShorten int
+	)
 
-	linesToShorten := 0
 	prevLen := -1
 
 	for _, line := range lines {
@@ -28,21 +30,23 @@ func (s *Shortener) annotateLongLines(lines []string) ([]string, int) {
 			} else if length < prevLen {
 				// Replace annotation with a new length
 				annotatedLines[len(annotatedLines)-1] = annotation.Create(length)
-				linesToShorten++
+
+				nbLinesToShorten++
 			}
 		} else if !comments.Is(line) && length > s.config.MaxLen {
 			annotatedLines = append(
 				annotatedLines,
 				annotation.Create(length),
 			)
-			linesToShorten++
+
+			nbLinesToShorten++
 		}
 
 		annotatedLines = append(annotatedLines, line)
 		prevLen = annotation.Parse(line)
 	}
 
-	return annotatedLines, linesToShorten
+	return annotatedLines, nbLinesToShorten
 }
 
 // removeAnnotations removes all comments added by the annotateLongLines function above.

shorten/internal/tags/tags.go

@@ -14,9 +14,9 @@ import (
 
 var structTagRegexp = regexp.MustCompile("`([ ]*[a-zA-Z0-9_-]+:\".*\"[ ]*){2,}`")
 
-// HasMultipleTags returns whether the given lines have a multikey struct line.
+// HasMultipleEntries returns whether the given lines have a multi-entries struct line.
 // It's used as an optimization step to avoid unnecessary shortening rounds.
-func HasMultipleTags(lines []string) bool {
+func HasMultipleEntries(lines []string) bool {
 	return slices.ContainsFunc(lines, structTagRegexp.MatchString)
 }
 

shorten/internal/tags/tags_test.go

@@ -7,7 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestHasMultipleTags(t *testing.T) {
+func TestHasMultipleEntries(t *testing.T) {
 	testCases := []struct {
 		desc   string
 		lines  []string
@@ -55,7 +55,7 @@ func TestHasMultipleTags(t *testing.T) {
 		t.Run(test.desc, func(t *testing.T) {
 			t.Parallel()
 
-			test.assert(t, HasMultipleTags(test.lines))
+			test.assert(t, HasMultipleEntries(test.lines))
 		})
 	}
 }

shorten/shortener.go

@@ -120,21 +120,9 @@ func (s *Shortener) Process(content []byte) ([]byte, error) {
 
 		// Annotate all long lines
 		lines := strings.Split(string(content), "\n")
-		annotatedLines, linesToShorten := s.annotateLongLines(lines)
+		annotatedLines, nbLinesToShorten := s.annotateLongLines(lines)
 
-		var stop bool
-
-		if linesToShorten == 0 {
-			if round == 0 {
-				if !s.config.ReformatTags || !tags.HasMultipleTags(lines) {
-					stop = true
-				}
-			} else {
-				stop = true
-			}
-		}
-
-		if stop {
+		if !s.shouldContinue(nbLinesToShorten, round, lines) {
 			s.logger.Debug("nothing more to shorten or reformat, stopping")
 
 			break
@@ -194,6 +182,16 @@ func (s *Shortener) Process(content []byte) ([]byte, error) {
 	return content, nil
 }
 
+// shouldContinue returns true:
+// if there are lines to shorten,
+// or if this is the first round (0),
+// and the option to reformat struct tags is enabled,
+// and there are struct tags with multiple entries.
+func (s *Shortener) shouldContinue(nbLinesToShorten, round int, lines []string) bool {
+	return nbLinesToShorten > 0 ||
+		round == 0 && s.config.ReformatTags && tags.HasMultipleEntries(lines)
+}
+
 func (s *Shortener) createDot(result dst.Node) error {
 	dotFile, err := os.Create(s.config.DotFile)
 	if err != nil {