Keymap presentation refinements and underlying restructuring

book/src/configuration.md

@@ -53,6 +53,7 @@ on unix operating systems.
 | `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |
 | `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
 | `auto-info` | Whether to display infoboxes | `true` |
+| `sorted-infobox` | Sort infoboxes by key event category rather than by predefined command categories | `false` |
 | `true-color` | Set to `true` to override automatic detection of terminal truecolor support in the event of a false negative. | `false` |
 | `rulers` | List of column positions at which to display the rulers. Can be overridden by language specific `rulers` in `languages.toml` file. | `[]` |
 | `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `never` |

book/src/remapping.md

@@ -49,6 +49,31 @@ c = ":run-shell-command cargo build"
 t = ":run-shell-command cargo test"
 ```
 
+## Custom descriptions
+
+Remapping of singular typable commands or seqences of any commands, can be given a custom description for the keymap menus (infoboxes).
+This is the text on each row that's paired together with each key event trigger.
+
+```toml
+[keys.normal]
+A-k = { description = "Edit Config", exec = ":open ~/.config/helix/config.toml" }
+# (Note that the example example above mostly for illustrative purposes, a :config-open is provided out of the box.)
+"C-r" = { "description" = "Sort selection", "exec" = ["split_selection_on_newline", ":sort", "collapse_selection", "keep_primary_selection"]             }
+```
+
+A custom descriptions can also be defined for sub-menus.
+Aside from being them being shown in the parent-menu infobox,
+sub-menu descriptions also act as infobox titles for the submenu itself.
+
+```toml
+# A submenu accessed though space->f in normal mode.
+[keys.normal.space.f]
+description = "File"
+f = "file_picker"
+s = { description = "Save", exec = ":write" }
+c = { description = "Format", exec = ":format" }
+```
+
 ## Special keys and modifiers
 
 Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
@@ -76,5 +101,8 @@ Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
 
 Keys can be disabled by binding them to the `no_op` command.
 
+Making a mode "sticky" can be achieved by adding `sticky = true` to the mapping. 
+(Predefined sticky keytries can like wise be made unsticky with `sticky = false`.)
+
 Commands can be found at [Keymap](https://docs.helix-editor.com/keymap.html) Commands.
 > Commands can also be found in the source code at [`helix-term/src/commands.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs) at the invocation of `static_commands!` macro and the `TypableCommandList`.

helix-term/Cargo.toml

@@ -36,7 +36,6 @@ helix-loader = { version = "0.6", path = "../helix-loader" }
 
 anyhow = "1"
 once_cell = "1.17"
-
 which = "4.4"
 
 tokio = { version = "1", features = ["rt", "rt-multi-thread", "io-util", "io-std", "time", "process", "macros", "fs", "parking_lot"] }

helix-term/src/application.rs

@@ -1,4 +1,22 @@
+use crate::{
+    args::Args,
+    commands::apply_workspace_edit,
+    compositor::{Compositor, Event},
+    config::Config,
+    job::Jobs,
+    keymap::Keymap,
+    ui::{self, overlay::overlayed},
+};
+use anyhow::{Context, Error};
 use arc_swap::{access::Map, ArcSwap};
+use crossterm::{
+    event::{
+        DisableBracketedPaste, DisableFocusChange, DisableMouseCapture, EnableBracketedPaste,
+        EnableFocusChange, EnableMouseCapture, Event as CrosstermEvent,
+    },
+    execute, terminal,
+    tty::IsTty,
+};
 use futures_util::Stream;
 use helix_core::{
     diagnostic::{DiagnosticTag, NumberOrString},
@@ -15,36 +33,15 @@ use helix_view::{
     tree::Layout,
     Align, Editor,
 };
-use serde_json::json;
-use tui::backend::Backend;
-
-use crate::{
-    args::Args,
-    commands::apply_workspace_edit,
-    compositor::{Compositor, Event},
-    config::Config,
-    job::Jobs,
-    keymap::Keymaps,
-    ui::{self, overlay::overlayed},
-};
-
 use log::{debug, error, warn};
+use serde_json::json;
 use std::{
     io::{stdin, stdout, Write},
     sync::Arc,
     time::{Duration, Instant},
 };
+use tui::backend::Backend;
 
-use anyhow::{Context, Error};
-
-use crossterm::{
-    event::{
-        DisableBracketedPaste, DisableFocusChange, DisableMouseCapture, EnableBracketedPaste,
-        EnableFocusChange, EnableMouseCapture, Event as CrosstermEvent,
-    },
-    execute, terminal,
-    tty::IsTty,
-};
 #[cfg(not(windows))]
 use {
     signal_hook::{consts::signal, low_level},
@@ -180,7 +177,7 @@ impl Application {
         let keys = Box::new(Map::new(Arc::clone(&config), |config: &Config| {
             &config.keys
         }));
-        let editor_view = Box::new(ui::EditorView::new(Keymaps::new(keys)));
+        let editor_view = Box::new(ui::EditorView::new(Keymap::new(keys)));
         compositor.push(editor_view);
 
         if args.load_tutor {