support modifying default keybindings prototype

config/parser.go

@@ -8,6 +8,7 @@ import (
 	"reflect"
 	"strings"
 
+	"github.com/charmbracelet/bubbles/key"
 	"github.com/charmbracelet/lipgloss"
 	"github.com/go-playground/validator/v10"
 	"gopkg.in/yaml.v2"
@@ -102,13 +103,35 @@ type Defaults struct {
 }
 
 type Keybinding struct {
-	Key     string `yaml:"key"`
-	Command string `yaml:"command"`
+	Key     string   `yaml:"key"`
+	Keys    []string `yaml:"keys"`
+	Command string   `yaml:"command"`
+	Builtin string   `yaml:"builtin"`
+}
+
+func (kb Keybinding) NewBinding(previous *key.Binding) key.Binding {
+	helpDesc := ""
+	if previous != nil {
+		helpDesc = previous.Help().Desc
+	}
+
+	if len(kb.Keys) > 0 {
+		return key.NewBinding(
+			key.WithKeys(kb.Keys...),
+			key.WithHelp(strings.Join(kb.Keys, "/"), helpDesc),
+		)
+	}
+
+	return key.NewBinding(
+		key.WithKeys(kb.Key),
+		key.WithHelp(kb.Key, helpDesc),
+	)
 }
 
 type Keybindings struct {
-	Issues []Keybinding `yaml:"issues"`
-	Prs    []Keybinding `yaml:"prs"`
+	Universal []Keybinding `yaml:"universal"`
+	Issues    []Keybinding `yaml:"issues"`
+	Prs       []Keybinding `yaml:"prs"`
 }
 
 type Pager struct {
@@ -257,8 +280,9 @@ func (parser ConfigParser) getDefaultConfig() Config {
 			},
 		},
 		Keybindings: Keybindings{
-			Issues: []Keybinding{},
-			Prs:    []Keybinding{},
+			Universal: []Keybinding{},
+			Issues:    []Keybinding{},
+			Prs:       []Keybinding{},
 		},
 		RepoPaths: map[string]string{},
 		Theme: &ThemeConfig{

ui/keys/keys.go

@@ -3,6 +3,7 @@ package keys
 import (
 	"github.com/charmbracelet/bubbles/help"
 	"github.com/charmbracelet/bubbles/key"
+	log "github.com/charmbracelet/log"
 
 	"github.com/dlvhdr/gh-dash/config"
 )
@@ -84,7 +85,7 @@ func (k KeyMap) QuitAndHelpKeys() []key.Binding {
 	return []key.Binding{k.Help, k.Quit}
 }
 
-var Keys = KeyMap{
+var Keys = &KeyMap{
 	Up: key.NewBinding(
 		key.WithKeys("up", "k"),
 		key.WithHelp("↑/k", "move up"),
@@ -158,3 +159,52 @@ var Keys = KeyMap{
 		key.WithHelp("q", "quit"),
 	),
 }
+
+// Rebind will update our saved keybindings from configuration values.
+func Rebind(universal, issueKeys, prKeys []config.Keybinding) error {
+	err := rebindUniversal(universal)
+	if err != nil {
+		return err
+	}
+
+	err = rebindPRKeys(prKeys)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func rebindUniversal(universal []config.Keybinding) error {
+	for _, kb := range universal {
+		log.Debug("Rebinding key", "builtin", kb.Builtin, "key", kb.Key)
+		switch kb.Builtin {
+		case "up":
+			Keys.Up = kb.NewBinding(&Keys.Up)
+		case "down":
+			Keys.Down = kb.NewBinding(&Keys.Down)
+		case "firstline": // should this be first-line or firstLine?
+		case "lastline":
+		case "togglepreview":
+		case "opengithub":
+		case "refresh":
+		case "refreshall":
+		case "pagedown":
+		case "pageup":
+		case "nextsection":
+		case "prevsection":
+		case "switchview":
+			Keys.SwitchView = kb.NewBinding(&Keys.SwitchView)
+		case "search":
+		case "copyurl":
+		case "copynumber":
+		case "help":
+		case "quit":
+		default:
+			// TODO: return an error here
+			return nil
+		}
+	}
+
+	return nil
+}

ui/keys/prKeys.go

@@ -2,6 +2,7 @@ package keys
 
 import (
 	"github.com/charmbracelet/bubbles/key"
+	"github.com/dlvhdr/gh-dash/config"
 )
 
 type PRKeyMap struct {
@@ -74,3 +75,45 @@ func PRFullHelp() []key.Binding {
 		PRKeys.WatchChecks,
 	}
 }
+
+func rebindPRKeys(keys []config.Keybinding) error {
+	for _, prKey := range keys {
+		var k key.Binding
+
+		switch prKey.Builtin {
+		case "assign":
+			k = PRKeys.Assign
+		case "unassign":
+			k = PRKeys.Unassign
+		case "comment":
+			k = PRKeys.Comment
+		case "diff":
+			k = PRKeys.Diff
+		case "checkout":
+			k = PRKeys.Checkout
+		case "close":
+			k = PRKeys.Close
+		case "ready":
+			k = PRKeys.Ready
+		case "reopen":
+			k = PRKeys.Reopen
+		case "merge":
+			k = PRKeys.Merge
+		case "watchchecks":
+			k = PRKeys.WatchChecks
+		default:
+			// TODO: return an error here
+			return nil
+		}
+
+		// Not really sure if this is the best idea but I am not
+		// sure how else we are meant to define alt keys.
+		if len(prKey.Keys) > 0 {
+			k.SetKeys(prKey.Keys...)
+		} else {
+			k.SetKeys(prKey.Key)
+		}
+	}
+
+	return nil
+}

ui/ui.go

@@ -33,7 +33,7 @@ import (
 )
 
 type Model struct {
-	keys          keys.KeyMap
+	keys          *keys.KeyMap
 	sidebar       sidebar.Model
 	prSidebar     prsidebar.Model
 	issueSidebar  issuesidebar.Model
@@ -82,10 +82,7 @@ func NewModel(configPath string) Model {
 }
 
 func (m *Model) initScreen() tea.Msg {
-	var err error
-
-	config, err := config.ParseConfig(m.ctx.ConfigPath)
-	if err != nil {
+	showError := func(err error) {
 		styles := log.DefaultStyles()
 		styles.Key = lipgloss.NewStyle().
 			Foreground(lipgloss.Color("1")).
@@ -107,10 +104,24 @@ func (m *Model) initScreen() tea.Msg {
 				"err",
 				err,
 			)
+	}
+
+	cfg, err := config.ParseConfig(m.ctx.ConfigPath)
+	if err != nil {
+		showError(err)
+		return initMsg{Config: cfg}
+	}
 
+	err = keys.Rebind(
+		cfg.Keybindings.Universal,
+		cfg.Keybindings.Issues,
+		cfg.Keybindings.Prs,
+	)
+	if err != nil {
+		showError(err)
 	}
 
-	return initMsg{Config: config}
+	return initMsg{Config: cfg}
 }
 
 func (m Model) Init() tea.Cmd {