{{ message }}
Repository navigation
Expand file tree
/
Copy pathmain.go
More file actions
320 lines (291 loc) · 8.5 KB
/
Copy pathmain.go
File metadata and controls
320 lines (291 loc) · 8.5 KB
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
package main
import (
"bytes"
"embed"
"fmt"
"log"
"os"
"path/filepath"
"strings"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
cli "github.com/supabase/cli/cmd"
"github.com/supabase/cli/internal/utils"
"gopkg.in/yaml.v3"
)
const tagOthers = "other-commands"
var (
examples map[string][]ExampleDoc
//go:embed templates/examples.yaml
exampleSpec string
//go:embed supabase/*
docsDir embed.FS
)
func main() {
semver := "latest"
if len(os.Args) > 1 {
semver = os.Args[1]
}
// Trim version tag
if semver[0] == 'v' {
semver = semver[1:]
}
if err := generate(semver); err != nil {
log.Fatalln(err)
}
}
func generate(version string) error {
dec := yaml.NewDecoder(strings.NewReader(exampleSpec))
if err := dec.Decode(&examples); err != nil {
return err
}
root := cli.GetRootCmd()
root.InitDefaultCompletionCmd()
root.InitDefaultHelpFlag()
spec := SpecDoc{
Clispec: "001",
Info: InfoDoc{
Id: "cli",
Version: version,
Title: strings.TrimSpace(root.Short),
Description: forceMultiLine("Supabase CLI provides you with tools to develop your application locally, and deploy your application to the Supabase platform."),
Language: "sh",
Source: "https://github.com/supabase/cli",
Bugs: "https://github.com/supabase/cli/issues",
Spec: "https://github.com/supabase/spec/cli_v1_commands.yaml",
Tags: getTags(root),
},
}
root.Flags().VisitAll(func(flag *pflag.Flag) {
if !flag.Hidden {
spec.Flags = append(spec.Flags, getFlags(flag))
}
})
cobra.CheckErr(root.MarkFlagRequired("experimental"))
// Generate, serialise, and print
yamlDoc := GenYamlDoc(root, &spec)
spec.Info.Options = yamlDoc.Options
// Reverse commands list
for i, j := 0, len(spec.Commands)-1; i < j; i, j = i+1, j-1 {
spec.Commands[i], spec.Commands[j] = spec.Commands[j], spec.Commands[i]
}
// Write to stdout
encoder := yaml.NewEncoder(os.Stdout)
encoder.SetIndent(2)
return encoder.Encode(spec)
}
type TagDoc struct {
Id string `yaml:",omitempty"`
Title string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
}
type InfoDoc struct {
Id string `yaml:",omitempty"`
Version string `yaml:",omitempty"`
Title string `yaml:",omitempty"`
Language string `yaml:",omitempty"`
Source string `yaml:",omitempty"`
Bugs string `yaml:",omitempty"`
Spec string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
Options string `yaml:",omitempty"`
Tags []TagDoc `yaml:",omitempty"`
}
type ValueDoc struct {
Id string `yaml:",omitempty"`
Name string `yaml:",omitempty"`
Type string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
}
type FlagDoc struct {
Id string `yaml:",omitempty"`
Name string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
Required bool `yaml:",omitempty"`
DefaultValue string `yaml:"default_value"`
AcceptedValues []ValueDoc `yaml:"accepted_values,omitempty"`
}
type ExampleDoc struct {
Id string `yaml:",omitempty"`
Name string `yaml:",omitempty"`
Code string `yaml:",omitempty"`
Response string `yaml:",omitempty"`
}
type CmdDoc struct {
Id string `yaml:",omitempty"`
Title string `yaml:",omitempty"`
Summary string `yaml:",omitempty"`
Source string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
Examples []ExampleDoc `yaml:",omitempty"`
Tags []string `yaml:""`
Links []LinkDoc `yaml:""`
Usage string `yaml:",omitempty"`
Subcommands []string `yaml:""`
Options string `yaml:",omitempty"`
Flags []FlagDoc `yaml:""`
}
type LinkDoc struct {
Name string `yaml:",omitempty"`
Link string `yaml:",omitempty"`
}
type ParamDoc struct {
Id string `yaml:",omitempty"`
Title string `yaml:",omitempty"`
Description string `yaml:",omitempty"`
Required bool `yaml:",omitempty"`
Default string `yaml:",omitempty"`
Tags []string `yaml:",omitempty"`
Links []LinkDoc `yaml:""`
}
type SpecDoc struct {
Clispec string `yaml:",omitempty"`
Info InfoDoc `yaml:",omitempty"`
Flags []FlagDoc `yaml:",omitempty"`
Commands []CmdDoc `yaml:",omitempty"`
Parameters []FlagDoc `yaml:",omitempty"`
}
// DFS on command tree to generate documentation specs.
func GenYamlDoc(cmd *cobra.Command, root *SpecDoc) CmdDoc {
var subcommands []string
for _, c := range cmd.Commands() {
if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
continue
}
sub := GenYamlDoc(c, root)
if !cmd.HasParent() && len(sub.Tags) == 0 {
sub.Tags = append(sub.Tags, tagOthers)
}
root.Commands = append(root.Commands, sub)
subcommands = append(subcommands, sub.Id)
}
yamlDoc := CmdDoc{
Id: strings.ReplaceAll(cmd.CommandPath(), " ", "-"),
Title: cmd.CommandPath(),
Summary: forceMultiLine(cmd.Short),
Description: forceMultiLine(strings.ReplaceAll(cmd.Long, "\t", " ")),
Subcommands: subcommands,
}
names := strings.Fields(cmd.CommandPath())
if len(names) > 3 {
base := strings.Join(names[2:], "-")
names = append(names[:2], base)
}
path := filepath.Join(names...) + ".md"
if contents, err := docsDir.ReadFile(path); err == nil {
noHeader := bytes.TrimLeftFunc(contents, func(r rune) bool {
return r != '\n'
})
yamlDoc.Description = forceMultiLine(string(noHeader))
}
if eg, ok := examples[yamlDoc.Id]; ok {
yamlDoc.Examples = eg
}
if len(cmd.GroupID) > 0 {
yamlDoc.Tags = append(yamlDoc.Tags, cmd.GroupID)
}
if cmd.Runnable() {
yamlDoc.Usage = forceMultiLine(cmd.UseLine())
}
// Only print flags for root and leaf commands
if !cmd.HasSubCommands() {
flags := cmd.LocalFlags()
flags.VisitAll(func(flag *pflag.Flag) {
if !flag.Hidden {
yamlDoc.Flags = append(yamlDoc.Flags, getFlags(flag))
}
})
// Print required flag for experimental commands
globalFlags := cmd.Root().Flags()
if cli.IsExperimental(cmd) {
flag := globalFlags.Lookup("experimental")
yamlDoc.Flags = append(yamlDoc.Flags, getFlags(flag))
}
// Leaf commands should inherit parent flags except root
parentFlags := cmd.InheritedFlags()
parentFlags.VisitAll(func(flag *pflag.Flag) {
if !flag.Hidden && globalFlags.Lookup(flag.Name) == nil {
yamlDoc.Flags = append(yamlDoc.Flags, getFlags(flag))
}
})
}
return yamlDoc
}
func getFlags(flag *pflag.Flag) FlagDoc {
doc := FlagDoc{
Id: flag.Name,
Name: getName(flag),
Description: forceMultiLine(getUsage(flag)),
DefaultValue: flag.DefValue,
Required: flag.Annotations[cobra.BashCompOneRequiredFlag] != nil,
}
if f, ok := flag.Value.(*utils.EnumFlag); ok {
for _, v := range f.Allowed {
doc.AcceptedValues = append(doc.AcceptedValues, ValueDoc{
Id: v,
Name: v,
Type: flag.Value.Type(),
})
}
}
return doc
}
// Prints a human readable flag name.
//
// -f, --flag `string`
func getName(flag *pflag.Flag) (line string) {
// Prefix: shorthand
if flag.Shorthand != "" && flag.ShorthandDeprecated == "" {
line += fmt.Sprintf("-%s, ", flag.Shorthand)
}
line += fmt.Sprintf("--%s", flag.Name)
// Suffix: type
if varname, _ := pflag.UnquoteUsage(flag); varname != "" {
line += fmt.Sprintf(" <%s>", varname)
}
// Not used by our cmd but kept here for consistency
if flag.NoOptDefVal != "" {
switch flag.Value.Type() {
case "string":
line += fmt.Sprintf("[=\"%s\"]", flag.NoOptDefVal)
case "bool":
if flag.NoOptDefVal != "true" {
line += fmt.Sprintf("[=%s]", flag.NoOptDefVal)
}
case "count":
if flag.NoOptDefVal != "+1" {
line += fmt.Sprintf("[=%s]", flag.NoOptDefVal)
}
default:
line += fmt.Sprintf("[=%s]", flag.NoOptDefVal)
}
}
return line
}
// Prints flag usage and default value.
//
// Select a plan. (default "free")
func getUsage(flag *pflag.Flag) string {
_, usage := pflag.UnquoteUsage(flag)
return usage
}
// Yaml lib generates incorrect yaml with long strings that do not contain \n.
//
// example: 'a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a
// a a a a a a '
func forceMultiLine(s string) string {
if len(s) > 60 && !strings.Contains(s, "\n") {
s = s + "\n"
}
return s
}
func getTags(cmd *cobra.Command) (tags []TagDoc) {
for _, group := range cmd.Groups() {
tags = append(tags, TagDoc{
Id: group.ID,
Title: group.Title[:len(group.Title)-1],
})
}
tags = append(tags, TagDoc{Id: tagOthers, Title: "Additional Commands"})
return tags
}
You can’t perform that action at this time.