111

Author: lvan100

textstyle/textstyle.go

@@ -21,6 +21,9 @@ import (
 	"fmt"
 )
 
+// Attribute represents a console text attribute (color or style).
+type Attribute string
+
 const (
 	Bold         Attribute = "1"
 	Italic       Attribute = "3"
@@ -29,6 +32,7 @@ const (
 	CrossedOut   Attribute = "9"
 )
 
+// Foreground colors
 const (
 	Black   Attribute = "30"
 	Red     Attribute = "31"
@@ -40,6 +44,7 @@ const (
 	White   Attribute = "37"
 )
 
+// Background colors
 const (
 	BgBlack   Attribute = "40"
 	BgRed     Attribute = "41"
@@ -51,51 +56,54 @@ const (
 	BgWhite   Attribute = "47"
 )
 
-type Attribute string
-
-// Sprint returns a string formatted according to console properties.
+// Sprint formats a string with this Attribute.
 func (attr Attribute) Sprint(a ...any) string {
 	return wrap([]Attribute{attr}, fmt.Sprint(a...))
 }
 
-// Sprintf returns a string formatted according to console properties.
+// Sprintf formats a string with this Attribute using fmt.Sprintf syntax.
 func (attr Attribute) Sprintf(format string, a ...any) string {
 	return wrap([]Attribute{attr}, fmt.Sprintf(format, a...))
 }
 
+// Text represents a collection of console text attributes.
 type Text struct {
 	attributes []Attribute
 }
 
-// NewText returns a new *Text.
+// NewText creates a new Text with the given attributes.
 func NewText(attributes ...Attribute) *Text {
 	return &Text{attributes: attributes}
 }
 
-// Sprint returns a string formatted according to console properties.
+// Sprint formats a string using the Text's attributes.
 func (c *Text) Sprint(a ...any) string {
 	return wrap(c.attributes, fmt.Sprint(a...))
 }
 
-// Sprintf returns a string formatted according to console properties.
+// Sprintf formats a string using the Text's attributes and fmt.Sprintf syntax.
 func (c *Text) Sprintf(format string, a ...any) string {
 	return wrap(c.attributes, fmt.Sprintf(format, a...))
 }
 
+// wrap wraps the given string with ANSI escape codes for the provided attributes.
 func wrap(attributes []Attribute, str string) string {
 	if len(attributes) == 0 {
 		return str
 	}
+
 	var buf bytes.Buffer
-	buf.WriteString("\x1b[")
-	for i := range len(attributes) {
+	buf.WriteString("\x1b[") // Start ANSI escape code
+
+	for i := range attributes {
 		buf.WriteString(string(attributes[i]))
 		if i < len(attributes)-1 {
-			buf.WriteByte(';')
+			buf.WriteByte(';') // Separate multiple attributes with ';'
 		}
 	}
-	buf.WriteByte('m')
-	buf.WriteString(str)
-	buf.WriteString("\x1b[0m")
+
+	buf.WriteByte('m')         // End of ANSI escape code
+	buf.WriteString(str)       // Add the actual string
+	buf.WriteString("\x1b[0m") // Reset all attributes
 	return buf.String()
 }