| 1 |
package format |
| 2 |
|
| 3 |
import ( |
| 4 |
"fmt" |
| 5 |
"strings" |
| 6 |
|
| 7 |
"github.com/nicholas-fedor/shoutrrr/pkg/color" |
| 8 |
"github.com/nicholas-fedor/shoutrrr/pkg/util" |
| 9 |
) |
| 10 |
|
| 11 |
// ConsoleTreeRenderer renders a ContainerNode tree into an ansi-colored console string. |
| 12 |
type ConsoleTreeRenderer struct { |
| 13 |
WithValues bool |
| 14 |
} |
| 15 |
|
| 16 |
// Constants for console rendering. |
| 17 |
const ( |
| 18 |
DescriptionColumnWidth = 60 // Width of the description column in console output |
| 19 |
ItemSeparatorLength = 2 // Length of the ", " separator between container items |
| 20 |
DefaultValueOffset = 16 // Minimum offset before description when no values are shown |
| 21 |
ValueOffset = 30 // Offset before description when values are shown |
| 22 |
ContainerBracketLength = 4 // Length of container delimiters (e.g., "{ }" or "[ ]") |
| 23 |
KeySeparatorLength = 2 // Length of the ": " separator after a key in containers |
| 24 |
) |
| 25 |
|
| 26 |
// RenderTree renders a ContainerNode tree into an ansi-colored console string. |
| 27 |
func (r ConsoleTreeRenderer) RenderTree(root *ContainerNode, _ string) string { |
| 28 |
stringBuilder := strings.Builder{} |
| 29 |
|
| 30 |
for _, node := range root.Items { |
| 31 |
fieldKey := node.Field().Name |
| 32 |
stringBuilder.WriteString(fieldKey) |
| 33 |
|
| 34 |
for i := len(fieldKey); i <= root.MaxKeyLength; i++ { |
| 35 |
stringBuilder.WriteRune(' ') |
| 36 |
} |
| 37 |
|
| 38 |
var valueLen int // Initialize without assignment; set later |
| 39 |
|
| 40 |
preLen := DefaultValueOffset // Default spacing before the description when no values are rendered |
| 41 |
|
| 42 |
field := node.Field() |
| 43 |
|
| 44 |
if r.WithValues { |
| 45 |
preLen = ValueOffset // Adjusts the spacing when values are included |
| 46 |
valueLen = r.writeNodeValue(&stringBuilder, node) |
| 47 |
} else { |
| 48 |
// Since no values were supplied, substitute the value with the type |
| 49 |
typeName := field.Type.String() |
| 50 |
|
| 51 |
// If the value is an enum type, providing the name is a bit pointless |
| 52 |
// Instead, use a common string "option" to signify the type |
| 53 |
if field.EnumFormatter != nil { |
| 54 |
typeName = "option" |
| 55 |
} |
| 56 |
|
| 57 |
valueLen = len(typeName) |
| 58 |
stringBuilder.WriteString(color.CyanString(typeName)) |
| 59 |
} |
| 60 |
|
| 61 |
stringBuilder.WriteString(strings.Repeat(" ", util.Max(preLen-valueLen, 1))) |
| 62 |
stringBuilder.WriteString(ColorizeDesc(field.Description)) |
| 63 |
stringBuilder.WriteString( |
| 64 |
strings.Repeat(" ", util.Max(DescriptionColumnWidth-len(field.Description), 1)), |
| 65 |
) |
| 66 |
|
| 67 |
if len(field.URLParts) > 0 && field.URLParts[0] != URLQuery { |
| 68 |
stringBuilder.WriteString(" <URL: ") |
| 69 |
|
| 70 |
for i, part := range field.URLParts { |
| 71 |
if i > 0 { |
| 72 |
stringBuilder.WriteString(", ") |
| 73 |
} |
| 74 |
|
| 75 |
if part > URLPath { |
| 76 |
part = URLPath |
| 77 |
} |
| 78 |
|
| 79 |
stringBuilder.WriteString(ColorizeEnum(part)) |
| 80 |
} |
| 81 |
|
| 82 |
stringBuilder.WriteString(">") |
| 83 |
} |
| 84 |
|
| 85 |
if field.Template != "" { |
| 86 |
fmt.Fprintf(&stringBuilder, " <Template: %s>", ColorizeString(field.Template)) |
| 87 |
} |
| 88 |
|
| 89 |
if field.DefaultValue != "" { |
| 90 |
fmt.Fprintf(&stringBuilder, " <Default: %s>", |
| 91 |
ColorizeValue(field.DefaultValue, field.EnumFormatter != nil)) |
| 92 |
} |
| 93 |
|
| 94 |
if field.Required { |
| 95 |
fmt.Fprintf(&stringBuilder, " <%s>", ColorizeFalse("Required")) |
| 96 |
} |
| 97 |
|
| 98 |
if len(field.Keys) > 1 { |
| 99 |
stringBuilder.WriteString(" <Aliases: ") |
| 100 |
|
| 101 |
for i, key := range field.Keys { |
| 102 |
if i == 0 { |
| 103 |
// Skip primary alias (as it's the same as the field name) |
| 104 |
continue |
| 105 |
} |
| 106 |
|
| 107 |
if i > 1 { |
| 108 |
stringBuilder.WriteString(", ") |
| 109 |
} |
| 110 |
|
| 111 |
stringBuilder.WriteString(ColorizeString(key)) |
| 112 |
} |
| 113 |
|
| 114 |
stringBuilder.WriteString(">") |
| 115 |
} |
| 116 |
|
| 117 |
if field.EnumFormatter != nil { |
| 118 |
stringBuilder.WriteString(ColorizeContainer(" [")) |
| 119 |
|
| 120 |
for i, name := range field.EnumFormatter.Names() { |
| 121 |
if i != 0 { |
| 122 |
stringBuilder.WriteString(", ") |
| 123 |
} |
| 124 |
|
| 125 |
stringBuilder.WriteString(ColorizeEnum(name)) |
| 126 |
} |
| 127 |
|
| 128 |
stringBuilder.WriteString(ColorizeContainer("]")) |
| 129 |
} |
| 130 |
|
| 131 |
stringBuilder.WriteRune('\n') |
| 132 |
} |
| 133 |
|
| 134 |
return stringBuilder.String() |
| 135 |
} |
| 136 |
|
| 137 |
func (r ConsoleTreeRenderer) writeContainer( |
| 138 |
stringBuilder *strings.Builder, |
| 139 |
node *ContainerNode, |
| 140 |
) int { |
| 141 |
kind := node.Type.Kind() |
| 142 |
hasKeys := !util.IsCollection(kind) |
| 143 |
|
| 144 |
totalLen := ContainerBracketLength // Length of the opening and closing brackets ({ } or [ ]) |
| 145 |
|
| 146 |
if hasKeys { |
| 147 |
stringBuilder.WriteString("{ ") |
| 148 |
} else { |
| 149 |
stringBuilder.WriteString("[ ") |
| 150 |
} |
| 151 |
|
| 152 |
for i, itemNode := range node.Items { |
| 153 |
if i != 0 { |
| 154 |
stringBuilder.WriteString(", ") |
| 155 |
|
| 156 |
totalLen += KeySeparatorLength // Accounts for the : separator between keys and values in containers |
| 157 |
} |
| 158 |
|
| 159 |
if hasKeys { |
| 160 |
itemKey := itemNode.Field().Name |
| 161 |
stringBuilder.WriteString(itemKey) |
| 162 |
stringBuilder.WriteString(": ") |
| 163 |
|
| 164 |
totalLen += len(itemKey) + ItemSeparatorLength |
| 165 |
} |
| 166 |
|
| 167 |
valLen := r.writeNodeValue(stringBuilder, itemNode) |
| 168 |
totalLen += valLen |
| 169 |
} |
| 170 |
|
| 171 |
if hasKeys { |
| 172 |
stringBuilder.WriteString(" }") |
| 173 |
} else { |
| 174 |
stringBuilder.WriteString(" ]") |
| 175 |
} |
| 176 |
|
| 177 |
return totalLen |
| 178 |
} |
| 179 |
|
| 180 |
func (r ConsoleTreeRenderer) writeNodeValue(stringBuilder *strings.Builder, node Node) int { |
| 181 |
if contNode, isContainer := node.(*ContainerNode); isContainer { |
| 182 |
return r.writeContainer(stringBuilder, contNode) |
| 183 |
} |
| 184 |
|
| 185 |
if valNode, isValue := node.(*ValueNode); isValue { |
| 186 |
stringBuilder.WriteString(ColorizeToken(valNode.Value, valNode.tokenType)) |
| 187 |
|
| 188 |
return len(valNode.Value) |
| 189 |
} |
| 190 |
|
| 191 |
stringBuilder.WriteByte('?') |
| 192 |
|
| 193 |
return 1 |
| 194 |
} |