Skip to content

Commit 3394631

Browse files
committed
Add Keymap Descriptions
1 parent e4be84b commit 3394631

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed

Diff for: app/Keymap.go

+33-32
Original file line numberDiff line numberDiff line change
@@ -46,47 +46,48 @@ func (c KeymapSystem) Resolve(event *tcell.EventKey) cmd.Command {
4646
// Define a global KeymapSystem object with default keybinds
4747
var Keymaps = KeymapSystem{
4848
Global: Map{
49-
Bind{Key: Key{Char: 'L'}, Cmd: cmd.MoveRight},
50-
Bind{Key: Key{Char: 'H'}, Cmd: cmd.MoveLeft},
51-
Bind{Key: Key{Code: tcell.KeyCtrlE}, Cmd: cmd.SwitchToEditorView},
52-
Bind{Key: Key{Code: tcell.KeyCtrlS}, Cmd: cmd.Save},
53-
Bind{Key: Key{Char: 'q'}, Cmd: cmd.Quit},
54-
Bind{Key: Key{Code: tcell.KeyBackspace2}, Cmd: cmd.SwitchToConnectionsView},
49+
Bind{Key: Key{Char: 'L'}, Cmd: cmd.MoveRight, Description: "Right"},
50+
Bind{Key: Key{Char: 'H'}, Cmd: cmd.MoveLeft, Description: "Left"},
51+
Bind{Key: Key{Code: tcell.KeyCtrlE}, Cmd: cmd.SwitchToEditorView, Description: "EditorView"},
52+
Bind{Key: Key{Code: tcell.KeyCtrlS}, Cmd: cmd.Save, Description: "Save"},
53+
Bind{Key: Key{Char: 'q'}, Cmd: cmd.Quit, Description: "Quit"},
54+
Bind{Key: Key{Code: tcell.KeyBackspace2}, Cmd: cmd.SwitchToConnectionsView, Description: "ConnectionsView"},
55+
Bind{Key: Key{Char: '?'}, Cmd: cmd.HelpPopup, Description: "Help"},
5556
},
5657
Groups: map[string]Map{
5758
"tree": {
58-
Bind{Key: Key{Char: 'g'}, Cmd: cmd.GotoTop},
59-
Bind{Key: Key{Char: 'G'}, Cmd: cmd.GotoBottom},
60-
Bind{Key: Key{Code: tcell.KeyEnter}, Cmd: cmd.Execute},
61-
Bind{Key: Key{Char: 'j'}, Cmd: cmd.MoveDown},
62-
Bind{Key: Key{Code: tcell.KeyDown}, Cmd: cmd.MoveDown},
63-
Bind{Key: Key{Char: 'k'}, Cmd: cmd.MoveUp},
64-
Bind{Key: Key{Code: tcell.KeyUp}, Cmd: cmd.MoveUp},
59+
Bind{Key: Key{Char: 'g'}, Cmd: cmd.GotoTop, Description: "Goto Top"},
60+
Bind{Key: Key{Char: 'G'}, Cmd: cmd.GotoBottom, Description: "Goto Bottom"},
61+
Bind{Key: Key{Code: tcell.KeyEnter}, Cmd: cmd.Execute, Description: "Execute"},
62+
Bind{Key: Key{Char: 'j'}, Cmd: cmd.MoveDown, Description: "Down"},
63+
Bind{Key: Key{Code: tcell.KeyDown}, Cmd: cmd.MoveDown, Description: "Down"},
64+
Bind{Key: Key{Char: 'k'}, Cmd: cmd.MoveUp, Description: "Up"},
65+
Bind{Key: Key{Code: tcell.KeyUp}, Cmd: cmd.MoveUp, Description: "Up"},
6566
},
6667
"table": {
67-
Bind{Key: Key{Char: '/'}, Cmd: cmd.Search},
68-
Bind{Key: Key{Char: 'c'}, Cmd: cmd.Edit},
69-
Bind{Key: Key{Char: 'd'}, Cmd: cmd.Delete},
70-
Bind{Key: Key{Char: 'w'}, Cmd: cmd.GotoNext},
71-
Bind{Key: Key{Char: 'b'}, Cmd: cmd.GotoPrev},
72-
Bind{Key: Key{Char: '$'}, Cmd: cmd.GotoEnd},
73-
Bind{Key: Key{Char: '0'}, Cmd: cmd.GotoStart},
74-
Bind{Key: Key{Char: 'y'}, Cmd: cmd.Copy},
75-
Bind{Key: Key{Char: 'o'}, Cmd: cmd.AppendNewRow},
68+
Bind{Key: Key{Char: '/'}, Cmd: cmd.Search, Description: "Search"},
69+
Bind{Key: Key{Char: 'c'}, Cmd: cmd.Edit, Description: "Goto Edit"},
70+
Bind{Key: Key{Char: 'd'}, Cmd: cmd.Delete, Description: "Goto Delete"},
71+
Bind{Key: Key{Char: 'w'}, Cmd: cmd.GotoNext, Description: "Goto Next"},
72+
Bind{Key: Key{Char: 'b'}, Cmd: cmd.GotoPrev, Description: "Goto Prev"},
73+
Bind{Key: Key{Char: '$'}, Cmd: cmd.GotoEnd, Description: "Goto End"},
74+
Bind{Key: Key{Char: '0'}, Cmd: cmd.GotoStart, Description: "Goto Start"},
75+
Bind{Key: Key{Char: 'y'}, Cmd: cmd.Copy, Description: "Copy"},
76+
Bind{Key: Key{Char: 'o'}, Cmd: cmd.AppendNewRow, Description: "New Row"},
7677
// Tabs
77-
Bind{Key: Key{Char: '['}, Cmd: cmd.TabPrev},
78-
Bind{Key: Key{Char: ']'}, Cmd: cmd.TabNext},
79-
Bind{Key: Key{Char: '{'}, Cmd: cmd.TabFirst},
80-
Bind{Key: Key{Char: '}'}, Cmd: cmd.TabLast},
81-
Bind{Key: Key{Char: 'X'}, Cmd: cmd.TabClose},
78+
Bind{Key: Key{Char: '['}, Cmd: cmd.TabPrev, Description: "Tab Prev"},
79+
Bind{Key: Key{Char: ']'}, Cmd: cmd.TabNext, Description: "Tab Next"},
80+
Bind{Key: Key{Char: '{'}, Cmd: cmd.TabFirst, Description: "Tab First"},
81+
Bind{Key: Key{Char: '}'}, Cmd: cmd.TabLast, Description: "Tab Last"},
82+
Bind{Key: Key{Char: 'X'}, Cmd: cmd.TabClose, Description: "Close"},
8283
// Pages
83-
Bind{Key: Key{Char: '>'}, Cmd: cmd.PageNext},
84-
Bind{Key: Key{Char: '<'}, Cmd: cmd.PagePrev},
84+
Bind{Key: Key{Char: '>'}, Cmd: cmd.PageNext, Description: "Page Next"},
85+
Bind{Key: Key{Char: '<'}, Cmd: cmd.PagePrev, Description: "Page Prev"},
8586
},
8687
"editor": {
87-
Bind{Key: Key{Code: tcell.KeyCtrlR}, Cmd: cmd.Execute},
88-
Bind{Key: Key{Code: tcell.KeyEscape}, Cmd: cmd.Quit},
89-
Bind{Key: Key{Code: tcell.KeyCtrlSpace}, Cmd: cmd.OpenInExternalEditor},
88+
Bind{Key: Key{Code: tcell.KeyCtrlR}, Cmd: cmd.Execute, Description: "Execute"},
89+
Bind{Key: Key{Code: tcell.KeyEscape}, Cmd: cmd.Quit, Description: "Quit"},
90+
Bind{Key: Key{Code: tcell.KeyCtrlSpace}, Cmd: cmd.OpenInExternalEditor, Description: "ExternalEditor"},
9091
},
9192
},
9293
}

Diff for: commands/commands.go

+3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ const (
88
// Views
99
SwitchToEditorView
1010
SwitchToConnectionsView
11+
HelpPopup
1112

1213
// Movement: Basic
1314
MoveUp
@@ -54,6 +55,8 @@ func (c Command) String() string {
5455
return "SwitchToEditorView"
5556
case SwitchToConnectionsView:
5657
return "SwitchToConnectionsView"
58+
case HelpPopup:
59+
return "HelpPopup"
5760

5861
// Movement: Basic
5962
case MoveUp:

0 commit comments

Comments
 (0)