Skip to main content

tess/
keys.rs

1//! Custom keybindings loaded from `~/.config/tess/keys.toml`.
2//!
3//! Schema:
4//! ```toml
5//! [bindings]
6//! "j" = "scroll-down"
7//! "f1" = "!git status"
8//! ```
9
10use std::collections::HashMap;
11
12use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
13use serde::Deserialize;
14
15use crate::input::Command;
16
17#[derive(Debug, Clone)]
18pub enum BindingTarget {
19    Command(Command),
20    Shell(String),
21}
22
23#[derive(Debug, Clone)]
24pub struct KeyMap {
25    map: HashMap<KeyEvent, BindingTarget>,
26}
27
28impl KeyMap {
29    pub fn empty() -> Self {
30        Self { map: HashMap::new() }
31    }
32
33    /// Load keys from the global config dir (`/etc/tess/` or
34    /// `$TESS_GLOBAL_CONFIG_DIR`) and from `~/.config/tess/keys.toml`,
35    /// merging per individual binding key with local winning.
36    ///
37    /// Global parse errors warn on stderr and the global layer is treated as
38    /// empty; local parse errors fail startup.
39    pub fn load_layered() -> Result<Self, String> {
40        let mut bindings: HashMap<String, String> = HashMap::new();
41
42        // Global layer.
43        if let Some(dir) = crate::config_path::global_config_dir() {
44            let path = dir.join("keys.toml");
45            if path.exists() {
46                match std::fs::read_to_string(&path) {
47                    Ok(text) => {
48                        match toml::from_str::<KeysConfig>(&text) {
49                            Ok(cfg) => {
50                                for (k, v) in cfg.bindings {
51                                    bindings.insert(k, v);
52                                }
53                            }
54                            Err(e) => eprintln!(
55                                "tess: warning: keys.toml: {}: {e}; ignoring global config",
56                                path.display()
57                            ),
58                        }
59                    }
60                    Err(e) => eprintln!(
61                        "tess: warning: keys.toml: {}: {e}; ignoring global config",
62                        path.display()
63                    ),
64                }
65            }
66        }
67
68        // Local layer.
69        if let Some(dir) = crate::config_path::user_config_dir() {
70            let path = dir.join("keys.toml");
71            if path.exists() {
72                let text = std::fs::read_to_string(&path)
73                    .map_err(|e| format!("keys.toml: reading {}: {e}", path.display()))?;
74                let cfg: KeysConfig = toml::from_str(&text)
75                    .map_err(|e| format!("keys.toml: parsing {}: {e}", path.display()))?;
76                for (k, v) in cfg.bindings {
77                    bindings.insert(k, v);
78                }
79            }
80        }
81
82        // Build the final KeyMap from the merged bindings table.
83        let mut map = HashMap::with_capacity(bindings.len());
84        for (key_spec, action) in bindings {
85            let key = parse_key_spec(&key_spec)
86                .map_err(|e| format!("keys.toml: '{key_spec}': {e}"))?;
87            reject_forbidden_key(&key, &key_spec)
88                .map_err(|e| format!("keys.toml: {e}"))?;
89            let target = parse_action(&action)
90                .map_err(|e| format!("keys.toml: '{key_spec}': {e}"))?;
91            map.insert(key, target);
92        }
93        Ok(Self { map })
94    }
95
96    pub fn load_from_str(toml_text: &str) -> Result<Self, String> {
97        let cfg: KeysConfig = toml::from_str(toml_text)
98            .map_err(|e| format!("parsing: {e}"))?;
99        let mut map = HashMap::with_capacity(cfg.bindings.len());
100        for (key_spec, action) in cfg.bindings {
101            let key = parse_key_spec(&key_spec)
102                .map_err(|e| format!("'{key_spec}': {e}"))?;
103            reject_forbidden_key(&key, &key_spec)?;
104            let target = parse_action(&action)
105                .map_err(|e| format!("'{key_spec}': {e}"))?;
106            map.insert(key, target);
107        }
108        Ok(Self { map })
109    }
110
111    pub fn lookup(&self, key: &KeyEvent) -> Option<&BindingTarget> {
112        self.map.get(key)
113    }
114
115    pub fn is_empty(&self) -> bool {
116        self.map.is_empty()
117    }
118
119    /// Group user bindings by the kebab-case command name they target.
120    /// Shell-target bindings are excluded. Used by the help overlay to
121    /// replace default key displays with the user's chosen keys.
122    pub fn user_keys_by_command_name(&self) -> std::collections::HashMap<String, Vec<String>> {
123        let mut out: std::collections::HashMap<String, Vec<String>> =
124            std::collections::HashMap::new();
125        for (key, target) in &self.map {
126            let BindingTarget::Command(cmd) = target else { continue };
127            let Some(name) = command_to_kebab(cmd) else { continue };
128            out.entry(name.to_string())
129                .or_default()
130                .push(format_key_event(*key));
131        }
132        out
133    }
134}
135
136#[derive(Debug, Deserialize, Default)]
137struct KeysConfig {
138    #[serde(default)]
139    bindings: HashMap<String, String>,
140}
141
142/// Parse a key spec string into a `KeyEvent`.
143fn parse_key_spec(spec: &str) -> Result<KeyEvent, String> {
144    let lower = spec.to_lowercase();
145    let mut parts: Vec<&str> = lower.split('-').collect();
146    if parts.is_empty() {
147        return Err("empty key spec".to_string());
148    }
149    let key_part = parts.pop().unwrap();
150    let mut modifiers = KeyModifiers::NONE;
151    for m in &parts {
152        if m.is_empty() {
153            // Handle "ctrl--" (ctrl + dash). The trailing "-" became "".
154            continue;
155        }
156        match *m {
157            "ctrl" => modifiers |= KeyModifiers::CONTROL,
158            "alt" => modifiers |= KeyModifiers::ALT,
159            "shift" => modifiers |= KeyModifiers::SHIFT,
160            other => return Err(format!("unknown modifier '{other}'")),
161        }
162    }
163    let code = match key_part {
164        "esc" => KeyCode::Esc,
165        "enter" => KeyCode::Enter,
166        "tab" => KeyCode::Tab,
167        "backspace" => KeyCode::Backspace,
168        "space" => KeyCode::Char(' '),
169        "up" => KeyCode::Up,
170        "down" => KeyCode::Down,
171        "left" => KeyCode::Left,
172        "right" => KeyCode::Right,
173        "pgup" => KeyCode::PageUp,
174        "pgdn" => KeyCode::PageDown,
175        "home" => KeyCode::Home,
176        "end" => KeyCode::End,
177        "" => {
178            // The trailing piece was empty, meaning the key is literal "-"
179            // and the modifiers consumed everything else (e.g. "ctrl--").
180            KeyCode::Char('-')
181        }
182        s if s.starts_with('f') && s.len() > 1 => {
183            let n: u8 = s[1..].parse()
184                .map_err(|_| format!("unknown key '{s}'"))?;
185            KeyCode::F(n)
186        }
187        s if s.chars().count() == 1 => {
188            // For a BARE letter with no modifiers, an uppercase letter
189            // promotes to shift-prefix semantics ("J" == "shift-j").
190            // When modifiers are already present (e.g. "ctrl-J"), the
191            // user's intent is the literal letter — don't add SHIFT.
192            let original_char = spec.chars().last().unwrap();
193            if original_char.is_ascii_uppercase() && modifiers == KeyModifiers::NONE {
194                modifiers |= KeyModifiers::SHIFT;
195                KeyCode::Char(original_char.to_ascii_lowercase())
196            } else {
197                // Either lowercase letter, or uppercase with an explicit
198                // modifier — lowercase the char either way for consistency.
199                KeyCode::Char(original_char.to_ascii_lowercase())
200            }
201        }
202        other => return Err(format!("unknown key '{other}'")),
203    };
204    Ok(KeyEvent::new(code, modifiers))
205}
206
207fn reject_forbidden_key(key: &KeyEvent, original_spec: &str) -> Result<(), String> {
208    let forbidden = match (&key.code, key.modifiers) {
209        (KeyCode::Char('m'), KeyModifiers::NONE) => true,
210        (KeyCode::Char('\''), KeyModifiers::NONE) => true,
211        (KeyCode::Char('-'), KeyModifiers::NONE) => true,
212        (KeyCode::Char('x'), KeyModifiers::CONTROL) => true,
213        (KeyCode::Char(c), KeyModifiers::NONE) if c.is_ascii_digit() => true,
214        _ => false,
215    };
216    if forbidden {
217        return Err(format!(
218            "'{original_spec}' is part of a multi-key sequence and cannot be rebound"
219        ));
220    }
221    Ok(())
222}
223
224fn parse_action(action: &str) -> Result<BindingTarget, String> {
225    if let Some(shell_cmd) = action.strip_prefix('!') {
226        if shell_cmd.is_empty() {
227            return Err("shell binding requires a command after '!'".to_string());
228        }
229        return Ok(BindingTarget::Shell(shell_cmd.to_string()));
230    }
231    let cmd = command_from_kebab(action)
232        .ok_or_else(|| format!("unknown command '{action}'"))?;
233    Ok(BindingTarget::Command(cmd))
234}
235
236/// Map a kebab-case command name to the corresponding `Command` enum variant.
237fn command_from_kebab(name: &str) -> Option<Command> {
238    match name {
239        "scroll-down" => Some(Command::ScrollLines(1)),
240        "scroll-up" => Some(Command::ScrollLines(-1)),
241        "scroll-logical-down" => Some(Command::ScrollLogicalLines(1)),
242        "scroll-logical-up" => Some(Command::ScrollLogicalLines(-1)),
243        "page-down" => Some(Command::PageDown),
244        "page-up" => Some(Command::PageUp),
245        "half-page-down" => Some(Command::HalfPageDown),
246        "half-page-up" => Some(Command::HalfPageUp),
247        "quit" => Some(Command::Quit),
248        "refresh" => Some(Command::Refresh),
249        "reload" => Some(Command::Reload),
250        "toggle-line-numbers" => Some(Command::ToggleLineNumbers),
251        "toggle-chop" => Some(Command::ToggleChop),
252        "toggle-follow" => Some(Command::ToggleFollow),
253        "toggle-prettify" => Some(Command::TogglePrettify),
254        "search-forward" => Some(Command::SearchForward),
255        "search-backward" => Some(Command::SearchBackward),
256        "next-match" => Some(Command::NextMatch),
257        "previous-match" => Some(Command::PreviousMatch),
258        "option-prefix" => Some(Command::OptionPrefix),
259        "goto-line" => Some(Command::GotoLine),
260        "goto-record" => Some(Command::GotoRecord),
261        "goto-percent" => Some(Command::GotoPercent),
262        "mark-set" => Some(Command::MarkSet),
263        "mark-jump" => Some(Command::MarkJump),
264        "ctrl-x-prefix" => Some(Command::CtrlXPrefix),
265        "jump-previous" => Some(Command::JumpPrevious),
266        "shell-escape" => Some(Command::ShellEscape),
267        "cancel" => Some(Command::Cancel),
268        "hscroll-left" => Some(Command::HScrollLeft),
269        "hscroll-right" => Some(Command::HScrollRight),
270        "hscroll-left-step" => Some(Command::HScrollLeftStep),
271        "hscroll-right-step" => Some(Command::HScrollRightStep),
272        _ => None,
273    }
274}
275
276/// Inverse of `command_from_kebab` — covers the same command set.
277fn command_to_kebab(cmd: &Command) -> Option<&'static str> {
278    match cmd {
279        Command::ScrollLines(1) => Some("scroll-down"),
280        Command::ScrollLines(-1) => Some("scroll-up"),
281        Command::ScrollLogicalLines(1) => Some("scroll-logical-down"),
282        Command::ScrollLogicalLines(-1) => Some("scroll-logical-up"),
283        Command::PageDown => Some("page-down"),
284        Command::PageUp => Some("page-up"),
285        Command::HalfPageDown => Some("half-page-down"),
286        Command::HalfPageUp => Some("half-page-up"),
287        Command::Quit => Some("quit"),
288        Command::Refresh => Some("refresh"),
289        Command::Reload => Some("reload"),
290        Command::ToggleLineNumbers => Some("toggle-line-numbers"),
291        Command::ToggleChop => Some("toggle-chop"),
292        Command::ToggleFollow => Some("toggle-follow"),
293        Command::TogglePrettify => Some("toggle-prettify"),
294        Command::SearchForward => Some("search-forward"),
295        Command::SearchBackward => Some("search-backward"),
296        Command::NextMatch => Some("next-match"),
297        Command::PreviousMatch => Some("previous-match"),
298        Command::OptionPrefix => Some("option-prefix"),
299        Command::GotoLine => Some("goto-line"),
300        Command::GotoRecord => Some("goto-record"),
301        Command::GotoPercent => Some("goto-percent"),
302        Command::MarkSet => Some("mark-set"),
303        Command::MarkJump => Some("mark-jump"),
304        Command::CtrlXPrefix => Some("ctrl-x-prefix"),
305        Command::JumpPrevious => Some("jump-previous"),
306        Command::ShellEscape => Some("shell-escape"),
307        Command::Cancel => Some("cancel"),
308        Command::HScrollLeft => Some("hscroll-left"),
309        Command::HScrollRight => Some("hscroll-right"),
310        Command::HScrollLeftStep => Some("hscroll-left-step"),
311        Command::HScrollRightStep => Some("hscroll-right-step"),
312        _ => None,
313    }
314}
315
316fn format_key_event(ke: KeyEvent) -> String {
317    let ctrl  = ke.modifiers.contains(KeyModifiers::CONTROL);
318    let alt   = ke.modifiers.contains(KeyModifiers::ALT);
319    let shift = ke.modifiers.contains(KeyModifiers::SHIFT);
320
321    // Convention: SHIFT-alone on an ASCII letter displays as the uppercase
322    // letter with no "Shift-" prefix (matches KEY_REGISTRY's `"J"` form).
323    if shift && !ctrl && !alt {
324        if let KeyCode::Char(c) = ke.code {
325            if c.is_ascii_alphabetic() {
326                return c.to_ascii_uppercase().to_string();
327            }
328        }
329    }
330
331    let mut parts: Vec<&'static str> = Vec::new();
332    if ctrl  { parts.push("Ctrl"); }
333    if alt   { parts.push("Alt"); }
334    if shift { parts.push("Shift"); }
335
336    let key = match ke.code {
337        KeyCode::Char(' ') => "Space".to_string(),
338        KeyCode::Char(c)   => c.to_string(),
339        KeyCode::F(n)      => format!("F{n}"),
340        KeyCode::Esc       => "Esc".into(),
341        KeyCode::Enter     => "Enter".into(),
342        KeyCode::Tab       => "Tab".into(),
343        KeyCode::Backspace => "Backspace".into(),
344        KeyCode::Up        => "\u{2191}".into(),
345        KeyCode::Down      => "\u{2193}".into(),
346        KeyCode::Left      => "\u{2190}".into(),
347        KeyCode::Right     => "\u{2192}".into(),
348        KeyCode::Home      => "Home".into(),
349        KeyCode::End       => "End".into(),
350        KeyCode::PageUp    => "PgUp".into(),
351        KeyCode::PageDown  => "PgDn".into(),
352        other              => format!("{other:?}"),
353    };
354    if parts.is_empty() { key } else { format!("{}-{}", parts.join("-"), key) }
355}
356
357#[cfg(test)]
358mod tests {
359    use super::*;
360    use std::sync::Mutex;
361
362    static HOME_LOCK: Mutex<()> = Mutex::new(());
363
364    #[test]
365    fn parse_empty_file_returns_empty_map() {
366        let m = KeyMap::load_from_str("").unwrap();
367        assert!(m.is_empty());
368    }
369
370    #[test]
371    fn parse_single_binding() {
372        let toml = r#"
373[bindings]
374"j" = "scroll-down"
375"#;
376        let m = KeyMap::load_from_str(toml).unwrap();
377        let key = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::NONE);
378        assert!(matches!(m.lookup(&key), Some(BindingTarget::Command(Command::ScrollLines(1)))));
379    }
380
381    #[test]
382    fn parse_named_special_key() {
383        let toml = r#"
384[bindings]
385"f1" = "toggle-line-numbers"
386"esc" = "cancel"
387"#;
388        let m = KeyMap::load_from_str(toml).unwrap();
389        let f1 = KeyEvent::new(KeyCode::F(1), KeyModifiers::NONE);
390        let esc = KeyEvent::new(KeyCode::Esc, KeyModifiers::NONE);
391        assert!(matches!(m.lookup(&f1), Some(BindingTarget::Command(Command::ToggleLineNumbers))));
392        assert!(matches!(m.lookup(&esc), Some(BindingTarget::Command(Command::Cancel))));
393    }
394
395    #[test]
396    fn parse_modifier_combinations() {
397        let toml = r#"
398[bindings]
399"ctrl-r" = "reload"
400"shift-tab" = "scroll-logical-up"
401"#;
402        let m = KeyMap::load_from_str(toml).unwrap();
403        let ctrl_r = KeyEvent::new(KeyCode::Char('r'), KeyModifiers::CONTROL);
404        let shift_tab = KeyEvent::new(KeyCode::Tab, KeyModifiers::SHIFT);
405        assert!(matches!(m.lookup(&ctrl_r), Some(BindingTarget::Command(Command::Reload))));
406        assert!(matches!(m.lookup(&shift_tab), Some(BindingTarget::Command(Command::ScrollLogicalLines(-1)))));
407    }
408
409    #[test]
410    fn case_letter_resolves_to_shift_prefix() {
411        let toml = r#"
412[bindings]
413"J" = "scroll-logical-down"
414"#;
415        let m = KeyMap::load_from_str(toml).unwrap();
416        let shift_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::SHIFT);
417        assert!(matches!(m.lookup(&shift_j), Some(BindingTarget::Command(Command::ScrollLogicalLines(1)))));
418    }
419
420    #[test]
421    fn forbidden_keys_error_at_parse() {
422        for key in &["m", "'", "-", "ctrl-x", "0", "5", "9"] {
423            let toml = format!(r#"
424[bindings]
425"{key}" = "quit"
426"#);
427            let err = KeyMap::load_from_str(&toml).unwrap_err();
428            assert!(err.contains("multi-key sequence"),
429                    "key '{key}' should be forbidden: {err}");
430        }
431    }
432
433    #[test]
434    fn unknown_command_name_errors() {
435        let toml = r#"
436[bindings]
437"j" = "definitely-not-a-real-command"
438"#;
439        let err = KeyMap::load_from_str(toml).unwrap_err();
440        assert!(err.contains("unknown command"));
441    }
442
443    #[test]
444    fn empty_shell_binding_errors() {
445        let toml = r#"
446[bindings]
447"f1" = "!"
448"#;
449        let err = KeyMap::load_from_str(toml).unwrap_err();
450        assert!(err.contains("requires a command"));
451    }
452
453    #[test]
454    fn parse_inline_shell_binding() {
455        let toml = r#"
456[bindings]
457"f2" = "!git status"
458"#;
459        let m = KeyMap::load_from_str(toml).unwrap();
460        let f2 = KeyEvent::new(KeyCode::F(2), KeyModifiers::NONE);
461        match m.lookup(&f2) {
462            Some(BindingTarget::Shell(cmd)) => assert_eq!(cmd, "git status"),
463            other => panic!("expected Shell, got {:?}", other),
464        }
465    }
466
467    #[test]
468    fn lookup_returns_none_for_unbound_key() {
469        let toml = r#"
470[bindings]
471"j" = "scroll-down"
472"#;
473        let m = KeyMap::load_from_str(toml).unwrap();
474        let other = KeyEvent::new(KeyCode::Char('k'), KeyModifiers::NONE);
475        assert!(m.lookup(&other).is_none());
476    }
477
478    #[test]
479    fn ctrl_uppercase_letter_does_not_add_shift() {
480        // "ctrl-J" should be Ctrl + 'j', NOT Ctrl + Shift + 'j'.
481        let toml = r#"
482[bindings]
483"ctrl-J" = "reload"
484"#;
485        let m = KeyMap::load_from_str(toml).unwrap();
486        let ctrl_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::CONTROL);
487        assert!(matches!(m.lookup(&ctrl_j), Some(BindingTarget::Command(Command::Reload))),
488                "ctrl-J should resolve to Ctrl+j without Shift");
489        let ctrl_shift_j = KeyEvent::new(KeyCode::Char('j'), KeyModifiers::CONTROL | KeyModifiers::SHIFT);
490        assert!(m.lookup(&ctrl_shift_j).is_none(),
491                "ctrl-J should NOT also match Ctrl+Shift+j");
492    }
493
494    #[test]
495    fn user_remaps_by_command_name_groups_keys() {
496        let toml = r#"
497[bindings]
498"f3" = "scroll-down"
499"f4" = "scroll-down"
500"f5" = "quit"
501"#;
502        let m = KeyMap::load_from_str(toml).unwrap();
503        let groups = m.user_keys_by_command_name();
504        let mut down = groups.get("scroll-down").cloned().unwrap_or_default();
505        down.sort();
506        assert_eq!(down, vec!["F3".to_string(), "F4".to_string()]);
507        assert_eq!(groups.get("quit").cloned().unwrap_or_default(), vec!["F5".to_string()]);
508    }
509
510    #[test]
511    fn dash_with_modifier_is_a_real_key() {
512        // "ctrl--" should resolve to Ctrl + '-' (a valid bind).
513        // (Bare "-" is forbidden by reject_forbidden_key, but Ctrl-- isn't.)
514        let toml = r#"
515[bindings]
516"ctrl--" = "refresh"
517"#;
518        let m = KeyMap::load_from_str(toml).unwrap();
519        let ctrl_dash = KeyEvent::new(KeyCode::Char('-'), KeyModifiers::CONTROL);
520        assert!(matches!(m.lookup(&ctrl_dash), Some(BindingTarget::Command(Command::Refresh))));
521    }
522
523    #[test]
524    fn format_key_event_renders_modifier_combos() {
525        // Ctrl alone
526        assert_eq!(
527            format_key_event(KeyEvent::new(KeyCode::Char('r'), KeyModifiers::CONTROL)),
528            "Ctrl-r",
529        );
530        // Shift alone on a letter → uppercase, no prefix
531        assert_eq!(
532            format_key_event(KeyEvent::new(KeyCode::Char('j'), KeyModifiers::SHIFT)),
533            "J",
534        );
535        // Shift alone on a non-letter (e.g. Tab) → "Shift-Tab"
536        assert_eq!(
537            format_key_event(KeyEvent::new(KeyCode::Tab, KeyModifiers::SHIFT)),
538            "Shift-Tab",
539        );
540        // Plain lowercase letter → "j" (no uppercasing)
541        assert_eq!(
542            format_key_event(KeyEvent::new(KeyCode::Char('j'), KeyModifiers::NONE)),
543            "j",
544        );
545        // Function key
546        assert_eq!(
547            format_key_event(KeyEvent::new(KeyCode::F(3), KeyModifiers::NONE)),
548            "F3",
549        );
550        // Ctrl+Shift+letter — composed prefix, lowercase stored char
551        assert_eq!(
552            format_key_event(KeyEvent::new(KeyCode::Char('x'), KeyModifiers::CONTROL | KeyModifiers::SHIFT)),
553            "Ctrl-Shift-x",
554        );
555    }
556
557    #[test]
558    fn hscroll_names_resolve_to_commands() {
559        let toml = r#"
560[bindings]
561"f6" = "hscroll-right"
562"#;
563        let m = KeyMap::load_from_str(toml).unwrap();
564        let f6 = KeyEvent::new(KeyCode::F(6), KeyModifiers::NONE);
565        assert!(matches!(m.lookup(&f6), Some(BindingTarget::Command(Command::HScrollRight))));
566
567        assert!(matches!(command_from_kebab("hscroll-left"), Some(Command::HScrollLeft)));
568        assert!(matches!(command_from_kebab("hscroll-left-step"), Some(Command::HScrollLeftStep)));
569        assert!(matches!(command_from_kebab("hscroll-right-step"), Some(Command::HScrollRightStep)));
570    }
571
572    #[test]
573    fn command_kebab_round_trip() {
574        // Every name in command_from_kebab must round-trip through command_to_kebab.
575        let names = [
576            "scroll-down", "scroll-up", "scroll-logical-down", "scroll-logical-up",
577            "page-down", "page-up", "half-page-down", "half-page-up",
578            "quit", "refresh", "reload",
579            "toggle-line-numbers", "toggle-chop", "toggle-follow", "toggle-prettify",
580            "search-forward", "search-backward", "next-match", "previous-match",
581            "option-prefix", "goto-line", "goto-record", "goto-percent",
582            "mark-set", "mark-jump", "ctrl-x-prefix", "jump-previous",
583            "shell-escape", "cancel",
584            "hscroll-left", "hscroll-right", "hscroll-left-step", "hscroll-right-step",
585        ];
586        for name in &names {
587            let cmd = command_from_kebab(name).expect(&format!("from_kebab failed for {name}"));
588            let back = command_to_kebab(&cmd).expect(&format!("to_kebab failed for {name}"));
589            assert_eq!(back, *name, "round-trip mismatch for {name}");
590        }
591    }
592
593    #[test]
594    fn shell_bindings_are_excluded_from_user_keys() {
595        let toml = r#"
596[bindings]
597"f2" = "!git status"
598"f3" = "scroll-down"
599"#;
600        let m = KeyMap::load_from_str(toml).unwrap();
601        let groups = m.user_keys_by_command_name();
602        assert!(!groups.values().any(|v| v.contains(&"F2".to_string())),
603                "shell-bound F2 should not appear: {groups:?}");
604        assert_eq!(groups.get("scroll-down").cloned().unwrap_or_default(), vec!["F3".to_string()]);
605    }
606
607    #[test]
608    fn layered_keys_local_overrides_global_per_binding() {
609        let _guard = HOME_LOCK.lock().unwrap();
610        let prev_home = std::env::var_os("HOME");
611        let prev_global = std::env::var_os("TESS_GLOBAL_CONFIG_DIR");
612
613        let home = tempfile::tempdir().unwrap();
614        let global = tempfile::tempdir().unwrap();
615
616        std::env::set_var("HOME", home.path());
617        std::env::set_var("TESS_GLOBAL_CONFIG_DIR", global.path());
618
619        std::fs::write(
620            global.path().join("keys.toml"),
621            r#"
622[bindings]
623"j" = "scroll-down"
624"k" = "scroll-up"
625"#,
626        )
627        .unwrap();
628
629        let cfg_dir = home.path().join(".config").join("tess");
630        std::fs::create_dir_all(&cfg_dir).unwrap();
631        std::fs::write(
632            cfg_dir.join("keys.toml"),
633            r#"
634[bindings]
635"j" = "page-down"
636"#,
637        )
638        .unwrap();
639
640        let km = KeyMap::load_layered().unwrap();
641
642        // j: local wins (page-down)
643        let j = crossterm::event::KeyEvent::new(
644            crossterm::event::KeyCode::Char('j'),
645            crossterm::event::KeyModifiers::NONE,
646        );
647        match km.lookup(&j) {
648            Some(BindingTarget::Command(cmd)) => {
649                let dbg = format!("{cmd:?}");
650                assert!(dbg.to_lowercase().contains("page"), "got: {dbg}");
651            }
652            other => panic!("expected Command(PageDown), got {other:?}"),
653        }
654
655        // k: global survives (scroll-up)
656        let k = crossterm::event::KeyEvent::new(
657            crossterm::event::KeyCode::Char('k'),
658            crossterm::event::KeyModifiers::NONE,
659        );
660        match km.lookup(&k) {
661            Some(BindingTarget::Command(cmd)) => {
662                assert!(matches!(cmd, Command::ScrollLines(n) if *n < 0), "got: {cmd:?}");
663            }
664            other => panic!("expected Command(ScrollLines(-1)), got {other:?}"),
665        }
666
667        match prev_home {
668            Some(v) => std::env::set_var("HOME", v),
669            None => std::env::remove_var("HOME"),
670        }
671        match prev_global {
672            Some(v) => std::env::set_var("TESS_GLOBAL_CONFIG_DIR", v),
673            None => std::env::remove_var("TESS_GLOBAL_CONFIG_DIR"),
674        }
675    }
676
677    #[test]
678    fn layered_keys_warns_on_bad_global() {
679        let _guard = HOME_LOCK.lock().unwrap();
680        let prev_home = std::env::var_os("HOME");
681        let prev_global = std::env::var_os("TESS_GLOBAL_CONFIG_DIR");
682
683        let home = tempfile::tempdir().unwrap();
684        let global = tempfile::tempdir().unwrap();
685
686        std::env::set_var("HOME", home.path());
687        std::env::set_var("TESS_GLOBAL_CONFIG_DIR", global.path());
688
689        std::fs::write(
690            global.path().join("keys.toml"),
691            "= = not valid",
692        )
693        .unwrap();
694
695        // Local missing — should still succeed.
696        let km = KeyMap::load_layered().unwrap();
697        assert!(km.is_empty());
698
699        match prev_home {
700            Some(v) => std::env::set_var("HOME", v),
701            None => std::env::remove_var("HOME"),
702        }
703        match prev_global {
704            Some(v) => std::env::set_var("TESS_GLOBAL_CONFIG_DIR", v),
705            None => std::env::remove_var("TESS_GLOBAL_CONFIG_DIR"),
706        }
707    }
708}