cli: add minimal doc generator (#129)

* cli: add minimal doc generator

* fixup! cli: add
This commit is contained in:
Thomas Tendyck 2022-05-11 09:20:37 +02:00 committed by GitHub
parent 2fc9129b9f
commit d76703061b
5 changed files with 64 additions and 21 deletions

32
util/clidocgen/main.go Normal file
View file

@ -0,0 +1,32 @@
// Clidocgen generates a Markdown page describing all CLI commands.
package main
import (
"bytes"
"fmt"
"regexp"
"github.com/edgelesssys/constellation/cli/cmd"
"github.com/spf13/cobra/doc"
)
func main() {
rootCmd := cmd.NewRootCmd()
rootCmd.DisableAutoGenTag = true
// Generate Markdown for all commands.
cmdList := &bytes.Buffer{}
body := &bytes.Buffer{}
for _, c := range rootCmd.Commands() {
name := c.Name()
fmt.Fprintf(cmdList, "* [%v](#constellation-%v): %v\n", name, name, c.Short)
if err := doc.GenMarkdown(c, body); err != nil {
panic(err)
}
}
// Remove "see also" sections. They list parent and child commands, which is not interesting for us.
cleanedBody := regexp.MustCompile(`(?s)### SEE ALSO\n.+?\n\n`).ReplaceAll(body.Bytes(), nil)
fmt.Printf("Commands:\n\n%s\n%s", cmdList, cleanedBody)
}