File: render_markdown.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.8.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,332 kB
  • sloc: sh: 61; makefile: 5
file content (259 lines) | stat: -rw-r--r-- 6,291 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
package format

import (
	"reflect"
	"sort"
	"strings"
)

// MarkdownTreeRenderer renders a ContainerNode tree into a markdown documentation string.
type MarkdownTreeRenderer struct {
	HeaderPrefix      string
	PropsDescription  string
	PropsEmptyMessage string
}

// Constants for dynamic path segment offsets.
const (
	PathOffset1 = 1
	PathOffset2 = 2
	PathOffset3 = 3
)

// RenderTree renders a ContainerNode tree into a markdown documentation string.
func (r MarkdownTreeRenderer) RenderTree(root *ContainerNode, scheme string) string {
	stringBuilder := strings.Builder{}

	queryFields := make([]*FieldInfo, 0, len(root.Items))
	urlFields := make([]*FieldInfo, 0, len(root.Items)) // Zero length, capacity for all fields
	dynamicURLFields := make([]*FieldInfo, 0, len(root.Items))

	for _, node := range root.Items {
		field := node.Field()
		for _, urlPart := range field.URLParts {
			switch urlPart {
			case URLQuery:
				queryFields = append(queryFields, field)
			case URLPath + PathOffset1,
				URLPath + PathOffset2,
				URLPath + PathOffset3:
				dynamicURLFields = append(dynamicURLFields, field)
			case URLUser, URLPassword, URLHost, URLPort, URLPath:
				urlFields = append(urlFields, field)
			}
		}

		if len(field.URLParts) < 1 {
			queryFields = append(queryFields, field)
		}
	}

	// Append dynamic fields to urlFields
	urlFields = append(urlFields, dynamicURLFields...)

	// Sort by primary URLPart
	sort.SliceStable(urlFields, func(i, j int) bool {
		urlPartA := URLQuery
		if len(urlFields[i].URLParts) > 0 {
			urlPartA = urlFields[i].URLParts[0]
		}

		urlPartB := URLQuery
		if len(urlFields[j].URLParts) > 0 {
			urlPartB = urlFields[j].URLParts[0]
		}

		return urlPartA < urlPartB
	})

	r.writeURLFields(&stringBuilder, urlFields, scheme)

	sort.SliceStable(queryFields, func(i, j int) bool {
		return queryFields[i].Required && !queryFields[j].Required
	})

	r.writeHeader(&stringBuilder, "Query/Param Props")

	if len(queryFields) > 0 {
		stringBuilder.WriteString(r.PropsDescription)
	} else {
		stringBuilder.WriteString(r.PropsEmptyMessage)
	}

	stringBuilder.WriteRune('\n')

	for _, field := range queryFields {
		r.writeFieldPrimary(&stringBuilder, field)
		r.writeFieldExtras(&stringBuilder, field)
		stringBuilder.WriteRune('\n')
	}

	return stringBuilder.String()
}

func (r MarkdownTreeRenderer) writeURLFields(
	stringBuilder *strings.Builder,
	urlFields []*FieldInfo,
	scheme string,
) {
	fieldsPrinted := make(map[string]bool)

	r.writeHeader(stringBuilder, "URL Fields")

	for _, field := range urlFields {
		if field == nil || fieldsPrinted[field.Name] {
			continue
		}

		r.writeFieldPrimary(stringBuilder, field)

		stringBuilder.WriteString("  URL part: <code class=\"service-url\">")
		stringBuilder.WriteString(scheme)
		stringBuilder.WriteString("://")

		// Check for presence of URLUser or URLPassword
		hasUser := false
		hasPassword := false
		maxPart := URLUser // Track the highest URLPart used

		for _, f := range urlFields {
			if f != nil {
				for _, part := range f.URLParts {
					switch part {
					case URLQuery, URLHost, URLPort, URLPath: // No-op for these cases
					case URLUser:
						hasUser = true
					case URLPassword:
						hasPassword = true
					}

					if part > maxPart {
						maxPart = part
					}
				}
			}
		}

		// Build URL with this field highlighted
		for i := URLUser; i <= URLPath+PathOffset3; i++ {
			urlPart := i
			for _, fieldInfo := range urlFields {
				if fieldInfo != nil && fieldInfo.IsURLPart(urlPart) {
					if i > URLUser {
						lastPart := i - 1
						if lastPart == URLPassword && (hasUser || hasPassword) {
							stringBuilder.WriteRune(
								lastPart.Suffix(),
							) // ':' only if credentials present
						} else if lastPart != URLPassword {
							stringBuilder.WriteRune(lastPart.Suffix()) // '/' or '@'
						}
					}

					slug := strings.ToLower(fieldInfo.Name)
					if slug == "host" && urlPart == URLPort {
						slug = "port"
					}

					if fieldInfo == field {
						stringBuilder.WriteString("<strong>")
						stringBuilder.WriteString(slug)
						stringBuilder.WriteString("</strong>")
					} else {
						stringBuilder.WriteString(slug)
					}

					break
				}
			}
		}

		// Add trailing '/' if no dynamic path segments follow
		if maxPart < URLPath+PathOffset1 {
			stringBuilder.WriteRune('/')
		}

		stringBuilder.WriteString("</code>  \n")

		fieldsPrinted[field.Name] = true
	}
}

func (MarkdownTreeRenderer) writeFieldExtras(stringBuilder *strings.Builder, field *FieldInfo) {
	if len(field.Keys) > 1 {
		stringBuilder.WriteString("  Aliases: `")

		for i, key := range field.Keys {
			if i == 0 {
				// Skip primary alias (as it's the same as the field name)
				continue
			}

			if i > 1 {
				stringBuilder.WriteString("`, `")
			}

			stringBuilder.WriteString(key)
		}

		stringBuilder.WriteString("`  \n")
	}

	if field.EnumFormatter != nil {
		stringBuilder.WriteString("  Possible values: `")

		for i, name := range field.EnumFormatter.Names() {
			if i != 0 {
				stringBuilder.WriteString("`, `")
			}

			stringBuilder.WriteString(name)
		}

		stringBuilder.WriteString("`  \n")
	}
}

func (MarkdownTreeRenderer) writeFieldPrimary(stringBuilder *strings.Builder, field *FieldInfo) {
	fieldKey := field.Name

	stringBuilder.WriteString("*  __")
	stringBuilder.WriteString(fieldKey)
	stringBuilder.WriteString("__")

	if field.Description != "" {
		stringBuilder.WriteString(" - ")
		stringBuilder.WriteString(field.Description)
	}

	if field.Required {
		stringBuilder.WriteString(" (**Required**)  \n")
	} else {
		stringBuilder.WriteString("  \n  Default: ")

		if field.DefaultValue == "" {
			stringBuilder.WriteString("*empty*")
		} else {
			if field.Type.Kind() == reflect.Bool {
				defaultValue, _ := ParseBool(field.DefaultValue, false)
				if defaultValue {
					stringBuilder.WriteString("✔ ")
				} else {
					stringBuilder.WriteString("❌ ")
				}
			}

			stringBuilder.WriteRune('`')
			stringBuilder.WriteString(field.DefaultValue)
			stringBuilder.WriteRune('`')
		}

		stringBuilder.WriteString("  \n")
	}
}

func (r MarkdownTreeRenderer) writeHeader(stringBuilder *strings.Builder, text string) {
	stringBuilder.WriteString(r.HeaderPrefix)
	stringBuilder.WriteString(text)
	stringBuilder.WriteString("\n\n")
}