leadr 2.8.6

Shell aliases on steroids
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use color_eyre::eyre::{Result, ensure};
use crossterm::event::KeyEvent;

use crate::keybinding::{
    bash_zsh::keyevent_to_shell_seq, fish::fish_keyevent_to_shell_seq,
    nushell::nushell_keyevent_to_fields,
};

/// All currently supported shells
pub enum Shell {
    Bash,
    Fish,
    Nushell,
    Zsh,
}

/// Generate shell code to bind a sequence of KeyEvents to a shell function
pub fn keyevents_to_shell_binding(
    events: &[KeyEvent],
    function_name: &str,
    shell: Shell,
) -> Result<String> {
    ensure!(
        !events.is_empty(),
        "Invalid leadr keymap: No key events provided."
    );

    match shell {
        Shell::Bash => {
            let key_code_string = events
                .iter()
                .map(|ev| keyevent_to_shell_seq(*ev))
                .collect::<String>();

            Ok(format!(
                "\nbind -m emacs -x '\"{key_code_string}\":{function_name}'\n\
                 bind -m vi-insert -x '\"{key_code_string}\":{function_name}'\n\
                 # In vi-command mode, switch to insert mode, invoke leadr using the binding defined above, then return to command mode\n\
                 bind -m vi-command '\"{key_code_string}\":i{function_name}\\e'\n",
            ))
        }
        Shell::Fish => {
            let key_code_string = events
                .iter()
                .map(|ev| fish_keyevent_to_shell_seq(*ev))
                .collect::<Vec<_>>()
                .join(",");

            Ok(format!("\nbind {key_code_string} {function_name}\n"))
        }
        Shell::Nushell => {
            ensure!(
                events.len() == 1,
                "Invalid keymap: Nushell only supports single-chord keybindings (e.g. `<C-g>` or <S-M-a>).\n  \
                     Multi-chord sequences like `<C-x><C-f>` are not supported.\n  \
                     Please adjust the leadr keymap in your configuration accordingly."
            );

            let event = events[0];
            let fields = nushell_keyevent_to_fields(event)?;

            Ok(format!(
                "\n$env.config.keybindings ++= [{{\n    \
                     name: leadr\n    \
                     modifier: {}\n    \
                     keycode: {}\n    \
                     mode: [emacs vi_insert vi_normal]\n    \
                     event: {{\n        \
                         send: executehostcommand\n        \
                         cmd: \"{}\"\n    \
                     }}\n\
                 }}]",
                fields.modifier, fields.keycode, function_name
            ))
        }
        Shell::Zsh => {
            let key_code_string = events
                .iter()
                .map(|ev| keyevent_to_shell_seq(*ev))
                .collect::<String>();

            Ok(format!(
                "zle -N {function_name}\n\
                bindkey '{key_code_string}' {function_name}"
            ))
        }
    }
}