git.iko.soy/helix
on master help sign in
feat(commands): command palette (#1400)

* feat(commands): command palette Add new command to display command pallete that can be used to discover and execute available commands. Fixes: https://github.com/helix-editor/helix/issues/559 * Make picker take the whole context, not just editor * Bind command pallete * Typable commands also in the palette * Show key bindings for commands * Fix tests, small refactor * Refactor keymap mapping, fix typo * Ignore sequence key bindings for now * Apply suggestions * Fix lint issues in tests * Fix after rebase Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>

commitafec54485a3be29ff1172f70157a183853273420 authorMatouš Dzivjak <matousdzivjak@gmail.com> dateThu 17 Feb 2022, 06:03 (5 years ago) parent24f90ba
3 files changed+142−3
compare with master
unifiedsplit
helix-term/src/commands.rs+65−1 helix-term/src/keymap.rs+76−1 helix-term/src/ui/editor.rs+1−1
helix-term/src/commands.rs+65−1
@@ -44,7 +44,7 @@ use movement::Movement;
4444use crate::{
4545 args,
4646 compositor::{self, Component, Compositor},
47− ui::{self, overlay::overlayed, FilePicker, Popup, Prompt, PromptEvent},
47+ ui::{self, overlay::overlayed, FilePicker, Picker, Popup, Prompt, PromptEvent},
4848};
4949
5050use crate::job::{self, Job, Jobs};
@@ -430,6 +430,7 @@ impl MappableCommand {
430430 decrement, "Decrement",
431431 record_macro, "Record macro",
432432 replay_macro, "Replay macro",
433+ command_palette, "Open command pallete",
433434 );
434435}
435436
@@ -3692,6 +3693,69 @@ pub fn code_action(cx: &mut Context) {
36923693 )
36933694}
36943695
3696+pub fn command_palette(cx: &mut Context) {
3697+ cx.callback = Some(Box::new(
3698+ move |compositor: &mut Compositor, cx: &mut compositor::Context| {
3699+ let doc = doc_mut!(cx.editor);
3700+ let keymap =
3701+ compositor.find::<ui::EditorView>().unwrap().keymaps[&doc.mode].reverse_map();
3702+
3703+ let mut commands: Vec<MappableCommand> = MappableCommand::STATIC_COMMAND_LIST.into();
3704+ commands.extend(
3705+ cmd::TYPABLE_COMMAND_LIST
3706+ .iter()
3707+ .map(|cmd| MappableCommand::Typable {
3708+ name: cmd.name.to_owned(),
3709+ doc: cmd.doc.to_owned(),
3710+ args: Vec::new(),
3711+ }),
3712+ );
3713+
3714+ // formats key bindings, multiple bindings are comma separated,
3715+ // individual key presses are joined with `+`
3716+ let fmt_binding = |bindings: &Vec<Vec<KeyEvent>>| -> String {
3717+ bindings
3718+ .iter()
3719+ .map(|bind| {
3720+ bind.iter()
3721+ .map(|key| key.to_string())
3722+ .collect::<Vec<String>>()
3723+ .join("+")
3724+ })
3725+ .collect::<Vec<String>>()
3726+ .join(", ")
3727+ };
3728+
3729+ let picker = Picker::new(
3730+ commands,
3731+ move |command| match command {
3732+ MappableCommand::Typable { doc, name, .. } => match keymap.get(name as &String)
3733+ {
3734+ Some(bindings) => format!("{} ({})", doc, fmt_binding(bindings)).into(),
3735+ None => doc.into(),
3736+ },
3737+ MappableCommand::Static { doc, name, .. } => match keymap.get(*name) {
3738+ Some(bindings) => format!("{} ({})", doc, fmt_binding(bindings)).into(),
3739+ None => (*doc).into(),
3740+ },
3741+ },
3742+ move |cx, command, _action| {
3743+ let mut ctx = Context {
3744+ register: None,
3745+ count: std::num::NonZeroUsize::new(1),
3746+ editor: cx.editor,
3747+ callback: None,
3748+ on_next_key_callback: None,
3749+ jobs: cx.jobs,
3750+ };
3751+ command.execute(&mut ctx);
3752+ },
3753+ );
3754+ compositor.push(Box::new(picker));
3755+ },
3756+ ));
3757+}
3758+
36953759pub fn execute_lsp_command(editor: &mut Editor, cmd: lsp::Command) {
36963760 let doc = doc!(editor);
36973761 let language_server = match doc.language_server() {
helix-term/src/keymap.rs+76−1
@@ -343,13 +343,46 @@ pub struct Keymap {
343343
344344impl Keymap {
345345 pub fn new(root: KeyTrie) -> Self {
346− Self {
346+ Keymap {
347347 root,
348348 state: Vec::new(),
349349 sticky: None,
350350 }
351351 }
352352
353+ pub fn reverse_map(&self) -> HashMap<String, Vec<Vec<KeyEvent>>> {
354+ // recursively visit all nodes in keymap
355+ fn map_node(
356+ cmd_map: &mut HashMap<String, Vec<Vec<KeyEvent>>>,
357+ node: &KeyTrie,
358+ keys: &mut Vec<KeyEvent>,
359+ ) {
360+ match node {
361+ KeyTrie::Leaf(cmd) => match cmd {
362+ MappableCommand::Typable { name, .. } => {
363+ cmd_map.entry(name.into()).or_default().push(keys.clone())
364+ }
365+ MappableCommand::Static { name, .. } => cmd_map
366+ .entry(name.to_string())
367+ .or_default()
368+ .push(keys.clone()),
369+ },
370+ KeyTrie::Node(next) => {
371+ for (key, trie) in &next.map {
372+ keys.push(*key);
373+ map_node(cmd_map, trie, keys);
374+ keys.pop();
375+ }
376+ }
377+ KeyTrie::Sequence(_) => {}
378+ };
379+ }
380+
381+ let mut res = HashMap::new();
382+ map_node(&mut res, &self.root, &mut Vec::new());
383+ res
384+ }
385+
353386 pub fn root(&self) -> &KeyTrie {
354387 &self.root
355388 }
@@ -706,6 +739,7 @@ impl Default for Keymaps {
706739 "/" => global_search,
707740 "k" => hover,
708741 "r" => rename_symbol,
742+ "?" => command_palette,
709743 },
710744 "z" => { "View"
711745 "z" | "c" => align_view_center,
@@ -958,4 +992,45 @@ mod tests {
958992 "Mismatch for view mode on `z` and `Z`"
959993 );
960994 }
995+
996+ #[test]
997+ fn reverse_map() {
998+ let normal_mode = keymap!({ "Normal mode"
999+ "i" => insert_mode,
1000+ "g" => { "Goto"
1001+ "g" => goto_file_start,
1002+ "e" => goto_file_end,
1003+ },
1004+ "j" | "k" => move_line_down,
1005+ });
1006+ let keymap = Keymap::new(normal_mode);
1007+ let mut reverse_map = keymap.reverse_map();
1008+
1009+ // sort keybindings in order to have consistent tests
1010+ // HashMaps can be compared but we can still get different ordering of bindings
1011+ // for commands that have multiple bindings assigned
1012+ for v in reverse_map.values_mut() {
1013+ v.sort()
1014+ }
1015+
1016+ assert_eq!(
1017+ reverse_map,
1018+ HashMap::from([
1019+ ("insert_mode".to_string(), vec![vec![key!('i')]]),
1020+ (
1021+ "goto_file_start".to_string(),
1022+ vec![vec![key!('g'), key!('g')]]
1023+ ),
1024+ (
1025+ "goto_file_end".to_string(),
1026+ vec![vec![key!('g'), key!('e')]]
1027+ ),
1028+ (
1029+ "move_line_down".to_string(),
1030+ vec![vec![key!('j')], vec![key!('k')]]
1031+ ),
1032+ ]),
1033+ "Mistmatch"
1034+ )
1035+ }
9611036}
helix-term/src/ui/editor.rs+1−1
@@ -31,7 +31,7 @@ use crossterm::event::{Event, MouseButton, MouseEvent, MouseEventKind};
3131use tui::buffer::Buffer as Surface;
3232
3333pub struct EditorView {
34− keymaps: Keymaps,
34+ pub keymaps: Keymaps,
3535 on_next_key: Option<Box<dyn FnOnce(&mut commands::Context, KeyEvent)>>,
3636 last_insert: (commands::MappableCommand, Vec<KeyEvent>),
3737 pub(crate) completion: Option<Completion>,