|
| 1 | +package output |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "sort" |
| 6 | + "strings" |
| 7 | +) |
| 8 | + |
| 9 | +// MarkdownTableOutput formats a slice of resources as a GitHub-flavored markdown table. |
| 10 | +func MarkdownTableOutput(items []resource, cols []ColumnDef) string { |
| 11 | + headers := make([]string, len(cols)) |
| 12 | + separators := make([]string, len(cols)) |
| 13 | + for i, col := range cols { |
| 14 | + headers[i] = col.Header |
| 15 | + separators[i] = "---" |
| 16 | + } |
| 17 | + |
| 18 | + var sb strings.Builder |
| 19 | + sb.WriteString("| ") |
| 20 | + sb.WriteString(strings.Join(headers, " | ")) |
| 21 | + sb.WriteString(" |\n| ") |
| 22 | + sb.WriteString(strings.Join(separators, " | ")) |
| 23 | + sb.WriteString(" |") |
| 24 | + |
| 25 | + for _, item := range items { |
| 26 | + vals := make([]string, len(cols)) |
| 27 | + for i, col := range cols { |
| 28 | + vals[i] = escapeMDPipe(colValue(item, col)) |
| 29 | + } |
| 30 | + sb.WriteString("\n| ") |
| 31 | + sb.WriteString(strings.Join(vals, " | ")) |
| 32 | + sb.WriteString(" |") |
| 33 | + } |
| 34 | + |
| 35 | + return sb.String() |
| 36 | +} |
| 37 | + |
| 38 | +// MarkdownKeyValueOutput formats a single resource as a markdown bullet list of key-value pairs. |
| 39 | +func MarkdownKeyValueOutput(r resource, cols []ColumnDef) string { |
| 40 | + lines := make([]string, 0, len(cols)) |
| 41 | + for _, col := range cols { |
| 42 | + val := colValue(r, col) |
| 43 | + lines = append(lines, fmt.Sprintf("- **%s:** %s", col.Header, val)) |
| 44 | + } |
| 45 | + return strings.Join(lines, "\n") |
| 46 | +} |
| 47 | + |
| 48 | +// MarkdownSingularOutput renders a single resource in markdown with a heading and metadata. |
| 49 | +// For flags it produces a rich view with environment table; for other resources it uses |
| 50 | +// the column registry or a generic fallback. |
| 51 | +func MarkdownSingularOutput(r resource, resourceName string) string { |
| 52 | + if resourceName == "flags" { |
| 53 | + return markdownFlagOutput(r) |
| 54 | + } |
| 55 | + |
| 56 | + heading := markdownHeading(r) |
| 57 | + if cols := GetSingularColumns(resourceName); cols != nil { |
| 58 | + return heading + "\n\n" + MarkdownKeyValueOutput(r, cols) |
| 59 | + } |
| 60 | + return heading |
| 61 | +} |
| 62 | + |
| 63 | +// MarkdownMultipleOutput renders a list of resources as a markdown table (if columns are |
| 64 | +// registered) or a bullet list. |
| 65 | +func MarkdownMultipleOutput(items []resource, resourceName string) string { |
| 66 | + if cols := GetListColumns(resourceName); cols != nil { |
| 67 | + return MarkdownTableOutput(items, cols) |
| 68 | + } |
| 69 | + |
| 70 | + lines := make([]string, 0, len(items)) |
| 71 | + for _, item := range items { |
| 72 | + lines = append(lines, fmt.Sprintf("- %s", SingularPlaintextOutputFn(item))) |
| 73 | + } |
| 74 | + return strings.Join(lines, "\n") |
| 75 | +} |
| 76 | + |
| 77 | +func markdownFlagOutput(r resource) string { |
| 78 | + var sb strings.Builder |
| 79 | + |
| 80 | + key := defaultFormat(r["key"]) |
| 81 | + sb.WriteString("## ") |
| 82 | + sb.WriteString(key) |
| 83 | + |
| 84 | + if desc, ok := r["description"]; ok && desc != nil && fmt.Sprint(desc) != "" { |
| 85 | + sb.WriteString("\n\n") |
| 86 | + sb.WriteString(fmt.Sprint(desc)) |
| 87 | + } |
| 88 | + |
| 89 | + envTable := markdownEnvTable(r) |
| 90 | + if envTable != "" { |
| 91 | + sb.WriteString("\n\n") |
| 92 | + sb.WriteString(envTable) |
| 93 | + } |
| 94 | + |
| 95 | + if meta := markdownFlagMetadata(r); meta != "" { |
| 96 | + sb.WriteString("\n\n") |
| 97 | + sb.WriteString(meta) |
| 98 | + } |
| 99 | + |
| 100 | + return sb.String() |
| 101 | +} |
| 102 | + |
| 103 | +func markdownEnvTable(r resource) string { |
| 104 | + envMap, ok := r["environments"].(map[string]interface{}) |
| 105 | + if !ok || len(envMap) == 0 { |
| 106 | + return "" |
| 107 | + } |
| 108 | + |
| 109 | + variations := extractVariations(r) |
| 110 | + |
| 111 | + keys := make([]string, 0, len(envMap)) |
| 112 | + for k := range envMap { |
| 113 | + keys = append(keys, k) |
| 114 | + } |
| 115 | + sort.Strings(keys) |
| 116 | + |
| 117 | + var sb strings.Builder |
| 118 | + sb.WriteString("| Environment | Status | Fallthrough | Rules |\n") |
| 119 | + sb.WriteString("| --- | --- | --- | --- |") |
| 120 | + |
| 121 | + for _, envKey := range keys { |
| 122 | + envData, ok := envMap[envKey].(map[string]interface{}) |
| 123 | + if !ok { |
| 124 | + continue |
| 125 | + } |
| 126 | + |
| 127 | + status := "OFF" |
| 128 | + if on, ok := envData["on"].(bool); ok && on { |
| 129 | + status = "ON" |
| 130 | + } |
| 131 | + |
| 132 | + fallthrough_ := resolveFallthrough(envData, variations) |
| 133 | + |
| 134 | + rulesCount := 0 |
| 135 | + if rules, ok := envData["rules"].([]interface{}); ok { |
| 136 | + rulesCount = len(rules) |
| 137 | + } |
| 138 | + |
| 139 | + sb.WriteString(fmt.Sprintf("\n| %s | %s | %s | %d |", |
| 140 | + escapeMDPipe(envKey), status, escapeMDPipe(fallthrough_), rulesCount)) |
| 141 | + } |
| 142 | + |
| 143 | + return sb.String() |
| 144 | +} |
| 145 | + |
| 146 | +func markdownFlagMetadata(r resource) string { |
| 147 | + var lines []string |
| 148 | + |
| 149 | + if kind := r["kind"]; kind != nil { |
| 150 | + lines = append(lines, fmt.Sprintf("- **Kind:** %s", kind)) |
| 151 | + } |
| 152 | + if temp, ok := r["temporary"].(bool); ok { |
| 153 | + lines = append(lines, fmt.Sprintf("- **Temporary:** %s", boolYesNo(temp))) |
| 154 | + } |
| 155 | + if tags, ok := r["tags"].([]interface{}); ok && len(tags) > 0 { |
| 156 | + strs := make([]string, len(tags)) |
| 157 | + for i, t := range tags { |
| 158 | + strs[i] = fmt.Sprint(t) |
| 159 | + } |
| 160 | + lines = append(lines, fmt.Sprintf("- **Tags:** %s", strings.Join(strs, ", "))) |
| 161 | + } |
| 162 | + if maintainer := extractMaintainer(r); maintainer != "" { |
| 163 | + lines = append(lines, fmt.Sprintf("- **Maintainer:** %s", maintainer)) |
| 164 | + } |
| 165 | + |
| 166 | + return strings.Join(lines, "\n") |
| 167 | +} |
| 168 | + |
| 169 | +func extractVariations(r resource) []variation { |
| 170 | + raw, ok := r["variations"].([]interface{}) |
| 171 | + if !ok { |
| 172 | + return nil |
| 173 | + } |
| 174 | + vars := make([]variation, 0, len(raw)) |
| 175 | + for _, v := range raw { |
| 176 | + m, ok := v.(map[string]interface{}) |
| 177 | + if !ok { |
| 178 | + continue |
| 179 | + } |
| 180 | + name := "" |
| 181 | + if n, ok := m["name"].(string); ok { |
| 182 | + name = n |
| 183 | + } |
| 184 | + vars = append(vars, variation{ |
| 185 | + Name: name, |
| 186 | + Value: m["value"], |
| 187 | + }) |
| 188 | + } |
| 189 | + return vars |
| 190 | +} |
| 191 | + |
| 192 | +type variation struct { |
| 193 | + Name string |
| 194 | + Value interface{} |
| 195 | +} |
| 196 | + |
| 197 | +func resolveFallthrough(envData map[string]interface{}, variations []variation) string { |
| 198 | + ft, ok := envData["fallthrough"].(map[string]interface{}) |
| 199 | + if !ok { |
| 200 | + return "" |
| 201 | + } |
| 202 | + varIdx, ok := ft["variation"].(float64) |
| 203 | + if !ok { |
| 204 | + return "" |
| 205 | + } |
| 206 | + idx := int(varIdx) |
| 207 | + if idx < 0 || idx >= len(variations) { |
| 208 | + return fmt.Sprintf("variation %d", idx) |
| 209 | + } |
| 210 | + v := variations[idx] |
| 211 | + if v.Name != "" { |
| 212 | + return fmt.Sprintf("%s (%v)", v.Name, v.Value) |
| 213 | + } |
| 214 | + return fmt.Sprintf("%v", v.Value) |
| 215 | +} |
| 216 | + |
| 217 | +func extractMaintainer(r resource) string { |
| 218 | + m, ok := r["_maintainer"].(map[string]interface{}) |
| 219 | + if !ok { |
| 220 | + return "" |
| 221 | + } |
| 222 | + if name, ok := m["name"].(string); ok && name != "" { |
| 223 | + return name |
| 224 | + } |
| 225 | + if email, ok := m["email"].(string); ok && email != "" { |
| 226 | + return email |
| 227 | + } |
| 228 | + return "" |
| 229 | +} |
| 230 | + |
| 231 | +func markdownHeading(r resource) string { |
| 232 | + key := r["key"] |
| 233 | + name := r["name"] |
| 234 | + switch { |
| 235 | + case name != nil && key != nil: |
| 236 | + return fmt.Sprintf("## %s (%s)", fmt.Sprint(name), fmt.Sprint(key)) |
| 237 | + case name != nil: |
| 238 | + return fmt.Sprintf("## %s", fmt.Sprint(name)) |
| 239 | + case key != nil: |
| 240 | + return fmt.Sprintf("## %s", fmt.Sprint(key)) |
| 241 | + default: |
| 242 | + return "## (unknown)" |
| 243 | + } |
| 244 | +} |
| 245 | + |
| 246 | +func escapeMDPipe(s string) string { |
| 247 | + return strings.ReplaceAll(s, "|", "\\|") |
| 248 | +} |
0 commit comments