-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
docs.go
253 lines (218 loc) · 5.79 KB
/
docs.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
package docs
import (
_ "embed"
"fmt"
"log"
"strings"
"go.uber.org/multierr"
"github.com/smartcontractkit/chainlink/v2/core/utils"
)
const (
fieldDefault = "# Default"
fieldExample = "# Example"
tokenAdvanced = "**ADVANCED**"
tokenExtended = "**EXTENDED**"
)
var (
//go:embed secrets.toml
secretsTOML string
//go:embed core.toml
coreTOML string
//go:embed chains-evm.toml
chainsEVMTOML string
//go:embed chains-cosmos.toml
chainsCosmosTOML string
//go:embed chains-solana.toml
chainsSolanaTOML string
//go:embed chains-starknet.toml
chainsStarknetTOML string
//go:embed example-config.toml
exampleConfig string
//go:embed example-secrets.toml
exampleSecrets string
docsTOML = coreTOML + chainsEVMTOML + chainsCosmosTOML + chainsSolanaTOML + chainsStarknetTOML
)
// GenerateConfig returns MarkDown documentation generated from core.toml & chains-*.toml.
func GenerateConfig() (string, error) {
return generateDocs(docsTOML, `[//]: # (Documentation generated from docs/*.toml - DO NOT EDIT.)
This document describes the TOML format for configuration.
See also [SECRETS.md](SECRETS.md)
`, exampleConfig)
}
// GenerateSecrets returns MarkDown documentation generated from secrets.toml.
func GenerateSecrets() (string, error) {
return generateDocs(secretsTOML, `[//]: # (Documentation generated from docs/secrets.toml - DO NOT EDIT.)
This document describes the TOML format for secrets.
Each secret has an alternative corresponding environment variable.
See also [CONFIG.md](CONFIG.md)
`, exampleSecrets)
}
// generateDocs returns MarkDown documentation generated from the TOML string.
func generateDocs(toml, header, example string) (string, error) {
items, err := parseTOMLDocs(toml)
var sb strings.Builder
sb.WriteString(header)
sb.WriteString(`
## Example
`)
sb.WriteString("```toml\n")
sb.WriteString(example)
sb.WriteString("```\n\n")
for _, item := range items {
sb.WriteString(item.String())
sb.WriteString("\n\n")
}
return sb.String(), err
}
func advancedWarning(msg string) string {
return fmt.Sprintf(":warning: **_ADVANCED_**: _%s_\n", msg)
}
// lines holds a set of contiguous lines
type lines []string
func (d lines) String() string {
return strings.Join(d, "\n")
}
type table struct {
name string
codes lines
adv bool
desc lines
ext bool
}
func newTable(line string, desc lines) *table {
t := &table{
name: strings.Trim(line, "[]"),
codes: []string{line},
desc: desc,
}
if len(desc) > 0 {
if strings.HasPrefix(strings.TrimSpace(desc[0]), tokenAdvanced) {
t.adv = true
t.desc = t.desc[1:]
} else if strings.HasPrefix(strings.TrimSpace(desc[len(desc)-1]), tokenExtended) {
t.ext = true
t.desc = t.desc[:len(desc)-1]
}
}
return t
}
func (t table) advanced() string {
if t.adv {
return advancedWarning("Do not change these settings unless you know what you are doing.")
}
return ""
}
func (t table) code() string {
if !t.ext {
return fmt.Sprint("```toml\n", t.codes, "\n```\n")
}
return ""
}
func (t table) extended() string {
if t.ext {
if t.name != "EVM" {
log.Fatalf("%s: no extended description available", t.name)
}
s, err := evmChainDefaults()
if err != nil {
log.Fatalf("%s: failed to generate evm chain defaults: %v", t.name, err)
}
return s
}
return ""
}
// String prints a table as an H2, followed by a code block and description.
func (t *table) String() string {
return fmt.Sprint("## ", t.name, "\n",
t.advanced(),
t.code(),
t.desc,
t.extended())
}
type keyval struct {
name string
code string
adv bool
desc lines
}
func newKeyval(line string, desc lines) keyval {
line = strings.TrimSpace(line)
kv := keyval{
name: line[:strings.Index(line, " ")],
code: line,
desc: desc,
}
if len(desc) > 0 && strings.HasPrefix(strings.TrimSpace(desc[0]), tokenAdvanced) {
kv.adv = true
kv.desc = kv.desc[1:]
}
return kv
}
func (k keyval) advanced() string {
if k.adv {
return advancedWarning("Do not change this setting unless you know what you are doing.")
}
return ""
}
// String prints a keyval as an H3, followed by a code block and description.
func (k keyval) String() string {
name := k.name
if i := strings.LastIndex(name, "."); i > -1 {
name = name[i+1:]
}
return fmt.Sprint("### ", name, "\n",
k.advanced(),
"```toml\n",
k.code,
"\n```\n",
k.desc)
}
func parseTOMLDocs(s string) (items []fmt.Stringer, err error) {
defer func() { _, err = utils.MultiErrorList(err) }()
globalTable := table{name: "Global"}
currentTable := &globalTable
items = append(items, currentTable)
var desc lines
for _, line := range strings.Split(s, "\n") {
if strings.HasPrefix(line, "#") {
// comment
desc = append(desc, strings.TrimSpace(line[1:]))
} else if strings.TrimSpace(line) == "" {
// empty
if len(desc) > 0 {
items = append(items, desc)
desc = nil
}
} else if strings.HasPrefix(line, "[") {
currentTable = newTable(line, desc)
items = append(items, currentTable)
desc = nil
} else {
kv := newKeyval(line, desc)
shortName := kv.name
if currentTable != &globalTable {
// update to full name
kv.name = currentTable.name + "." + kv.name
}
if len(kv.desc) == 0 {
err = multierr.Append(err, fmt.Errorf("%s: missing description", kv.name))
} else if !strings.HasPrefix(kv.desc[0], shortName) {
err = multierr.Append(err, fmt.Errorf("%s: description does not begin with %q", kv.name, shortName))
}
if !strings.HasSuffix(line, fieldDefault) && !strings.HasSuffix(line, fieldExample) {
err = multierr.Append(err, fmt.Errorf(`%s: is not one of %v`, kv.name, []string{fieldDefault, fieldExample}))
}
items = append(items, kv)
currentTable.codes = append(currentTable.codes, kv.code)
desc = nil
}
}
if len(globalTable.codes) == 0 {
//drop it
items = items[1:]
}
if len(desc) > 0 {
items = append(items, desc)
}
return
}