/
template.go
140 lines (125 loc) · 3.57 KB
/
template.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
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package configschema // import "github.com/open-telemetry/opentelemetry-collector-contrib/lib/configschema"
import (
"bytes"
"fmt"
"strings"
"text/template"
"golang.org/x/text/cases"
"golang.org/x/text/language"
)
func tableTemplate() (*template.Template, error) {
return template.New("table").Option("missingkey=zero").Funcs(
template.FuncMap{
"join": join,
"mkAnchor": mkAnchor,
"isCompoundField": isCompoundField,
"isDuration": isDuration,
},
).Parse(tableTemplateStr)
}
func isCompoundField(kind string) bool {
return kind == "struct" || kind == "ptr"
}
func join(s string) string {
return strings.ReplaceAll(s, "\n", " ")
}
// mkAnchor takes a name and a type (e.g. "configtls.TLSClientSetting") and
// returns a string suitable for use as a markdown anchor.
func mkAnchor(name, typ string) string {
if isDuration(typ) {
return "time-Duration"
}
idx := strings.IndexRune(typ, '.')
// strip "configtls." from e.g. "configtls.TLSClientSetting"
typeStripped := typ[idx+1:]
concat := fmt.Sprintf("%s-%s", name, typeStripped)
asterisksRemoved := strings.ReplaceAll(concat, "*", "")
dotsToDashes := strings.ReplaceAll(asterisksRemoved, ".", "-")
return strings.ReplaceAll(dotsToDashes, "_", "-")
}
func isDuration(s string) bool {
return s == "time.Duration"
}
const tableTemplateStr = `### {{ mkAnchor .Name .Type }}
| Name | Field Info | Default | Docs |
| ---- | --------- | ------- | ---- |
{{ range .CfgFields -}}
| {{ .Name }} |
{{- if .Type -}}
{{- $anchor := mkAnchor .Name .Type -}}
{{- if isCompoundField .Kind -}}
[{{ $anchor }}](#{{ $anchor }})
{{- else -}}
{{- if isDuration .Type -}}
[{{ $anchor }}](#{{ $anchor }})
{{- else -}}
{{ .Type }}
{{- end -}}
{{- end -}}
{{- else -}}
{{ .Kind }}
{{- end -}}
| {{ .Default }} | {{ join .Doc }} |
{{ end }}
`
func renderHeader(typ, group, doc string) []byte {
caser := cases.Title(language.English)
return []byte(fmt.Sprintf(
"# %s %s Reference\n\n%s\n\n",
caser.String(typ),
caser.String(group),
doc,
))
}
func renderTable(tmpl *template.Template, field *cfgField) ([]byte, error) {
buf := &bytes.Buffer{}
err := executeTableTemplate(tmpl, field, buf)
if err != nil {
return nil, err
}
return buf.Bytes(), nil
}
func executeTableTemplate(tmpl *template.Template, field *cfgField, buf *bytes.Buffer) error {
err := tmpl.Execute(buf, field)
if err != nil {
return err
}
for _, subField := range field.CfgFields {
if subField.CfgFields == nil {
continue
}
err = executeTableTemplate(tmpl, subField, buf)
if err != nil {
return err
}
}
return nil
}
const durationBlock = "### time-Duration \n" +
"An optionally signed sequence of decimal numbers, " +
"each with a unit suffix, such as `300ms`, `-1.5h`, " +
"or `2h45m`. Valid time units are `ns`, `us`, `ms`, `s`, `m`, `h`."
func hasTimeDuration(f *cfgField) bool {
if f.Type == "time.Duration" {
return true
}
for _, sub := range f.CfgFields {
if hasTimeDuration(sub) {
return true
}
}
return false
}