add doc-gen for new CLI (WIP)

Author: marle3003

cmd/internal/gen-cli-docs/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"mokapi/pkg/cmd/mokapi"
+)
+
+func main() {
+	cmd := mokapi.NewCmdMokapi(context.Background())
+	err := cmd.GenMarkdown("./docs/cli")
+	if err != nil {
+		fmt.Println(err.Error())
+	}
+}

pkg/cli/command.go

@@ -8,6 +8,7 @@ import (
 
 type Command struct {
 	Name      string
+	Use       string
 	Short     string
 	Long      string
 	Example   string

pkg/cli/docs.go

@@ -0,0 +1,144 @@
+package cli
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+)
+
+const markdownExtension = ".md"
+
+func (c *Command) GenMarkdown(dir string) error {
+	basename := strings.ReplaceAll(c.Name, " ", "_") + markdownExtension
+	filename := filepath.Join(dir, basename)
+	f, err := os.Create(filename)
+	if err != nil {
+		return err
+	}
+	defer f.Close()
+
+	if err = writeCommand(c, f); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func writeCommand(c *Command, f *os.File) error {
+	if _, err := f.WriteString(fmt.Sprintf("# %s\n\n", c.Name)); err != nil {
+		return err
+	}
+
+	if _, err := f.WriteString(fmt.Sprintf("> %s\n\n", c.Short)); err != nil {
+		return err
+	}
+
+	if c.Long != "" {
+		if _, err := f.WriteString(fmt.Sprintf("## Description\n\n %s\n\n", c.Long)); err != nil {
+			return err
+		}
+	}
+
+	if c.Use != "" {
+		use := fmt.Sprintf("```bash\n%s\n```\n\n", c.Use)
+		if _, err := f.WriteString(fmt.Sprintf("## Usage\n\n%s\n\n", use)); err != nil {
+			return err
+		}
+	}
+
+	flags := map[*Flag]bool{}
+	flagList := []*Flag{}
+	_ = c.Flags().Visit(func(flag *Flag) error {
+		_, ok := flags[flag]
+		if !ok {
+			flags[flag] = true
+			flagList = append(flagList, flag)
+		}
+		return nil
+	})
+	if len(flags) > 0 {
+		s, err := renderlags(flagList)
+		if err != nil {
+			return err
+		}
+		if _, err = f.WriteString(s); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func renderlags(flags []*Flag) (string, error) {
+	type key struct {
+		group    string
+		subgroup string
+	}
+
+	m := map[key][]*Flag{}
+	groups := []key{}
+
+	for _, f := range flags {
+		g, sg := splitFlagName(f.Name)
+		k := key{g, sg}
+		m[k] = append(m[k], f)
+		groups = append(groups, k)
+	}
+
+	var sb strings.Builder
+	currentGroup := ""
+	for _, g := range groups {
+
+		if g.group != currentGroup {
+			if _, err := sb.WriteString(fmt.Sprintf("### %s\n\n", g.group)); err != nil {
+				return "", err
+			}
+			currentGroup = g.group
+		}
+
+		if g.subgroup != "" {
+			if _, err := sb.WriteString(fmt.Sprintf("#### %s\n\n", g.subgroup)); err != nil {
+				return "", err
+			}
+		}
+
+		if _, err := sb.WriteString(`| Flag | Shorthand | Type | Default | Usage |
+|------|-----------|------|---------|-------|
+`,
+		); err != nil {
+			return "", err
+		}
+		for _, flag := range m[g] {
+			short := flag.Shorthand
+			if short == "" {
+				short = "-"
+			} else {
+				short = "-" + short
+			}
+			defaultValue := "-"
+			if flag.DefaultValue != nil && flag.DefaultValue != "" {
+				defaultValue = fmt.Sprintf("%v", flag.DefaultValue)
+			}
+			if _, err := sb.WriteString(fmt.Sprintf("| --%s | %s | %s | %s | %s |\n", flag.Name, short, flag.Value.Type(), defaultValue, flag.Usage)); err != nil {
+				return "", err
+			}
+		}
+		if _, err := sb.WriteString("\n"); err != nil {
+			return "", err
+		}
+	}
+
+	return sb.String(), nil
+}
+
+func splitFlagName(name string) (group, subgroup string) {
+	parts := strings.Split(name, "-")
+
+	switch len(parts) {
+	case 1:
+		return "General", ""
+	default:
+		return caser.String(parts[0]), caser.String(parts[1])
+	}
+}

pkg/cli/flag_bool.go

@@ -34,6 +34,10 @@ func (b *boolFlag) IsSet() bool {
 	return b.isSet
 }
 
+func (*boolFlag) Type() string {
+	return "bool"
+}
+
 func (b *boolFlag) String() string {
 	return fmt.Sprintf("%v", b.value)
 }

pkg/cli/flag_file.go

@@ -24,6 +24,10 @@ func (f *fileFlag) IsSet() bool {
 	return f.isSet
 }
 
+func (f *fileFlag) Type() string {
+	return "file"
+}
+
 func (f *fileFlag) String() string {
 	return fmt.Sprintf("%v", f.value)
 }

pkg/cli/flag_float.go

@@ -33,6 +33,10 @@ func (f *floatFlag) IsSet() bool {
 	return f.isSet
 }
 
+func (f *floatFlag) Type() string {
+	return "float"
+}
+
 func (f *floatFlag) String() string {
 	return fmt.Sprintf("%f", f.value)
 }

pkg/cli/flag_int.go

@@ -38,6 +38,10 @@ func (f *intFlag) IsSet() bool {
 	return f.isSet
 }
 
+func (f *intFlag) Type() string {
+	return "int"
+}
+
 func (f *intFlag) String() string {
 	return fmt.Sprintf("%d", f.value)
 }

pkg/cli/flag_slice.go

@@ -36,6 +36,10 @@ func (f *stringSliceFlag) IsSet() bool {
 	return f.isSet
 }
 
+func (f *stringSliceFlag) Type() string {
+	return "list"
+}
+
 func (f *stringSliceFlag) String() string {
 	return strings.Join(f.value, ",")
 }

pkg/cli/flag_string.go

@@ -29,6 +29,8 @@ func (f *stringFlag) String() string {
 
 func (f *stringFlag) IsSet() bool { return f.isSet }
 
+func (f *stringFlag) Type() string { return "string" }
+
 func (fs *FlagSet) String(name string, defaultValue string, usage string) {
 	fs.StringShort(name, "", defaultValue, usage)
 }

pkg/cli/flags.go

@@ -20,6 +20,7 @@ type Flag struct {
 	Usage        string
 	Value        Value
 	DefaultValue any
+	Aliases      []string
 }
 
 type DynamicFlag struct {
@@ -37,6 +38,7 @@ type Value interface {
 	Value() any
 	String() string
 	IsSet() bool
+	Type() string
 }
 
 func (fs *FlagSet) setFlag(f *Flag) {
@@ -106,6 +108,7 @@ func (fs *FlagSet) Alias(name, alias string) {
 		panic(fmt.Sprintf("flag '%v' does not exist", name))
 	}
 	fs.flags[alias] = f
+	f.Aliases = append(f.Aliases, alias)
 }
 
 func (fs *FlagSet) Visit(fn func(*Flag) error) error {