typ-core 0.2.1

Panel contract, actions, keymap and events for the TYPE terminal IDE
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use typ_core::{Action, Direction, KeyChord, Keymap, Motion};

fn chord(code: KeyCode, mods: KeyModifiers) -> KeyChord {
    KeyChord::from_event(KeyEvent::new(code, mods))
}

#[test]
fn the_defaults_bind_the_arrows() {
    let keymap = Keymap::default_bindings();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Left, KeyModifiers::NONE)),
        Some(Action::Move {
            motion: Motion::Left,
            extend: false
        })
    );
}

#[test]
fn shift_extends_the_selection_rather_than_moving() {
    let keymap = Keymap::default_bindings();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Left, KeyModifiers::SHIFT)),
        Some(Action::Move {
            motion: Motion::Left,
            extend: true
        })
    );
}

#[test]
fn ctrl_arrows_move_by_word() {
    let keymap = Keymap::default_bindings();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Right, KeyModifiers::CONTROL)),
        Some(Action::Move {
            motion: Motion::WordRight,
            extend: false
        })
    );
    assert_eq!(
        keymap.lookup(&chord(
            KeyCode::Right,
            KeyModifiers::CONTROL | KeyModifiers::SHIFT
        )),
        Some(Action::Move {
            motion: Motion::WordRight,
            extend: true
        })
    );
}

#[test]
fn an_unbound_chord_returns_nothing() {
    let keymap = Keymap::default_bindings();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::F(12), KeyModifiers::NONE)),
        None
    );
}

#[test]
fn config_overrides_a_default_binding() {
    let mut keymap = Keymap::default_bindings();
    keymap
        .merge_toml("\"ctrl+d\" = \"delete_forward\"")
        .unwrap();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Char('d'), KeyModifiers::CONTROL)),
        Some(Action::Delete {
            direction: Direction::Forward,
            by_word: false
        })
    );
}

#[test]
fn config_can_unbind_a_key_with_an_empty_action() {
    let mut keymap = Keymap::default_bindings();
    keymap.merge_toml("\"ctrl+z\" = \"\"").unwrap();
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Char('z'), KeyModifiers::CONTROL)),
        None
    );
}

#[test]
fn an_unknown_action_name_is_an_error_naming_the_action() {
    let mut keymap = Keymap::default_bindings();
    let err = keymap
        .merge_toml("\"ctrl+k\" = \"summon_daemon\"")
        .unwrap_err();
    let text = format!("{err:#}");
    assert!(text.contains("summon_daemon"), "error was: {text}");
    assert!(text.contains("ctrl+k"), "error was: {text}");
}

#[test]
fn malformed_toml_is_an_error_not_a_panic() {
    let mut keymap = Keymap::default_bindings();
    assert!(keymap.merge_toml("this is not toml = = =").is_err());
}

#[test]
fn a_rejected_config_leaves_the_previous_bindings_intact() {
    let mut keymap = Keymap::default_bindings();
    let _ = keymap.merge_toml("\"ctrl+k\" = \"summon_daemon\"");
    assert_eq!(
        keymap.lookup(&chord(KeyCode::Left, KeyModifiers::NONE)),
        Some(Action::Move {
            motion: Motion::Left,
            extend: false
        })
    );
}

#[test]
fn bindings_can_be_looked_up_backwards_for_help_text() {
    let keymap = Keymap::default_bindings();
    let bindings = keymap.bindings_for(Action::Save);
    assert!(bindings.contains(&"ctrl+s"), "bindings were: {bindings:?}");
}