shell: cmd-clink

experimental initial version

Author: rsteube

command.go

@@ -57,6 +57,7 @@ func addCompletionCommand(targetCmd *cobra.Command) {
 		ActionStyledValues(
 			"bash", "#d35673",
 			"bash-ble", "#c2039a",
+			"cmd-clink", "#2B3436",
 			"elvish", "#ffd6c9",
 			"export", style.Default,
 			"fish", "#7ea8fc",

complete.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/carapace-sh/carapace/internal/config"
 	"github.com/carapace-sh/carapace/internal/shell/bash"
+	"github.com/carapace-sh/carapace/internal/shell/cmd_clink"
 	"github.com/carapace-sh/carapace/internal/shell/nushell"
 	"github.com/carapace-sh/carapace/pkg/ps"
 	"github.com/spf13/cobra"
@@ -37,6 +38,14 @@ func complete(cmd *cobra.Command, args []string) (string, error) {
 				}
 				return ActionMessage(err.Error()).Invoke(context).value(args[0], args[len(args)-1]), nil
 			}
+		case "cmd-clink":
+			var err error
+			args, err = cmd_clink.Patch(args)
+			LOG.Printf("patching args to %#v", args)
+			if err != nil {
+				context := NewContext(args...)
+				return ActionMessage(err.Error()).Invoke(context).value(args[0], args[len(args)-1]), nil
+			}
 		}
 
 		action, context := traverse(cmd, args[2:])

example/cmd/_test/cmd-clink.lua

@@ -0,0 +1,23 @@
+local function example_completion(word, word_index, line_state, match_builder)
+  local compline = string.sub(line_state:getline(), 1, line_state:getcursor())
+
+  local output = io.popen("env CARAPACE_COMPLINE=" .. string.format("%q", compline) .. " example _carapace cmd-clink \"\""):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
+
+clink.argmatcher("example"):addarg({nowordbreakchars="'‵+;,", example_completion}):loop(1)
+

example/cmd/root_test.go

@@ -28,6 +28,10 @@ func TestBashBle(t *testing.T) {
 	testScript(t, "bash-ble", "./_test/bash-ble.sh")
 }
 
+func TestCmdClink(t *testing.T) {
+	testScript(t, "cmd-clink", "./_test/cmd-clink.lua")
+}
+
 func TestElvish(t *testing.T) {
 	testScript(t, "elvish", "./_test/elvish.elv")
 }

go.mod

@@ -1,6 +1,6 @@
 module github.com/carapace-sh/carapace
 
-go 1.15
+go 1.16
 
 require (
 	github.com/carapace-sh/carapace-shlex v1.0.1

internal/shell/cmd_clink/action.go

@@ -0,0 +1,30 @@
+package cmd_clink
+
+import (
+	"strings"
+
+	"github.com/carapace-sh/carapace/internal/common"
+)
+
+var sanitizer = strings.NewReplacer(
+	"\n", ``,
+	"\r", ``,
+	"\t", ``,
+)
+
+func ActionRawValues(currentWord string, meta common.Meta, values common.RawValues) string {
+	vals := make([]string, len(values))
+	for index, val := range values {
+		appendChar := " "
+		if meta.Nospace.Matches(val.Value) {
+			appendChar = ""
+		}
+		vals[index] = strings.Join([]string{
+			sanitizer.Replace(val.Value),
+			sanitizer.Replace(val.Display),
+			sanitizer.Replace(val.TrimmedDescription()),
+			appendChar,
+		}, "\t")
+	}
+	return strings.Join(vals, "\n")
+}

internal/shell/cmd_clink/patch.go

@@ -0,0 +1,26 @@
+package cmd_clink
+
+import (
+	"os"
+
+	shlex "github.com/carapace-sh/carapace-shlex"
+)
+
+func Patch(args []string) ([]string, error) {
+	compline, ok := os.LookupEnv("CARAPACE_COMPLINE")
+	if !ok {
+		return args, nil
+	}
+	os.Unsetenv("CARAPACE_COMPLINE")
+
+	if compline == "" {
+		return args, nil
+	}
+
+	tokens, err := shlex.Split(compline)
+	if err != nil {
+		return nil, err
+	}
+	args = append(args[:1], tokens.CurrentPipeline().FilterRedirects().Words().Strings()...)
+	return args, nil
+}

internal/shell/cmd_clink/snippet.go

@@ -0,0 +1,35 @@
+package cmd_clink
+
+import (
+	"fmt"
+
+	"github.com/carapace-sh/carapace/pkg/uid"
+	"github.com/spf13/cobra"
+)
+
+func Snippet(cmd *cobra.Command) string {
+	result := fmt.Sprintf(`local function %v_completion(word, word_index, line_state, match_builder)
+  local compline = string.sub(line_state:getline(), 1, line_state:getcursor())
+
+  local output = io.popen("env CARAPACE_COMPLINE=" .. string.format("%%q", compline) .. " %v _carapace cmd-clink \"\""):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
+
+clink.argmatcher("%v"):addarg({nowordbreakchars="'‵+;,", %v_completion}):loop(1)
+`, cmd.Name(), uid.Executable(), cmd.Name(), cmd.Name())
+	return result
+}

internal/shell/shell.go

@@ -10,6 +10,7 @@ import (
 	"github.com/carapace-sh/carapace/internal/env"
 	"github.com/carapace-sh/carapace/internal/shell/bash"
 	"github.com/carapace-sh/carapace/internal/shell/bash_ble"
+	"github.com/carapace-sh/carapace/internal/shell/cmd_clink"
 	"github.com/carapace-sh/carapace/internal/shell/elvish"
 	"github.com/carapace-sh/carapace/internal/shell/export"
 	"github.com/carapace-sh/carapace/internal/shell/fish"
@@ -33,6 +34,7 @@ func Snippet(cmd *cobra.Command, shell string) (string, error) {
 	shellSnippets := map[string]func(cmd *cobra.Command) string{
 		"bash":       bash.Snippet,
 		"bash-ble":   bash_ble.Snippet,
+		"cmd-clink":  cmd_clink.Snippet,
 		"export":     export.Snippet,
 		"fish":       fish.Snippet,
 		"elvish":     elvish.Snippet,
@@ -60,6 +62,7 @@ func Value(shell string, value string, meta common.Meta, values common.RawValues
 	shellFuncs := map[string]func(currentWord string, meta common.Meta, values common.RawValues) string{
 		"bash":       bash.ActionRawValues,
 		"bash-ble":   bash_ble.ActionRawValues,
+		"cmd-clink":  cmd_clink.ActionRawValues,
 		"fish":       fish.ActionRawValues,
 		"elvish":     elvish.ActionRawValues,
 		"export":     export.ActionRawValues,

pkg/ps/ps.go

@@ -26,6 +26,8 @@ func DetermineShell() string {
 				return "bash-ble"
 			}
 			return "bash"
+		case "cmd":
+			return "cmd-clink"
 		case "elvish":
 			return "elvish"
 		case "fish":