-
Notifications
You must be signed in to change notification settings - Fork 1
/
render.go
206 lines (187 loc) · 4.67 KB
/
render.go
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
package main
import (
"fmt"
"io"
)
type Renderer struct {
format OutFormat
envPrefix string
noStyles bool
}
func NewRenderer(format OutFormat, envPrefix string, noStyles bool) *Renderer {
return &Renderer{
format: format,
envPrefix: envPrefix,
noStyles: noStyles,
}
}
func (r *Renderer) Render(scopes []*EnvScope, out io.Writer) error {
var tmpl template
var cfg renderConfig
switch r.format {
case OutFormatMarkdown:
tmpl = tmplMarkdown
cfg = renderMarkdown
case OutFormatHTML:
tmpl = tmplHTML
cfg = renderHTML
case OutFormatTxt:
tmpl = tmplPlaintext
cfg = renderPlaintext
case OutFormatEnv:
tmpl = tmplDotEnv
cfg = renderDotenv
default:
return fmt.Errorf("unknown format: %s", r.format)
}
c := newRenderContext(scopes, cfg, r.envPrefix, r.noStyles)
f := templateRenderer(tmpl)
if err := f(c, out); err != nil {
return fmt.Errorf("render: %w", err)
}
return nil
}
type renderSection struct {
Name string
Doc string
Items []renderItem
}
type renderItem struct {
EnvName string
Doc string
EnvDefault string
EnvSeparator string
Required bool
Expand bool
NonEmpty bool
FromFile bool
children []renderItem
Indent int
}
func (i renderItem) Children(indentInc int) []renderItem {
indent := i.Indent + indentInc
res := make([]renderItem, len(i.children))
for j, child := range i.children {
child.Indent = indent
res[j] = child
}
return res
}
type renderItemConfig struct {
SeparatorFormat string
SeparatorDefault string
OptRequired string
OptExpand string
OptNonEmpty string
OptFromFile string
EnvDefaultFormat string
}
type renderConfig struct {
Item renderItemConfig
}
type renderContext struct {
Title string
Sections []renderSection
Styles bool
Config renderConfig
}
func newRenderContext(scopes []*EnvScope, cfg renderConfig, envPrefix string, noStyles bool) renderContext {
res := renderContext{
Sections: make([]renderSection, len(scopes)),
Styles: !noStyles,
Config: cfg,
}
res.Title = "Environment Variables"
for i, scope := range scopes {
section := renderSection{
Name: scope.Name,
Doc: scope.Doc,
Items: make([]renderItem, len(scope.Vars)),
}
for j, item := range scope.Vars {
item := newRenderItem(item, envPrefix)
item.Indent = 1
section.Items[j] = item
}
res.Sections[i] = section
}
return res
}
func newRenderItem(item *EnvDocItem, envPrefix string) renderItem {
children := make([]renderItem, len(item.Children))
for i, child := range item.Children {
children[i] = newRenderItem(child, envPrefix)
}
return renderItem{
EnvName: fmt.Sprintf("%s%s", envPrefix, item.Name),
Doc: item.Doc,
EnvDefault: item.Opts.Default,
EnvSeparator: item.Opts.Separator,
Required: item.Opts.Required,
Expand: item.Opts.Expand,
NonEmpty: item.Opts.NonEmpty,
FromFile: item.Opts.FromFile,
children: children,
}
}
var (
tmplMarkdown = newTmplText("markdown.tmpl")
tmplHTML = newTmplText("html.tmpl")
tmplPlaintext = newTmplText("plaintext.tmpl")
tmplDotEnv = newTmplText("dotenv.tmpl")
renderMarkdown = renderConfig{
Item: renderItemConfig{
SeparatorFormat: "separated by `%s`",
SeparatorDefault: "comma-separated",
OptRequired: "**required**",
OptExpand: "expand",
OptFromFile: "from-file",
OptNonEmpty: "non-empty",
EnvDefaultFormat: "default: `%s`",
},
}
renderPlaintext = renderConfig{
Item: renderItemConfig{
SeparatorFormat: "separated by `%s`",
SeparatorDefault: "comma-separated",
OptRequired: "required",
OptExpand: "expand",
OptFromFile: "from-file",
OptNonEmpty: "non-empty",
EnvDefaultFormat: "default: `%s`",
},
}
renderDotenv = renderConfig{
Item: renderItemConfig{
SeparatorFormat: "separated by '%s'",
SeparatorDefault: "comma-separated",
OptRequired: "required",
OptExpand: "expand",
OptFromFile: "from-file",
OptNonEmpty: "non-empty",
EnvDefaultFormat: "default: '%s'",
},
}
renderHTML = renderConfig{
Item: renderItemConfig{
SeparatorFormat: `separated by "<code>%s</code>"`,
SeparatorDefault: "comma-separated",
OptRequired: "<strong>required</strong>",
OptExpand: "expand",
OptFromFile: "from-file",
OptNonEmpty: "non-empty",
EnvDefaultFormat: "default: <code>%s</code>",
},
}
)
type template interface {
Execute(wr io.Writer, data any) error
}
func templateRenderer(t template) func(renderContext, io.Writer) error {
return func(c renderContext, out io.Writer) error {
if err := t.Execute(out, c); err != nil {
return fmt.Errorf("render template: %w", err)
}
return nil
}
}