-
Notifications
You must be signed in to change notification settings - Fork 22
/
docs.go
168 lines (148 loc) · 4.31 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
package source
import (
"bytes"
"embed"
"encoding/json"
"fmt"
"os"
"path/filepath"
"regexp"
"strings"
"text/template"
"github.com/cloudquery/plugin-sdk/plugins/destination"
"github.com/cloudquery/plugin-sdk/schema"
)
//go:embed templates/*.go.tpl
var templatesFS embed.FS
var reMatchNewlines = regexp.MustCompile(`\n{3,}`)
var reMatchHeaders = regexp.MustCompile(`(#{1,6}.+)\n+`)
// GeneratePluginDocs creates table documentation for the source plugin based on its list of tables
func (p *Plugin) GeneratePluginDocs(dir, format string) error {
if err := os.MkdirAll(dir, os.ModePerm); err != nil {
return err
}
destination.SetDestinationManagedCqColumns(p.Tables())
switch format {
case "markdown":
return p.renderTablesAsMarkdown(dir)
case "json":
return p.renderTablesAsJSON(dir)
default:
return fmt.Errorf("unsupported format: %v", format)
}
}
type jsonTable struct {
Name string `json:"name"`
Description string `json:"description"`
Columns []jsonColumn `json:"columns"`
Relations []jsonTable `json:"relations"`
}
type jsonColumn struct {
Name string `json:"name"`
Type string `json:"type"`
IsPrimaryKey bool `json:"is_primary_key,omitempty"`
IsIncrementalKey bool `json:"is_incremental_key,omitempty"`
}
func (p *Plugin) renderTablesAsJSON(dir string) error {
tables := p.jsonifyTables(p.Tables())
b, err := json.MarshalIndent(tables, "", " ")
if err != nil {
return fmt.Errorf("failed to marshal tables as json: %v", err)
}
outputPath := filepath.Join(dir, "__tables.json")
return os.WriteFile(outputPath, b, 0644)
}
func (p *Plugin) jsonifyTables(tables schema.Tables) []jsonTable {
jsonTables := make([]jsonTable, len(tables))
for i, table := range tables {
jsonColumns := make([]jsonColumn, len(table.Columns))
for c, col := range table.Columns {
jsonColumns[c] = jsonColumn{
Name: col.Name,
Type: col.Type.String(),
IsPrimaryKey: col.CreationOptions.PrimaryKey,
IsIncrementalKey: col.CreationOptions.IncrementalKey,
}
}
jsonTables[i] = jsonTable{
Name: table.Name,
Description: table.Description,
Columns: jsonColumns,
Relations: p.jsonifyTables(table.Relations),
}
}
return jsonTables
}
func (p *Plugin) renderTablesAsMarkdown(dir string) error {
for _, table := range p.Tables() {
if err := renderAllTables(table, dir); err != nil {
return err
}
}
t, err := template.New("all_tables.md.go.tpl").Funcs(template.FuncMap{
"indentToDepth": indentToDepth,
}).ParseFS(templatesFS, "templates/all_tables*.md.go.tpl")
if err != nil {
return fmt.Errorf("failed to parse template for README.md: %v", err)
}
var b bytes.Buffer
if err := t.Execute(&b, p); err != nil {
return fmt.Errorf("failed to execute template: %v", err)
}
content := formatMarkdown(b.String())
outputPath := filepath.Join(dir, "README.md")
f, err := os.Create(outputPath)
if err != nil {
return fmt.Errorf("failed to create file %v: %v", outputPath, err)
}
f.WriteString(content)
return nil
}
func renderAllTables(t *schema.Table, dir string) error {
if err := renderTable(t, dir); err != nil {
return err
}
for _, r := range t.Relations {
if err := renderAllTables(r, dir); err != nil {
return err
}
}
return nil
}
func renderTable(table *schema.Table, dir string) error {
t := template.New("").Funcs(map[string]any{
"formatType": formatType,
})
t, err := t.New("table.md.go.tpl").ParseFS(templatesFS, "templates/table.md.go.tpl")
if err != nil {
return fmt.Errorf("failed to parse template: %v", err)
}
outputPath := filepath.Join(dir, fmt.Sprintf("%s.md", table.Name))
var b bytes.Buffer
if err := t.Execute(&b, table); err != nil {
return fmt.Errorf("failed to execute template: %v", err)
}
content := formatMarkdown(b.String())
f, err := os.Create(outputPath)
if err != nil {
return fmt.Errorf("failed to create file %v: %v", outputPath, err)
}
f.WriteString(content)
return f.Close()
}
func formatMarkdown(s string) string {
s = reMatchNewlines.ReplaceAllString(s, "\n\n")
return reMatchHeaders.ReplaceAllString(s, `$1`+"\n\n")
}
func formatType(v schema.ValueType) string {
return strings.TrimPrefix(v.String(), "Type")
}
func indentToDepth(table *schema.Table) string {
s := ""
t := table
for t.Parent != nil {
s += " "
t = t.Parent
}
return s
}