Enable use of carapace completer as a library

action.go

@@ -94,14 +94,14 @@ func (a Action) Filter(values ...string) Action {
 	})
 }
 
-// FilterArgs filters Context.Args
+// FilterArgs filters Context.Args.
 func (a Action) FilterArgs() Action {
 	return ActionCallback(func(c Context) Action {
 		return a.Filter(c.Args...)
 	})
 }
 
-// FilterArgs filters Context.Parts
+// FilterArgs filters Context.Parts.
 func (a Action) FilterParts() Action {
 	return ActionCallback(func(c Context) Action {
 		return a.Filter(c.Parts...)
@@ -142,7 +142,7 @@ func (a Action) MultiParts(dividers ...string) Action {
 	})
 }
 
-// MultiPartsP is like MultiParts but with placeholders
+// MultiPartsP is like MultiParts but with placeholders.
 func (a Action) MultiPartsP(delimiter string, pattern string, f func(placeholder string, matches map[string]string) Action) Action {
 	return ActionCallback(func(c Context) Action {
 		invoked := a.Invoke(c)

compat.go

@@ -73,7 +73,7 @@ func (d compDirective) ToA(values ...string) Action {
 	var action Action
 	switch {
 	case d.matches(cobra.ShellCompDirectiveError):
-		return ActionMessage("an error occured")
+		return ActionMessage("an error occurred")
 	case d.matches(cobra.ShellCompDirectiveFilterDirs):
 		switch len(values) {
 		case 0:

complete.go

@@ -1,13 +1,42 @@
 package carapace
 
 import (
+	"github.com/rsteube/carapace/internal/common"
 	"github.com/rsteube/carapace/internal/config"
 	"github.com/rsteube/carapace/internal/shell/bash"
+	"github.com/rsteube/carapace/internal/shell/library"
 	"github.com/rsteube/carapace/internal/shell/nushell"
 	"github.com/rsteube/carapace/pkg/ps"
 	"github.com/spf13/cobra"
 )
 
+// Complete can be used by Go programs wishing to produce completions for
+// themselves, without passing through shell snippets/output or export formats.
+//
+// The `onFinalize` function parameter, if non nil, will be called after having
+// generated the completions from the given command/tree. This function is generally
+// used to reset the command tree, which is needed when the Go program is a shell itself.
+// Also, and before calling `onFinalize` if not nil, the completion storage is cleared.
+func Complete(cmd *cobra.Command, args []string, onFinalize func()) (common.RawValues, common.Meta) {
+	// Generate the completion as normally done for an external system shell
+	initHelpCompletion(cmd)
+	action, context := traverse(cmd, args[2:])
+
+	if err := config.Load(); err != nil {
+		action = ActionMessage("failed to load config: " + err.Error())
+	}
+
+	if onFinalize != nil {
+		storage = make(_storage)
+
+		onFinalize()
+	}
+
+	invoked := action.Invoke(context)
+
+	return library.ActionRawValues(context.Value, invoked.meta, invoked.rawValues)
+}
+
 func complete(cmd *cobra.Command, args []string) (string, error) {
 	switch len(args) {
 	case 0:

example/cmd/chain.go

@@ -41,5 +41,4 @@ func init() {
 			return carapace.ActionExecute(cmd)
 		}),
 	)
-
 }

example/cmd/compat_test.go

@@ -19,7 +19,7 @@ func TestCompat(t *testing.T) {
 		)
 
 		s.Run("compat", "--error", "").
-			Expect(carapace.ActionMessage("an error occured").
+			Expect(carapace.ActionMessage("an error occurred").
 				Usage("ShellCompDirectiveError"))
 
 		s.Run("compat", "--nospace", "").

example/cmd/modifier_test.go

@@ -35,7 +35,6 @@ func TestCache(t *testing.T) {
 		s.Run("modifier", "--cache", "").
 			ExpectNot(cached.
 				Usage("Cache()"))
-
 	})
 }
 
@@ -239,7 +238,6 @@ func TestFilterParts(t *testing.T) {
 				NoSpace(',').
 				Prefix("one,three,").
 				Usage("FilterParts()"))
-
 	})
 }
 

example/cmd/multiparts_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/rsteube/carapace/pkg/style"
 )
 
-// TODO rename
+// TODO rename.
 func TestMultiparts(t *testing.T) {
 	sandbox.Package(t, "github.com/rsteube/carapace/example")(func(s *sandbox.Sandbox) {
 		s.Files(

example/cmd/special.go

@@ -32,5 +32,4 @@ func init() {
 	carapace.Gen(specialCmd).PositionalCompletion(
 		carapace.ActionValues(`p1 & < > ' " { } $ # | ? ( ) ;  [ ] * \ `+"`", "positional1"),
 	)
-
 }

internal/shell/library/action.go

@@ -0,0 +1,42 @@
+package library
+
+import (
+	"strings"
+
+	"github.com/rsteube/carapace/internal/common"
+	"github.com/rsteube/carapace/pkg/style"
+)
+
+var sanitizer = strings.NewReplacer(
+	"\n", ``,
+	"\r", ``,
+	"\t", ``,
+)
+
+var quoter = strings.NewReplacer(
+	// `\`, `\\`,
+	` `, `\ `,
+)
+
+// ActionRawValues formats values for carapace if used as library.
+func ActionRawValues(_ string, meta common.Meta, values common.RawValues) (common.RawValues, common.Meta) {
+	sorted := make(common.RawValues, 0)
+
+	values.EachTag(func(_ string, values common.RawValues) {
+		for index, val := range values {
+			val.Value = sanitizer.Replace(val.Value)
+			val.Value = quoter.Replace(val.Value)
+			if !meta.Nospace.Matches(val.Value) {
+				val.Value += " "
+			}
+			if val.Style != "" {
+				val.Style = style.SGR(val.Style)
+			}
+			values[index] = val
+		}
+
+		sorted = append(sorted, values...)
+	})
+
+	return sorted, meta
+}

internal/shell/nushell/patch.go

@@ -3,7 +3,7 @@ package nushell
 import (
 	"strings"
 
-	"github.com/rsteube/carapace-shlex"
+	shlex "github.com/rsteube/carapace-shlex"
 )
 
 // Patch uses the lexer to parse and patch given arguments which

storage_test.go

@@ -76,7 +76,7 @@ func TestCheck(t *testing.T) {
 	}
 }
 
-// BenchmarkStorage tests for concurrent map read/write
+// BenchmarkStorage tests for concurrent map read/write.
 func BenchmarkStorage(b *testing.B) {
 	cmd := &cobra.Command{}
 	cmd2 := &cobra.Command{}
@@ -98,5 +98,4 @@ func BenchmarkStorage(b *testing.B) {
 			storage.getPositional(cmd2, 0)
 		}
 	})
-
 }