-
Notifications
You must be signed in to change notification settings - Fork 3
/
doc.gen.go
238 lines (208 loc) · 4.76 KB
/
doc.gen.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
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
// +build ignore
package main
import (
"bytes"
"fmt"
"go/ast"
"go/parser"
"go/token"
"log"
"os"
"path/filepath"
"regexp"
"strings"
"text/template"
"time"
)
const filename = "internal/config/doc.go"
func main() {
fmt.Printf("Generating %s...\n", filename)
f, err := os.Create(filename)
die(err)
defer f.Close()
fs := token.NewFileSet()
reg := map[string][]field{}
v := visitor{
reg: ®,
maxDepth: 2,
onlyExported: true,
}
files := []string{}
err = filepath.Walk(".", func(path string, f os.FileInfo, err error) error {
files = append(files, path)
return nil
})
die(err)
for _, file := range files {
if strings.Contains(file, "vendor") || strings.HasSuffix(file, "_test.go") || !strings.HasSuffix(file, ".go") {
continue
}
f, err := parser.ParseFile(fs, file, nil, parser.ParseComments)
if err != nil {
// Ignore if file could not be read
continue
}
ast.Walk(v, f)
}
out, err := v.renderMap("config.ConfigSection", "config")
die(err)
_, err = f.Write([]byte(out))
die(err)
}
func die(err error) {
if err != nil {
log.Fatal(err)
}
}
type visitor struct {
// configuration
onlyExported bool
maxDepth int
depth int
// store
cp string // store the current package to be parsed
cs string // store the current struct to be parsed
reg *map[string][]field
}
func (v visitor) asMap(root string) map[string]string {
out := map[string]string{}
if next, ok := (*v.reg)[root]; ok {
for _, f := range next {
out[f.tag] = f.doc
children := v.asMap(f.typ)
for k, v := range children {
out[f.tag+"."+k] = v
}
}
}
return out
}
func (v visitor) renderMap(root string, pkg string) (string, error) {
docs := v.asMap(root)
data := struct {
Pkg string
Docs map[string]string
Timestamp time.Time
}{
Pkg: pkg,
Docs: docs,
Timestamp: time.Now(),
}
templ := `// Code generated by go generate; DO NOT EDIT.
package {{ .Pkg }}
func configDoc(section string) map[string]string {
doc := make(map[string]string)
doc[section] = ` + "`" + `The default section is - as the name suggests - read by default. Note that you can
define as many sections as your want. You can for examlpe define a 'test' section
that refers to a test connection string for icinga and/or influx. To reduce
boilerplate consider anchors (http://yaml.org/spec/1.2/spec.html#id2765878)
default: &anchor_to_default
...
test:
<< *anchor_to_default
Sections other than 'default' can be used via the -s/--section flag.` + "`" + `
{{- range $key, $doc := .Docs}}
doc[section+".{{$key}}"] = ` + "`{{ $doc }}`" + `
{{- end}}
return doc
}
`
tmpl, err := template.New("").Parse(templ)
if err != nil {
return "", err
}
var buffer bytes.Buffer
if err = tmpl.Execute(&buffer, data); err != nil {
return "", err
}
return buffer.String(), nil
}
func (v visitor) addField(f field) {
(*v.reg)[v.cp+"."+v.cs] = append((*v.reg)[v.cp+"."+v.cs], f)
}
func (v visitor) Visit(n ast.Node) ast.Visitor {
// Exit if node is nil. Also there is no need to go deeper than on field
// level of a globally defined sturct eg. maxDepth = 3.
if n == nil || v.depth > v.maxDepth {
return nil
}
switch n := n.(type) {
case *ast.File:
v.cp = n.Name.Name
v.depth++
case *ast.TypeSpec:
if v.onlyExported && !n.Name.IsExported() {
return nil
}
v.cs = n.Name.Name
v.depth++
case *ast.Field:
if len(n.Names) > 0 {
fi := NewFieldFromField(n, v.cp)
v.addField(fi)
}
v.depth++
}
return v
}
type field struct {
name string
typ string
typMeta string
tag string
doc string
}
func NewFieldFromField(f *ast.Field, pac string) field {
typ, typMeta := GetFieldType(f, pac)
return field{
name: f.Names[0].String(),
typ: typ,
typMeta: typMeta,
tag: getYAMLTag(f),
doc: f.Doc.Text(),
}
}
func GetFieldType(f *ast.Field, pac string) (typ string, typMeta string) {
switch o := f.Type.(type) {
case *ast.ArrayType:
typ = "Array"
case *ast.MapType:
typ = "Map"
case *ast.Ident:
typ = fmt.Sprintf("%s.%s", pac, o.Name)
case *ast.SelectorExpr:
i := getExprAsIdent(o.X)
x := i.Name
typ = fmt.Sprintf("%s.%s", x, o.Sel.Name)
default:
typ = "Unknown"
typMeta = fmt.Sprintf("Content: %s - Type: %#T", o, o)
}
return
}
func getExprAsIdent(in ast.Expr) *ast.Ident {
switch e := in.(type) {
case *ast.Ident:
return e
default:
fmt.Printf("%#v %#T", e, e)
}
return nil
}
func (f field) String() string {
out := fmt.Sprintf("%s | Type: %s | Tag: %s", f.name, f.typ, f.tag)
return out
}
var yamlTagRE = regexp.MustCompile(`yaml:"(?P<tag>\w+)"`)
func getYAMLTag(f *ast.Field) string {
out := ""
tags := f.Tag
if tags == nil {
return out
}
matches := yamlTagRE.FindStringSubmatch(tags.Value)
if len(matches) >= 2 {
out = matches[1]
}
return out
}