Refactor StringArgsDispatcher and SuperStringArgsDispatcher to include baseCommand parameter, streamline command printing, and enhance command completion functionality.

Author: ungerik

cli/stringargsdispatcher.go

@@ -3,11 +3,9 @@ package cli
 import (
 	"context"
 	"fmt"
-	"io"
 	"maps"
 	"reflect"
 	"slices"
-	"sort"
 	"strings"
 	"unicode"
 
@@ -46,14 +44,16 @@ func (f StringArgsCommandLoggerFunc) LogStringArgsCommand(command string, args [
 }
 
 type StringArgsDispatcher struct {
-	comm    map[string]*stringArgsCommand
-	loggers []StringArgsCommandLogger
+	baseCommand string
+	comm        map[string]*stringArgsCommand
+	loggers     []StringArgsCommandLogger
 }
 
-func NewStringArgsDispatcher(loggers ...StringArgsCommandLogger) *StringArgsDispatcher {
+func NewStringArgsDispatcher(baseCommand string, loggers ...StringArgsCommandLogger) *StringArgsDispatcher {
 	return &StringArgsDispatcher{
-		comm:    make(map[string]*stringArgsCommand),
-		loggers: loggers,
+		baseCommand: baseCommand,
+		comm:        make(map[string]*stringArgsCommand),
+		loggers:     loggers,
 	}
 }
 
@@ -159,17 +159,13 @@ func (disp *StringArgsDispatcher) MustDispatchCombinedCommandAndArgs(ctx context
 	return command
 }
 
-func (disp *StringArgsDispatcher) PrintCommands(appName string) {
-	list := make([]*stringArgsCommand, 0, len(disp.comm))
-	for _, cmd := range disp.comm {
-		list = append(list, cmd)
-	}
-	sort.Slice(list, func(i, j int) bool {
-		return list[i].command < list[j].command
+func (disp *StringArgsDispatcher) PrintCommands() {
+	commands := slices.SortedFunc(maps.Values(disp.comm), func(a, b *stringArgsCommand) int {
+		return strings.Compare(a.command, b.command)
 	})
 
-	for _, cmd := range list {
-		UsageColor.Printf("  %s %s %s\n", appName, cmd.command, functionArgsString(cmd.commandFunc))
+	for _, cmd := range commands {
+		UsageColor.Printf("  %s %s %s\n", disp.baseCommand, cmd.command, functionArgsString(cmd.commandFunc))
 		if cmd.description != "" {
 			DescriptionColor.Printf("      %s\n", cmd.description)
 		}
@@ -189,11 +185,26 @@ func (disp *StringArgsDispatcher) PrintCommands(appName string) {
 	}
 }
 
-func (disp *StringArgsDispatcher) PrintCommandsUsageIntro(appName string, output io.Writer) {
-	if len(disp.comm) > 0 {
-		fmt.Fprint(output, "Commands:\n")
-		disp.PrintCommands(appName)
-		fmt.Fprint(output, "Flags:\n")
+func (disp *StringArgsDispatcher) PrintCommandsUsageIntro() {
+	if len(disp.comm) == 0 {
+		return
+	}
+	fmt.Println("Commands:")
+	disp.PrintCommands()
+}
+
+func (disp *StringArgsDispatcher) PrintCompletion(args []string) {
+	prefix := ""
+	if len(args) > 0 {
+		prefix = args[0]
+	}
+	commands := slices.SortedFunc(maps.Values(disp.comm), func(a, b *stringArgsCommand) int {
+		return strings.Compare(a.command, b.command)
+	})
+	for _, cmd := range commands {
+		if strings.HasPrefix(cmd.command, prefix) {
+			fmt.Println(disp.baseCommand, cmd.command)
+		}
 	}
 }
 

cli/superstringargsdispatcher.go

@@ -3,23 +3,25 @@ package cli
 import (
 	"context"
 	"fmt"
-	"io"
 	"maps"
 	"slices"
 	"sort"
+	"strings"
 
 	"github.com/domonda/go-function"
 )
 
 type SuperStringArgsDispatcher struct {
-	sub     map[string]*StringArgsDispatcher
-	loggers []StringArgsCommandLogger
+	baseCommand string
+	sub         map[string]*StringArgsDispatcher
+	loggers     []StringArgsCommandLogger
 }
 
-func NewSuperStringArgsDispatcher(loggers ...StringArgsCommandLogger) *SuperStringArgsDispatcher {
+func NewSuperStringArgsDispatcher(baseCommand string, loggers ...StringArgsCommandLogger) *SuperStringArgsDispatcher {
 	return &SuperStringArgsDispatcher{
-		sub:     make(map[string]*StringArgsDispatcher),
-		loggers: loggers,
+		baseCommand: baseCommand,
+		sub:         make(map[string]*StringArgsDispatcher),
+		loggers:     loggers,
 	}
 }
 
@@ -32,7 +34,7 @@ func (disp *SuperStringArgsDispatcher) AddSuperCommand(superCommand string) (sub
 	if _, exists := disp.sub[superCommand]; exists {
 		return nil, fmt.Errorf("super command already added: '%s'", superCommand)
 	}
-	subDisp = NewStringArgsDispatcher(disp.loggers...)
+	subDisp = NewStringArgsDispatcher(disp.baseCommand, disp.loggers...)
 	disp.sub[superCommand] = subDisp
 	return subDisp, nil
 }
@@ -160,33 +162,32 @@ func (disp *SuperStringArgsDispatcher) MustDispatchCombinedCommandAndArgs(ctx co
 	return superCommand, command
 }
 
-func (disp *SuperStringArgsDispatcher) PrintCommands(appName string) {
+func (disp *SuperStringArgsDispatcher) PrintCommands() {
 	type superCmd struct {
 		super string
 		cmd   *stringArgsCommand
 	}
-
-	var list []superCmd
+	var commands []superCmd
 	for super, sub := range disp.sub {
 		for _, cmd := range sub.comm {
-			list = append(list, superCmd{super: super, cmd: cmd})
+			commands = append(commands, superCmd{super: super, cmd: cmd})
 		}
 	}
-	sort.Slice(list, func(i, j int) bool {
-		if list[i].super == list[j].super {
-			return list[i].cmd.command < list[j].cmd.command
+	sort.Slice(commands, func(i, j int) bool {
+		if commands[i].super == commands[j].super {
+			return commands[i].cmd.command < commands[j].cmd.command
 		}
-		return list[i].super < list[j].super
+		return commands[i].super < commands[j].super
 	})
 
-	for i := range list {
-		cmd := list[i].cmd
-		command := list[i].super
+	for i := range commands {
+		cmd := commands[i].cmd
+		command := commands[i].super
 		if cmd.command != DefaultCommand {
 			command += " " + cmd.command
 		}
 
-		UsageColor.Printf("  %s %s %s\n", appName, command, functionArgsString(cmd.commandFunc))
+		UsageColor.Printf("  %s %s %s\n", disp.baseCommand, command, functionArgsString(cmd.commandFunc))
 		if cmd.description != "" {
 			DescriptionColor.Printf("      %s\n", cmd.description)
 		}
@@ -206,10 +207,45 @@ func (disp *SuperStringArgsDispatcher) PrintCommands(appName string) {
 	}
 }
 
-func (disp *SuperStringArgsDispatcher) PrintCommandsUsageIntro(appName string, output io.Writer) {
-	if len(disp.sub) > 0 {
-		fmt.Fprint(output, "Commands:\n")
-		disp.PrintCommands(appName)
-		// fmt.Fprint(output, "Flags:\n")
+func (disp *SuperStringArgsDispatcher) PrintCommandsUsageIntro() {
+	if len(disp.sub) == 0 {
+		return
+	}
+	fmt.Println("Commands:")
+	disp.PrintCommands()
+}
+
+func (disp *SuperStringArgsDispatcher) PrintCompletion(args []string) {
+	prefix := ""
+	if len(args) > 0 {
+		prefix = args[0]
+	}
+	type superCmd struct {
+		super string
+		cmd   *stringArgsCommand
+	}
+	var commands []superCmd
+	for super, sub := range disp.sub {
+		for _, cmd := range sub.comm {
+			commands = append(commands, superCmd{super: super, cmd: cmd})
+		}
+	}
+	sort.Slice(commands, func(i, j int) bool {
+		if commands[i].super == commands[j].super {
+			return commands[i].cmd.command < commands[j].cmd.command
+		}
+		return commands[i].super < commands[j].super
+	})
+
+	for i := range commands {
+		cmd := commands[i].cmd
+		command := commands[i].super
+		if cmd.command != DefaultCommand {
+			command += " " + cmd.command
+		}
+		// TODO subcommand completion
+		if strings.HasPrefix(command, prefix) {
+			fmt.Println(disp.baseCommand, command)
+		}
 	}
 }