chore: split shortener.go

Author: ldez

shorten/annotations.go

@@ -0,0 +1,59 @@
+package shorten
+
+import (
+	"strings"
+
+	"github.com/golangci/golines/shorten/internal/annotation"
+)
+
+// annotateLongLines adds specially formatted comments to all eligible lines that
+// are longer than the configured target length.
+// 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
+
+	linesToShorten := 0
+	prevLen := -1
+
+	for _, line := range lines {
+		length := s.lineLen(line)
+
+		if prevLen > -1 {
+			if length <= s.config.MaxLen {
+				// Shortening successful, remove previous annotation
+				annotatedLines = annotatedLines[:len(annotatedLines)-1]
+			} else if length < prevLen {
+				// Replace annotation with a new length
+				annotatedLines[len(annotatedLines)-1] = annotation.Create(length)
+				linesToShorten++
+			}
+		} else if !isComment(line) && length > s.config.MaxLen {
+			annotatedLines = append(
+				annotatedLines,
+				annotation.Create(length),
+			)
+			linesToShorten++
+		}
+
+		annotatedLines = append(annotatedLines, line)
+		prevLen = annotation.Parse(line)
+	}
+
+	return annotatedLines, linesToShorten
+}
+
+// removeAnnotations removes all comments added by the annotateLongLines function above.
+func removeAnnotations(content []byte) []byte {
+	var cleanedLines []string
+
+	lines := strings.SplitSeq(string(content), "\n")
+
+	for line := range lines {
+		if !annotation.Is(line) {
+			cleanedLines = append(cleanedLines, line)
+		}
+	}
+
+	return []byte(strings.Join(cleanedLines, "\n"))
+}

shorten/comments.go

@@ -0,0 +1,89 @@
+package shorten
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/golangci/golines/shorten/internal/annotation"
+)
+
+// Go directive (should be ignored).
+// https://go.dev/doc/comment#syntax
+var directivePattern = regexp.MustCompile(`\s*//(line |extern |export |[a-z0-9]+:[a-z0-9])`)
+
+// shortenCommentsFunc attempts to shorten long comments in the provided source.
+//
+// As noted in the repo README,
+// this functionality has some quirks and is disabled by default.
+func (s *Shortener) shortenCommentsFunc(content []byte) []byte {
+	var cleanedLines []string
+
+	var words []string // all words in a contiguous sequence of long comments
+
+	prefix := ""
+
+	lines := strings.SplitSeq(string(content), "\n")
+	for line := range lines {
+		if isComment(line) && !annotation.Is(line) &&
+			!isDirective(line) &&
+			s.lineLen(line) > s.config.MaxLen {
+			start := strings.Index(line, "//")
+			prefix = line[0:(start + 2)]
+			trimmedLine := strings.Trim(line[(start+2):], " ")
+			currLineWords := strings.Split(trimmedLine, " ")
+			words = append(words, currLineWords...)
+		} else {
+			// Reflow the accumulated `words` before appending the unprocessed `line`.
+			currLineLen := 0
+
+			var currLineWords []string
+
+			maxCommentLen := s.config.MaxLen - s.lineLen(prefix)
+			for _, word := range words {
+				if currLineLen > 0 && currLineLen+1+len(word) > maxCommentLen {
+					cleanedLines = append(
+						cleanedLines,
+						fmt.Sprintf(
+							"%s %s",
+							prefix,
+							strings.Join(currLineWords, " "),
+						),
+					)
+					currLineWords = []string{}
+					currLineLen = 0
+				}
+
+				currLineWords = append(currLineWords, word)
+				currLineLen += 1 + len(word)
+			}
+
+			if currLineLen > 0 {
+				cleanedLines = append(
+					cleanedLines,
+					fmt.Sprintf(
+						"%s %s",
+						prefix,
+						strings.Join(currLineWords, " "),
+					),
+				)
+			}
+
+			words = []string{}
+
+			cleanedLines = append(cleanedLines, line)
+		}
+	}
+
+	return []byte(strings.Join(cleanedLines, "\n"))
+}
+
+// isDirective determines whether the provided line is a directive, e.g., for `go:generate`.
+func isDirective(line string) bool {
+	return directivePattern.MatchString(line)
+}
+
+// isComment determines whether the provided line is a non-block comment.
+func isComment(line string) bool {
+	return strings.HasPrefix(strings.Trim(line, " \t"), "//")
+}