Improve args passing and DynamicSuggestionsFunc()

_example/main.go

@@ -7,6 +7,7 @@ import (
 	"github.com/elk-language/go-prompt"
 	cobraprompt "github.com/ionoscloudsdk/comptplus"
 	"github.com/ionoscloudsdk/comptplus/_example/cmd"
+	"github.com/spf13/cobra"
 )
 
 var advancedPrompt = &cobraprompt.CobraPrompt{
@@ -20,7 +21,7 @@ var advancedPrompt = &cobraprompt.CobraPrompt{
 		prompt.WithPrefix(">(^!^)> "),
 		prompt.WithMaxSuggestion(10),
 	},
-	DynamicSuggestionsFunc: func(annotationValue string, document *prompt.Document) []prompt.Suggest {
+	DynamicSuggestionsFunc: func(_ *cobra.Command, annotationValue string, document *prompt.Document) []prompt.Suggest {
 		if suggestions := cmd.GetFoodDynamic(annotationValue); suggestions != nil {
 			return suggestions
 		}

comptplus.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/elk-language/go-prompt"
 	istrings "github.com/elk-language/go-prompt/strings"
+	shellquote "github.com/kballard/go-shellquote"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
@@ -29,7 +30,7 @@ type CobraPrompt struct {
 
 	// DynamicSuggestionsFunc will be executed if a command has CallbackAnnotation as an annotation. If it's included
 	// the value will be provided to the DynamicSuggestionsFunc function.
-	DynamicSuggestionsFunc func(annotationValue string, document *prompt.Document) []prompt.Suggest
+	DynamicSuggestionsFunc func(cmd *cobra.Command, annotationValue string, document *prompt.Document) []prompt.Suggest
 
 	// PersistFlagValues will persist flags. For example have verbose turned on every command.
 	PersistFlagValues bool
@@ -61,7 +62,7 @@ type CobraPrompt struct {
 	// HookBefore is a hook that will be executed every time before a command is executed
 	HookBefore func(cmd *cobra.Command, input string) error
 
-	// InArgsParser adds a custom parser for the command line arguments (default: strings.Fields)
+	// InArgsParser adds a custom parser for the command line arguments (default: shellquote.Split)
 	InArgsParser func(args string) []string
 
 	// SuggestionFilter will be uses when filtering suggestions as typing
@@ -103,7 +104,6 @@ func (co *CobraPrompt) RunContext(ctx context.Context) {
 			defValue := strings.Trim(flag.DefValue, "[]")
 			defaultSlice := strings.Split(defValue, ",")
 			err := sliceValue.Replace(defaultSlice)
-
 			if err != nil {
 				// If there's an error parsing defaultSlice as a slice, try this workaround
 				errShouldNeverHappenButWeAreProfessionals := sliceValue.Replace([]string{})
@@ -152,8 +152,9 @@ func (co *CobraPrompt) resetFlagsToDefault(cmd *cobra.Command) {
 func (co *CobraPrompt) executeCommand(ctx context.Context) func(string) {
 	return func(input string) {
 		args := co.parseInput(input)
-		os.Args = append([]string{os.Args[0]}, args...)
-		executedCmd, _, _ := co.RootCmd.Find(os.Args[1:])
+		co.RootCmd.SetArgs(args)
+
+		executedCmd, _, _ := co.RootCmd.Find(args)
 
 		if err := co.HookBefore(executedCmd, input); err != nil {
 			co.handleUserError(err)
@@ -190,7 +191,11 @@ func (co *CobraPrompt) parseInput(input string) []string {
 	if co.InArgsParser != nil {
 		return co.InArgsParser(input)
 	}
-	return strings.Fields(input)
+
+	// Treat input as a shell command and split it into arguments
+	args, _ := shellquote.Split(input)
+
+	return args
 }
 
 func (co *CobraPrompt) prepareCommands() {
@@ -214,7 +219,8 @@ func (co *CobraPrompt) prepareCommands() {
 // findSuggestions generates command and flag suggestions for the prompt.
 func (co *CobraPrompt) findSuggestions(d prompt.Document) ([]prompt.Suggest, istrings.RuneNumber, istrings.RuneNumber) {
 	command := co.RootCmd
-	args := strings.Fields(d.CurrentLine())
+	args, _ := shellquote.Split(d.CurrentLine())
+
 	w := d.GetWordBeforeCursor()
 
 	endIndex := d.CurrentRuneIndex()
@@ -270,6 +276,7 @@ func getFlagSuggestions(cmd *cobra.Command, co *CobraPrompt, d prompt.Document)
 
 	cmd.LocalFlags().VisitAll(addFlags)
 	cmd.InheritedFlags().VisitAll(addFlags)
+
 	return suggestions
 }
 
@@ -291,7 +298,7 @@ func getDynamicSuggestions(cmd *cobra.Command, co *CobraPrompt, d prompt.Documen
 	var suggestions []prompt.Suggest
 	if dynamicSuggestionKey, ok := cmd.Annotations[DynamicSuggestionsAnnotation]; ok {
 		if co.DynamicSuggestionsFunc != nil {
-			dynamicSuggestions := co.DynamicSuggestionsFunc(dynamicSuggestionKey, &d)
+			dynamicSuggestions := co.DynamicSuggestionsFunc(cmd, dynamicSuggestionKey, &d)
 			suggestions = append(suggestions, dynamicSuggestions...)
 		}
 	}
@@ -308,7 +315,8 @@ func getFlagValueSuggestions(cmd *cobra.Command, d prompt.Document, currentFlag
 	}
 
 	if compFunc, exists := cmd.GetFlagCompletionFunc(currentFlag); exists {
-		completions, _ := compFunc(cmd, strings.Fields(d.CurrentLine()), currentFlag)
+		args, _ := shellquote.Split(d.CurrentLine())
+		completions, _ := compFunc(cmd, args, currentFlag)
 		for _, completion := range completions {
 			text, description, _ := strings.Cut(completion, "\t")
 			suggestions = append(suggestions, prompt.Suggest{Text: text, Description: description})
@@ -321,7 +329,7 @@ func getFlagValueSuggestions(cmd *cobra.Command, d prompt.Document, currentFlag
 //   - current flag
 //   - whether the context is suitable for flag value suggestions.
 func getCurrentFlagAndValueContext(d prompt.Document, cmd *cobra.Command) (string, bool) {
-	prevWords := strings.Fields(d.TextBeforeCursor())
+	prevWords, _ := shellquote.Split(d.TextBeforeCursor())
 	textBeforeCursor := d.TextBeforeCursor()
 	hasSpaceSuffix := strings.HasSuffix(textBeforeCursor, " ")
 

comptplus_test.go

@@ -4,25 +4,34 @@ import (
 	"testing"
 
 	"github.com/elk-language/go-prompt"
+	"github.com/elk-language/go-prompt/strings"
 	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestFindSuggestions(t *testing.T) {
-	rootCmd := newTestCommand("root", "The root cmd")
-	getCmd := newTestCommand("get", "Get something")
-	getObjectCmd := newTestCommand("object", "Get the object")
+	// Command 1: root get thing
 	getThingCmd := newTestCommand("thing", "The thing")
+
+	// Command 2: root get food
 	getFoodCmd := newTestCommand("food", "Get some food")
 	getFoodCmd.PersistentFlags().StringP("name", "n", "John", "name of the person to get some food from")
 	_ = getFoodCmd.RegisterFlagCompletionFunc("name", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		return []string{"John", "Mary\tMarianne - John's Mother", "Anne"}, cobra.ShellCompDirectiveNoFileComp
 	})
 
-	rootCmd.AddCommand(getCmd)
-	getCmd.AddCommand(getObjectCmd, getThingCmd, getFoodCmd)
+	// Command 3: root get object
+	getObjectCmd := newTestCommand("object", "Get the object")
 	getObjectCmd.Flags().BoolP("verbose", "v", false, "Verbose log")
 
+	// Command 4: root get
+	getCmd := newTestCommand("get", "Get something")
+	getCmd.AddCommand(getObjectCmd, getThingCmd, getFoodCmd)
+
+	// Root: root
+	rootCmd := newTestCommand("root", "The root cmd")
+	rootCmd.AddCommand(getCmd)
+
 	cp := &CobraPrompt{
 		RootCmd: rootCmd,
 	}
@@ -72,7 +81,8 @@ func TestFindSuggestions(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			buf := prompt.NewBuffer()
-			buf.InsertText(test.input, true)
+			buf.InsertTextMoveCursor(test.input, strings.GetWidth(test.input), 0, true)
+
 			suggestions, _, _ := cp.findSuggestions(*buf.Document())
 
 			assert.Len(t, suggestions, len(test.expectedResults), "Incorrect number of suggestions")

go.mod

@@ -4,6 +4,7 @@ go 1.17
 
 require (
 	github.com/elk-language/go-prompt v1.1.5
+	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
 	github.com/spf13/cobra v1.8.0
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.7.0

go.sum

@@ -9,6 +9,8 @@ github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs=
+github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
 github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=