support cmd-clink

Author: rsteube

README.md

@@ -14,6 +14,7 @@ Carapace-bin provides argument completion for multiple CLI commands ([full list]
 
 Supported shells:
 - [Bash](https://www.gnu.org/software/bash/)
+- [Cmd](https://en.wikipedia.org/wiki/Cmd.exe) ([experimental](https://github.com/carapace-sh/carapace/issues/1107))
 - [Elvish](https://elv.sh/)
 - [Fish](https://fishshell.com/)
 - [Ion](https://doc.redox-os.org/ion-manual/) ([experimental](https://github.com/carapace-sh/carapace/issues/88))

cmd/carapace/cmd/invoke.go

@@ -174,6 +174,7 @@ func init() {
 			switch c.Args[1] {
 			case "bash",
 				"bash-ble",
+				"cmd-clink",
 				"elvish",
 				"export",
 				"fish",
@@ -196,6 +197,7 @@ func init() {
 			switch c.Args[1] {
 			case "bash",
 				"bash-ble",
+				"cmd-clink",
 				"elvish",
 				"export",
 				"fish",

cmd/carapace/cmd/lazyinit/cmd.go

@@ -0,0 +1,44 @@
+package lazyinit
+
+import (
+	"fmt"
+	"strings"
+)
+
+func CmdClink(completers []string) string {
+	// TODO pathSnippet
+	snippet := `local function carapace_completion(command)
+  return function(word, word_index, line_state, match_builder)
+    local compline = string.sub(line_state:getline(), 1, line_state:getcursor())
+    local prog = "env CARAPACE_COMPLINE=" .. string.format("%%q", compline) .. " carapace " .. command .. " cmd-clink \"\""
+
+    local output = io.popen(prog):read("*a")
+    for line in string.gmatch(output, '[^\r\n]+') do
+      local matches = {}
+      for m in string.gmatch(line, '[^\t]+') do
+        table.insert(matches, m)
+      end
+      match_builder:addmatch({
+        match = matches[1],
+        display = matches[2],
+        description = matches[3],
+        type = "word",
+        appendchar = matches[4],
+        suppressappend = false
+      })
+    end
+    return true
+  end
+end
+
+%v
+`
+	argmatchers := make([]string, 0, len(completers))
+	for _, completer := range completers {
+		argmatchers = append(argmatchers,
+			fmt.Sprintf(`clink.argmatcher("%v"):addarg({nowordbreakchars="'‵+;,", carapace_completion("%v")}):loop(1)`, completer, completer),
+			fmt.Sprintf(`clink.argmatcher("%v.exe"):addarg({nowordbreakchars="'‵+;,", carapace_completion("%v")}):loop(1)`, completer, completer),
+		)
+	}
+	return fmt.Sprintf(snippet, strings.Join(argmatchers, "\n"))
+}

cmd/carapace/cmd/lazyinit/snippet.go

@@ -71,6 +71,8 @@ func Snippet(shell string) string {
 		return Bash(completerNames)
 	case "bash-ble":
 		return BashBle(completerNames)
+	case "cmd-clink":
+		return CmdClink(completerNames)
 	case "elvish":
 		return Elvish(completerNames)
 	case "fish":

cmd/carapace/cmd/root.go

@@ -161,6 +161,7 @@ func Execute(version string) error {
 			switch shell {
 			case "bash",
 				"bash-ble",
+				"cmd-clink",
 				"elvish",
 				"fish",
 				"nushell",

docs/src/setup-cmd.png

@@ -13,6 +13,17 @@ source <(carapace _carapace)
 
 ![](./setup-bash.png)
 
+## Cmd
+
+```lua
+# ~/AppData/Local/clink/carapace.lua
+load(io.popen('carapace _carapace cmd-clink'):read("*a"))()
+```
+
+![](./setup-cmd.png)
+
+> Needs [clink](https://chrisant996.github.io/clink/).
+
 ## Elvish
 
 ```sh

docs/src/setup.md

@@ -3,14 +3,14 @@ module github.com/carapace-sh/carapace-bin
 go 1.23.1
 
 require (
-	github.com/carapace-sh/carapace v1.6.1
+	github.com/carapace-sh/carapace v1.7.0
 	github.com/carapace-sh/carapace-bridge v1.2.3
 	github.com/carapace-sh/carapace-selfupdate v0.0.10
 	github.com/carapace-sh/carapace-shlex v1.0.1
 	github.com/carapace-sh/carapace-spec v1.1.1
 	github.com/pelletier/go-toml v1.9.5
 	github.com/spf13/cobra v1.8.1
-	github.com/spf13/pflag v1.0.5
+	github.com/spf13/pflag v1.0.6
 	golang.org/x/mod v0.23.0
 	gopkg.in/ini.v1 v1.67.0
 	gopkg.in/yaml.v3 v3.0.1

go.mod

@@ -1,5 +1,5 @@
-github.com/carapace-sh/carapace v1.6.1 h1:mh4byD5qEGzP1wv5JZ5JXdVOXrg4lIzDV0l6isl3xNE=
-github.com/carapace-sh/carapace v1.6.1/go.mod h1:djegtVDi/3duSAqZNU+/nCq7XtDRMRZUb5bW0O/HnEs=
+github.com/carapace-sh/carapace v1.7.0 h1:uJK6qvrXow6ZylbjGrU1pEyFCg0ZQ/L951GcIdl2C7U=
+github.com/carapace-sh/carapace v1.7.0/go.mod h1:fHdo3nEFe1QnIXxeA/Z1O9dCI83sfCsKfxrogpHfgtM=
 github.com/carapace-sh/carapace-bridge v1.2.3 h1:lalVNRCyUqdPAJbrqkmIDKNnZYsBlo83JBsdP9WFzKM=
 github.com/carapace-sh/carapace-bridge v1.2.3/go.mod h1:rEOS3MgzTQrCssS8WunHxPz31jZYNudcA7w1W5HrJs0=
 github.com/carapace-sh/carapace-pflag v1.0.0 h1:uJMhl+vwEM/Eb0UdxZUuv4jo4rUAyPijkRGP5gfCuCE=

go.sum

@@ -4,6 +4,7 @@ import (
 	"github.com/carapace-sh/carapace"
 	"github.com/carapace-sh/carapace-bin/cmd/carapace/cmd/action"
 	"github.com/carapace-sh/carapace-bin/pkg/env"
+	"github.com/carapace-sh/carapace-bridge/pkg/actions/bridge"
 	"github.com/carapace-sh/carapace/pkg/style"
 )
 
@@ -14,6 +15,7 @@ func init() {
 			Variables: map[string]string{
 				// carapace
 				"CARAPACE_COVERDIR":      "coverage directory for sandbox tests",
+				"CARAPACE_COMPLINE":      "TODO", // TODO
 				"CARAPACE_ENV":           "register get-env, set-env and unset-env",
 				"CARAPACE_HIDDEN":        "show hidden commands/flags",
 				"CARAPACE_LENIENT":       "allow unknown flags",
@@ -31,6 +33,7 @@ func init() {
 			VariableCompletion: map[string]carapace.Action{
 				// carapace
 				"CARAPACE_COVERDIR": carapace.ActionDirectories(),
+				"CARAPACE_COMPLINE": bridge.ActionCarapaceBin().Split(),
 				"CARAPACE_ENV":      _bool,
 				"CARAPACE_HIDDEN":   _bool,
 				"CARAPACE_LENIENT":  _bool,
@@ -45,7 +48,6 @@ func init() {
 				"CARAPACE_SANDBOX":    carapace.ActionValues(),
 				"CARAPACE_TOOLTIP":    _bool,
 				"CARAPACE_UNFILTERED": _bool,
-				// carapace-bin
 				"CARAPACE_EXCLUDES": carapace.Batch(
 					carapace.ActionCallback(func(c carapace.Context) carapace.Action {
 						c.Setenv(env.CARAPACE_EXCLUDES, "")