fix(ctl): template keys list

Added a command `stamusctl template keys` to list the available keys in a template.

Author: LeVraiBaptiste

cmd/ctl/root.go

@@ -6,6 +6,7 @@ import (
 
 	"stamus-ctl/cmd/ctl/compose"
 	"stamus-ctl/cmd/ctl/config"
+	tmpl "stamus-ctl/cmd/ctl/template"
 	"stamus-ctl/internal/logging"
 	"stamus-ctl/internal/models"
 
@@ -47,5 +48,6 @@ func rootCmd() *cobra.Command {
 	cmd.AddCommand(loginCmd())
 	cmd.AddCommand(compose.ComposeCmd())
 	cmd.AddCommand(config.ConfigCmd())
+	cmd.AddCommand(tmpl.TemplateCmd())
 	return cmd
 }

cmd/ctl/template/keys.go

@@ -0,0 +1,41 @@
+package config
+
+import (
+	"fmt"
+	flags "stamus-ctl/internal/handlers"
+	tmpl "stamus-ctl/internal/handlers/template"
+
+	"github.com/spf13/cobra"
+)
+
+// Command
+func keysCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "keys",
+		Short: "Get list of template keys",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return keysHandler()
+		},
+	}
+	// Flags
+	flags.Template.AddAsFlag(cmd, false)
+	flags.Markdown.AddAsFlag(cmd, false)
+	return cmd
+}
+
+func keysHandler() error {
+	// Validate flags
+	value, err := flags.Template.GetValue()
+	if err != nil {
+		return err
+	}
+	if value == "" {
+		return fmt.Errorf("template folder is required, use --template or -t to set and `config list` to list available templates")
+	}
+	isMd, err := flags.Markdown.GetValue()
+	if err != nil {
+		return err
+	}
+	// Call handler
+	return tmpl.KeysHandler(value.(string), isMd.(bool))
+}

cmd/ctl/template/root.go

@@ -0,0 +1,30 @@
+package config
+
+import (
+	// Common
+
+	// External
+
+	"github.com/spf13/cobra"
+	// Custom
+	"stamus-ctl/internal/app"
+	"stamus-ctl/internal/embeds"
+)
+
+// Init
+func init() {
+	// Setup
+	embeds.InitClearNDRFolder(app.DefaultClearNDRPath)
+}
+
+// Commands
+func TemplateCmd() *cobra.Command {
+	// Create command
+	cmd := &cobra.Command{
+		Use:   "template",
+		Short: "Interact with compose config file",
+	}
+	// Add Commands
+	cmd.AddCommand(keysCmd())
+	return cmd
+}

internal/handlers/template/keys.go

@@ -0,0 +1,56 @@
+package config
+
+import (
+	"os"
+	"stamus-ctl/internal/models"
+
+	"github.com/jedib0t/go-pretty/v6/table"
+)
+
+func KeysHandler(templatePath string, isMd bool) error {
+	// Get template keys
+	confFile, err := models.CreateFile(templatePath, "config.yaml")
+	if err != nil {
+		return err
+	}
+	config, err := models.ConfigFromFile(confFile)
+	if err != nil {
+		return err
+	}
+	params, _, err := config.ExtractParams()
+	if err != nil {
+		return err
+	}
+	// Prepare data
+	rows := []table.Row{}
+	for _, name := range params.GetOrdered() {
+		param := params.Get(name)
+		choices := ""
+		if param.Choices != nil {
+			for nb, choice := range param.Choices {
+				choices = choices + choice.AsString()
+				if nb != len(param.Choices)-1 {
+					choices = choices + ", "
+					if nb%4 == 3 {
+						choices = choices + "\n"
+					}
+				}
+			}
+		}
+		rows = append(rows, table.Row{name, param.Type, param.Default.AsString(), choices})
+	}
+	// Print
+	t := table.NewWriter()
+	t.SetStyle(table.StyleRounded)
+	header := table.Row{"Key", "Type", "Default", "Choices"}
+	t.SetOutputMirror(os.Stdout)
+	t.AppendHeader(header)
+	t.AppendRows(rows)
+	t.AppendFooter(header)
+	if isMd {
+		t.RenderMarkdown()
+	} else {
+		t.Render()
+	}
+	return nil
+}