Merge pull request docker#1313 from jeanlaurent/editor-name

Expand $EDITOR in the TUI

Author: dgageot

pkg/tui/page/chat/chat.go

@@ -1,10 +1,13 @@
 package chat
 
 import (
+	"cmp"
 	"context"
 	"fmt"
 	"log/slog"
 	"os"
+	"path/filepath"
+	"runtime"
 	"strings"
 
 	"charm.land/bubbles/v2/help"
@@ -108,8 +111,78 @@ type KeyMap struct {
 	ToggleSplitDiff key.Binding
 }
 
+// getEditorDisplayNameFromEnv returns a friendly display name for the configured editor.
+// It takes visual and editorEnv values as parameters and maps common editors to display names.
+// If neither is set, it returns the platform-specific fallback that will actually be used.
+func getEditorDisplayNameFromEnv(visual, editorEnv string) string {
+	editorCmd := cmp.Or(visual, editorEnv)
+	if editorCmd == "" {
+		// Return the actual fallback editor that will be used
+		if runtime.GOOS == "windows" {
+			return "Notepad"
+		}
+		return "Vi"
+	}
+
+	// Parse the command (may include arguments like "code --wait")
+	parts := strings.Fields(editorCmd)
+	if len(parts) == 0 {
+		return "$EDITOR"
+	}
+
+	// Get the base command name (e.g., "/usr/local/bin/code" → "code")
+	baseName := filepath.Base(parts[0])
+
+	// Map common editor command prefixes to friendly display names
+	// Using prefix matching to handle variants like "code-insiders", "nvim-qt", etc.
+	editorPrefixes := []struct {
+		prefix string
+		name   string
+	}{
+		{"code", "VSCode"},
+		{"cursor", "Cursor"},
+		{"nvim", "Neovim"},
+		{"vim", "Vim"},
+		{"vi", "Vi"},
+		{"nano", "Nano"},
+		{"emacs", "Emacs"},
+		{"subl", "Sublime Text"},
+		{"sublime", "Sublime Text"},
+		{"atom", "Atom"},
+		{"gedit", "gedit"},
+		{"kate", "Kate"},
+		{"notepad++", "Notepad++"},
+		{"notepad", "Notepad"},
+		{"textmate", "TextMate"},
+		{"mate", "TextMate"},
+		{"zed", "Zed"},
+	}
+
+	for _, editor := range editorPrefixes {
+		if strings.HasPrefix(baseName, editor.prefix) {
+			return editor.name
+		}
+	}
+
+	// Return the base name with first letter capitalized
+	if baseName != "" {
+		return strings.ToUpper(baseName[:1]) + baseName[1:]
+	}
+
+	return "$EDITOR"
+}
+
+// getEditorDisplayName returns a friendly display name for the configured editor.
+// It reads the VISUAL or EDITOR environment variables and maps common editors to display names.
+// If neither is set, it returns the platform-specific fallback that will actually be used.
+func getEditorDisplayName() string {
+	return getEditorDisplayNameFromEnv(os.Getenv("VISUAL"), os.Getenv("EDITOR"))
+}
+
 // defaultKeyMap returns the default key bindings
 func defaultKeyMap() KeyMap {
+	editorName := getEditorDisplayName()
+
 	return KeyMap{
 		Tab: key.NewBinding(
 			key.WithKeys("tab"),
@@ -126,7 +199,7 @@ func defaultKeyMap() KeyMap {
 		),
 		ExternalEditor: key.NewBinding(
 			key.WithKeys("ctrl+g"),
-			key.WithHelp("Ctrl+g", "edit in $EDITOR"),
+			key.WithHelp("Ctrl+g", fmt.Sprintf("edit in %s", editorName)),
 		),
 		ToggleSplitDiff: key.NewBinding(
 			key.WithKeys("ctrl+t"),

pkg/tui/page/chat/chat_test.go

@@ -0,0 +1,112 @@
+package chat
+
+import (
+	"testing"
+)
+
+func TestGetEditorDisplayNameFromEnv(t *testing.T) {
+	t.Parallel()
+
+	tests := []struct {
+		name      string
+		visual    string
+		editorEnv string
+		want      string
+	}{
+		{
+			name:      "VSCode",
+			visual:    "",
+			editorEnv: "code",
+			want:      "VSCode",
+		},
+		{
+			name:      "VSCode with args",
+			visual:    "",
+			editorEnv: "code --wait",
+			want:      "VSCode",
+		},
+		{
+			name:      "VSCode with full path",
+			visual:    "",
+			editorEnv: "/usr/local/bin/code --wait",
+			want:      "VSCode",
+		},
+		{
+			name:      "Vim",
+			visual:    "",
+			editorEnv: "vim",
+			want:      "Vim",
+		},
+		{
+			name:      "Neovim",
+			visual:    "",
+			editorEnv: "nvim",
+			want:      "Neovim",
+		},
+		{
+			name:      "Cursor",
+			visual:    "",
+			editorEnv: "cursor",
+			want:      "Cursor",
+		},
+		{
+			name:      "Unknown editor",
+			visual:    "",
+			editorEnv: "myeditor",
+			want:      "Myeditor",
+		},
+		{
+			name:      "Unknown editor with full path",
+			visual:    "",
+			editorEnv: "/opt/bin/myeditor",
+			want:      "Myeditor",
+		},
+		{
+			name:      "Empty (uses platform default)",
+			visual:    "",
+			editorEnv: "",
+			want:      "Vi", // On non-Windows platforms, falls back to vi
+		},
+		{
+			name:      "VSCode Insiders",
+			visual:    "",
+			editorEnv: "code-insiders",
+			want:      "VSCode",
+		},
+		{
+			name:      "Neovim Qt",
+			visual:    "",
+			editorEnv: "nvim-qt",
+			want:      "Neovim",
+		},
+		{
+			name:      "Vim GTK",
+			visual:    "",
+			editorEnv: "vim-gtk3",
+			want:      "Vim",
+		},
+		{
+			name:      "VISUAL takes precedence over EDITOR",
+			visual:    "code",
+			editorEnv: "vim",
+			want:      "VSCode",
+		},
+		{
+			name:      "VISUAL with args takes precedence",
+			visual:    "code --wait",
+			editorEnv: "vim",
+			want:      "VSCode",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			got := getEditorDisplayNameFromEnv(tt.visual, tt.editorEnv)
+			if got != tt.want {
+				t.Errorf("getEditorDisplayNameFromEnv(%q, %q) = %v, want %v", tt.visual, tt.editorEnv, got, tt.want)
+			}
+		})
+	}
+}

pkg/tui/page/chat/editor.go

@@ -41,7 +41,7 @@ func (p *chatPage) openExternalEditor() tea.Cmd {
 		if runtime.GOOS == "windows" {
 			editorCmd = "notepad"
 		} else {
-			editorCmd = "vim"
+			editorCmd = "vi"
 		}
 	}