docs: add CLI usage and integrate generation in release

cmd/docs.go

@@ -3,36 +3,18 @@ package cmd
 import (
 	"bytes"
 	"fmt"
-	"io"
 	"os"
-	"path/filepath"
-	"sort"
+	"path"
+	"regexp"
 	"strings"
 
 	"github.com/spf13/cobra"
-	"github.com/spf13/pflag"
+	"github.com/spf13/cobra/doc"
 )
 
 func init() {
 	rootCmd.AddCommand(docsCmd)
-	docsCmd.Flags().StringP("path", "p", "./docs", "path to save the docs")
-}
-
-func printToc(names []string) {
-	for i, name := range names {
-		name = strings.TrimSuffix(name, filepath.Ext(name))
-		name = strings.ReplaceAll(name, "-", " ")
-		names[i] = name
-	}
-
-	sort.Strings(names)
-
-	toc := ""
-	for _, name := range names {
-		toc += "* [" + name + "](cli/" + strings.ReplaceAll(name, " ", "-") + ".md)\n"
-	}
-
-	fmt.Println(toc)
+	docsCmd.Flags().String("out", "www/docs/cli", "directory to write the docs to")
 }
 
 var docsCmd = &cobra.Command{
@@ -40,115 +22,61 @@ var docsCmd = &cobra.Command{
 	Hidden: true,
 	Args:   cobra.NoArgs,
 	RunE: func(cmd *cobra.Command, _ []string) error {
-		dir, err := getString(cmd.Flags(), "path")
+		outputDir, err := cmd.Flags().GetString("out")
 		if err != nil {
 			return err
 		}
 
-		err = generateDocs(rootCmd, dir)
+		tempDir, err := os.MkdirTemp(os.TempDir(), "filebrowser-docs-")
 		if err != nil {
 			return err
 		}
-		names := []string{}
+		defer os.RemoveAll(tempDir)
 
-		err = filepath.Walk(dir, func(_ string, info os.FileInfo, err error) error {
-			if err != nil || info.IsDir() {
-				return err
-			}
+		rootCmd.Root().DisableAutoGenTag = true
 
-			if !strings.HasPrefix(info.Name(), "filebrowser") {
-				return nil
-			}
-
-			names = append(names, info.Name())
-			return nil
+		err = doc.GenMarkdownTreeCustom(cmd.Root(), tempDir, func(f string) string {
+			return ""
+		}, func(s string) string {
+			return s
 		})
 		if err != nil {
 			return err
 		}
 
-		printToc(names)
-		return nil
-	},
-}
-
-func generateDocs(cmd *cobra.Command, dir string) error {
-	for _, c := range cmd.Commands() {
-		if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
-			continue
-		}
-
-		err := generateDocs(c, dir)
+		entries, err := os.ReadDir(tempDir)
 		if err != nil {
 			return err
 		}
-	}
 
-	basename := strings.ReplaceAll(cmd.CommandPath(), " ", "-") + ".md"
-	filename := filepath.Join(dir, basename)
-	f, err := os.Create(filename)
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-	return generateMarkdown(cmd, f)
-}
-
-func generateMarkdown(cmd *cobra.Command, w io.Writer) error {
-	cmd.InitDefaultHelpCmd()
-	cmd.InitDefaultHelpFlag()
-
-	buf := new(bytes.Buffer)
-	name := cmd.CommandPath()
-
-	short := cmd.Short
-	long := cmd.Long
-	if long == "" {
-		long = short
-	}
-
-	buf.WriteString("---\ndescription: " + short + "\n---\n\n")
-	buf.WriteString("# " + name + "\n\n")
-	buf.WriteString("## Synopsis\n\n")
-	buf.WriteString(long + "\n\n")
-
-	if cmd.Runnable() {
-		_, _ = fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.UseLine())
-	}
-
-	if cmd.Example != "" {
-		buf.WriteString("## Examples\n\n")
-		_, _ = fmt.Fprintf(buf, "```\n%s\n```\n\n", cmd.Example)
-	}
-
-	printOptions(buf, cmd)
-	_, err := buf.WriteTo(w)
-	return err
-}
-
-func generateFlagsTable(fs *pflag.FlagSet, buf io.StringWriter) {
-	_, _ = buf.WriteString("| Name | Shorthand | Usage |\n")
-	_, _ = buf.WriteString("|------|-----------|-------|\n")
-
-	fs.VisitAll(func(f *pflag.Flag) {
-		_, _ = buf.WriteString("|" + f.Name + "|" + f.Shorthand + "|" + f.Usage + "|\n")
-	})
-}
-
-func printOptions(buf *bytes.Buffer, cmd *cobra.Command) {
-	flags := cmd.NonInheritedFlags()
-	flags.SetOutput(buf)
-	if flags.HasAvailableFlags() {
-		buf.WriteString("## Options\n\n")
-		generateFlagsTable(flags, buf)
-		buf.WriteString("\n")
-	}
-
-	parentFlags := cmd.InheritedFlags()
-	parentFlags.SetOutput(buf)
-	if parentFlags.HasAvailableFlags() {
-		buf.WriteString("### Inherited\n\n")
-		generateFlagsTable(parentFlags, buf)
-		buf.WriteString("\n")
-	}
+		headerRegex := regexp.MustCompile(`(?m)^(##)(.*)$`)
+		linkRegex := regexp.MustCompile(`\(filebrowser(.*)\.md\)`)
+
+		fmt.Println("Generated Documents:")
+
+		for _, entry := range entries {
+			srcPath := path.Join(tempDir, entry.Name())
+			dstPath := path.Join(outputDir, strings.ReplaceAll(entry.Name(), "_", "-"))
+
+			data, err := os.ReadFile(srcPath)
+			if err != nil {
+				return err
+			}
+
+			data = headerRegex.ReplaceAll(data, []byte("#$2"))
+			data = linkRegex.ReplaceAllFunc(data, func(b []byte) []byte {
+				return bytes.ReplaceAll(b, []byte("_"), []byte("-"))
+			})
+			data = bytes.ReplaceAll(data, []byte("## SEE ALSO"), []byte("## See Also"))
+
+			err = os.WriteFile(dstPath, data, 0666)
+			if err != nil {
+				return err
+			}
+
+			fmt.Println("- " + dstPath)
+		}
+
+		return nil
+	},
 }