Transitioned codebase to bubbles/key keybinds (guyfedwards#68)

* Transitioned codebase to bubbles/key keybinds

- Added `key.go` to handle keybindings.
- Transitioned `tui.go` to use keybindings defined in `key.go`.
- Added `model.help` to handle help messages.
- Overrode the `list.KeyMap.CancelWhileFiltering` to `q`.
- Added `viewport` full help menu, extracted help keys to `key.go.
- Changed `g` viewport keybinding to be consistent with `list`.
- Extracted `list` overrides into `key.go#SetOverrides`.

* Fixed state issues with filtering in list

Changes made:
- Moved away from assigning KeyMap properties, as it's inconsistent with
  `bubbles/list`'s internal state. Now using `SetKeys` and `SetHelp`.
- Re-added the `q/esc` for quitting application
- Changed viewport "close help" message to be consistent with
  `bubbles/list`.

internal/commands/key.go

@@ -0,0 +1,183 @@
+package commands
+
+import (
+	"github.com/charmbracelet/bubbles/key"
+	"github.com/charmbracelet/bubbles/list"
+	"github.com/charmbracelet/bubbles/viewport"
+)
+
+// ListKeyMapT shows either (o)verrides or new keybinds
+type ListKeyMapT struct {
+	Open                  key.Binding
+	Read                  key.Binding
+	Favourite             key.Binding
+	ToggleReads           key.Binding
+	ToggleFavourites      key.Binding
+	Refresh               key.Binding
+	OpenInBrowser         key.Binding
+	oQuit                 key.Binding
+	oForceQuit            key.Binding
+	oClearFilter          key.Binding
+	oCancelWhileFiltering key.Binding
+	oNextPage             key.Binding
+	oPrevPage             key.Binding
+}
+
+// ViewportKeyMapT shows *all* keybinds, pulling from viewport.DefaultKeyMap()
+type ViewportKeyMapT struct {
+	Quit          key.Binding
+	Escape        key.Binding
+	OpenInBrowser key.Binding
+	GotoStart     key.Binding
+	GotoEnd       key.Binding
+	Next          key.Binding
+	Prev          key.Binding
+	ShowFullHelp  key.Binding
+	CloseFullHelp key.Binding
+}
+
+// ListKeyMap shows either (o)verrides or new keybinds
+var ListKeyMap = ListKeyMapT{
+	Open: key.NewBinding(
+		key.WithKeys("enter"),
+		key.WithHelp("enter", "open"),
+	),
+	Favourite: key.NewBinding(
+		key.WithKeys("f"),
+		key.WithHelp("f", "favourite"),
+	),
+	ToggleFavourites: key.NewBinding(
+		key.WithKeys("F"),
+		key.WithHelp("F", "toggle show favourite"),
+	),
+	Read: key.NewBinding(
+		key.WithKeys("m"),
+		key.WithHelp("m", "mark read"),
+	),
+	ToggleReads: key.NewBinding(
+		key.WithKeys("M"),
+		key.WithHelp("M", "toggle show read"),
+	),
+	Refresh: key.NewBinding(
+		key.WithKeys("r"),
+		key.WithHelp("r", "refresh"),
+	),
+	OpenInBrowser: key.NewBinding(
+		key.WithKeys("o"),
+		key.WithHelp("o", "open in browser"),
+	),
+	// o for override
+	oQuit: key.NewBinding(
+		key.WithKeys("q", "esc"),
+		key.WithHelp("q/esc", "quit"),
+	),
+	oForceQuit: key.NewBinding(
+		key.WithKeys("ctrl+c"),
+		key.WithHelp("ctrl+c", "quit"),
+	),
+	oClearFilter: key.NewBinding(
+		key.WithKeys("esc", "q"),
+		key.WithHelp("esc/q", "clear filter"),
+	),
+	oCancelWhileFiltering: key.NewBinding(
+		key.WithKeys("esc"),
+		key.WithHelp("esc", "cancel"),
+	),
+	oPrevPage: key.NewBinding(
+		key.WithKeys("left", "h", "pgup"),
+		key.WithHelp("←/h/pgup", "prev page"),
+	),
+	oNextPage: key.NewBinding(
+		key.WithKeys("right", "l", "pgdown"),
+		key.WithHelp("→/l/pgdn", "next page"),
+	),
+}
+
+// ViewportKeyMapT shows *all* keybinds, pulling from viewport.DefaultKeyMap()
+var ViewportKeyMap = ViewportKeyMapT{
+	Next: key.NewBinding(
+		key.WithKeys("l", "right"),
+		key.WithHelp("l/→", "next"),
+	),
+	Prev: key.NewBinding(
+		key.WithKeys("h", "left"),
+		key.WithHelp("h/←", "prev"),
+	),
+	Quit: key.NewBinding(
+		key.WithKeys("ctrl+c"),
+		key.WithHelp("ctrl+c", "quit"),
+	),
+	Escape: key.NewBinding(
+		key.WithKeys("esc", "q"),
+		key.WithHelp("q/esc", "escape"),
+	),
+	OpenInBrowser: key.NewBinding(
+		key.WithKeys("o"),
+		key.WithHelp("o", "open in browser"),
+	),
+	GotoStart: key.NewBinding(
+		key.WithKeys("g", "home"),
+		key.WithHelp("g", "top"),
+	),
+	GotoEnd: key.NewBinding(
+		key.WithKeys("G", "end"),
+		key.WithHelp("G", "bottom"),
+	),
+	ShowFullHelp: key.NewBinding(
+		key.WithKeys("?"),
+		key.WithHelp("?", "more"),
+	),
+	CloseFullHelp: key.NewBinding(
+		key.WithKeys("?"),
+		key.WithHelp("?", "close help"),
+	),
+}
+
+// This show *all* keybinds, as bubbles/viewport doesn't provide a help function
+func (k ViewportKeyMapT) FullHelp() [][]key.Binding {
+	v := viewport.DefaultKeyMap()
+	return [][]key.Binding{
+		{v.Up, v.Down, v.HalfPageUp, v.HalfPageDown},
+		{k.GotoStart, k.GotoEnd, v.PageUp, v.PageDown},
+		{k.Next, k.Prev, k.OpenInBrowser},
+		{k.Escape, k.Quit, k.CloseFullHelp},
+	}
+}
+
+// This show *all* keybinds, as bubbles/viewport doesn't provide a help function
+func (k ViewportKeyMapT) ShortHelp() []key.Binding {
+	v := viewport.DefaultKeyMap()
+	return []key.Binding{
+		k.Next, k.Prev, v.Down, v.Up, k.Escape, k.ShowFullHelp,
+	}
+}
+
+// This shows *additional* (or overridden) keybinds alongside built-ins, which *must* take []key.Binding unfortunately.
+func (k ListKeyMapT) FullHelp() []key.Binding {
+	return []key.Binding{
+		k.Open, k.Read, k.Favourite, k.Refresh,
+		k.OpenInBrowser, k.ToggleFavourites, k.ToggleReads,
+	}
+}
+
+// This shows *additional* (or overridden) keybinds alongside built-ins
+func (k ListKeyMapT) ShortHelp() []key.Binding {
+	return []key.Binding{k.Open}
+}
+
+func (k ListKeyMapT) SetOverrides(l *list.Model) {
+	l.AdditionalFullHelpKeys = ListKeyMap.FullHelp
+	l.AdditionalShortHelpKeys = ListKeyMap.ShortHelp
+	l.KeyMap.Quit.SetKeys(k.oQuit.Keys()...)
+	l.KeyMap.Quit.SetHelp(k.oQuit.Help().Key, k.oQuit.Help().Desc)
+	l.KeyMap.ForceQuit.SetKeys(k.oForceQuit.Keys()...)
+	l.KeyMap.ForceQuit.SetHelp(k.oForceQuit.Help().Key, k.oForceQuit.Help().Desc)
+	l.KeyMap.ClearFilter.SetKeys(k.oClearFilter.Keys()...)
+	l.KeyMap.ClearFilter.SetHelp(k.oClearFilter.Help().Key, k.oClearFilter.Help().Desc)
+	l.KeyMap.CancelWhileFiltering.SetKeys(k.oCancelWhileFiltering.Keys()...)
+    l.KeyMap.CancelWhileFiltering.SetHelp(k.oCancelWhileFiltering.Help().Key, k.oCancelWhileFiltering.Help().Desc)
+	l.KeyMap.NextPage.SetKeys(k.oNextPage.Keys()...)
+	l.KeyMap.NextPage.SetHelp(k.oNextPage.Help().Key, k.oNextPage.Help().Desc)
+	l.KeyMap.PrevPage.SetKeys(k.oPrevPage.Keys()...)
+	l.KeyMap.PrevPage.SetHelp(k.oPrevPage.Help().Key, k.oPrevPage.Help().Desc)
+}