Add new command to list flags for documentation

Signed-off-by: Omer Aplatony <[email protected]>

cmd/flags.go

@@ -0,0 +1,48 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+)
+
+var generateReadmeFlags = map[string]bool{
+	"print": true,
+}
+
+func newListFlagsCommand(rootCmd *cobra.Command) *cobra.Command {
+	return &cobra.Command{
+		Use:   "list-flags",
+		Short: "Lists all flags for documentation",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			printCommandFlags(rootCmd, "")
+			return nil
+		},
+	}
+}
+
+func printCommandFlags(cmd *cobra.Command, indent string) {
+	_, ok := generateReadmeFlags[cmd.Use]
+	if ok {
+		fmt.Printf("%s### `%s` command\n\n", indent, cmd.Use)
+
+		fmt.Printf("%s| Flag                          | Default Value            | Required | Description                                                  |\n", indent)
+		fmt.Printf("%s| ----------------------------- | ------------------------ | -------- | ------------------------------------------------------------ |\n", indent)
+
+		cmd.Flags().VisitAll(func(flag *pflag.Flag) {
+			fmt.Printf("%s| `%-27s` | %-24s | %-8v | %s |\n",
+				indent,
+				flag.Name,
+				flag.DefValue,
+				flag.NoOptDefVal == "",
+				flag.Usage,
+			)
+		})
+		fmt.Println()
+	}
+
+	for _, subCmd := range cmd.Commands() {
+		printCommandFlags(subCmd, indent+"  ")
+	}
+}

cmd/print.go

@@ -257,8 +257,7 @@ func newPrintCommand() *cobra.Command {
 		`If present, the namespace scope for this CLI request.`)
 
 	cmd.Flags().BoolVarP(&pr.allNamespaces, "all-namespaces", "A", false,
-		`If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even
-if specified with --namespace.`)
+		`If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.`)
 
 	cmd.Flags().StringSliceVar(&pr.providers, "providers", []string{},
 		fmt.Sprintf("If present, the tool will try to convert only resources related to the specified providers, supported values are %v.", i2gw.GetSupportedProviders()))

cmd/root.go

@@ -48,6 +48,7 @@ func getKubeconfig() {
 func Execute() {
 	rootCmd := newRootCmd()
 	rootCmd.AddCommand(newPrintCommand())
+	rootCmd.AddCommand(newListFlagsCommand(rootCmd))
 	err := rootCmd.Execute()
 	if err != nil {
 		os.Exit(1)