kanban-tui 0.9.0

Terminal user interface for the kanban project management tool
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use super::{Keybinding, KeybindingAction, KeybindingContext, KeybindingProvider};

pub struct SearchModeProvider;

impl KeybindingProvider for SearchModeProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Search Mode",
            vec![
                Keybinding::new(
                    "ESC",
                    "clear",
                    "Clear search and return",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "Enter",
                    "apply",
                    "Apply filter and browse results",
                    KeybindingAction::SelectItem,
                ),
                Keybinding::new(
                    "Type",
                    "query",
                    "Enter search query",
                    KeybindingAction::Search,
                ),
                Keybinding::new(
                    "n/N",
                    "navigate",
                    "Next/previous hit (after applying)",
                    KeybindingAction::NavigateDown,
                ),
            ],
        )
    }
}

pub struct DialogInputProvider {
    dialog_name: String,
}

impl DialogInputProvider {
    pub fn new(dialog_name: impl Into<String>) -> Self {
        Self {
            dialog_name: dialog_name.into(),
        }
    }
}

impl KeybindingProvider for DialogInputProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            format!("{} - Input Dialog", self.dialog_name),
            vec![
                Keybinding::new(
                    "ESC",
                    "cancel",
                    "Cancel and close dialog",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "Enter",
                    "confirm",
                    "Confirm and apply",
                    KeybindingAction::SelectItem,
                ),
                Keybinding::new("Type", "input", "Enter text", KeybindingAction::EditCard),
                Keybinding::new(
                    "Backspace",
                    "delete",
                    "Delete previous character",
                    KeybindingAction::EditCard,
                ),
                Keybinding::new(
                    "←/→",
                    "move",
                    "Move cursor left/right",
                    KeybindingAction::NavigateLeft,
                ),
                Keybinding::new(
                    "Home/End",
                    "jump",
                    "Jump to start/end of line",
                    KeybindingAction::NavigateLeft,
                ),
            ],
        )
    }
}

pub struct CreateColumnDialogProvider;

impl KeybindingProvider for CreateColumnDialogProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Create Column - Input Dialog",
            vec![
                Keybinding::new(
                    "ESC",
                    "cancel",
                    "Cancel and close dialog",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "Enter",
                    "confirm",
                    "Create column",
                    KeybindingAction::SelectItem,
                ),
                Keybinding::new(
                    "Tab",
                    "switch field",
                    "Switch between name and default status",
                    KeybindingAction::NavigateRight,
                ),
                Keybinding::new(
                    "Type",
                    "input",
                    "Enter column name",
                    KeybindingAction::EditCard,
                ),
                Keybinding::new(
                    "j/↓ k/↑",
                    "status",
                    "Choose default status (when selector focused)",
                    KeybindingAction::NavigateDown,
                ),
            ],
        )
    }
}

pub struct DialogSelectionProvider {
    dialog_name: String,
}

impl DialogSelectionProvider {
    pub fn new(dialog_name: impl Into<String>) -> Self {
        Self {
            dialog_name: dialog_name.into(),
        }
    }
}

impl KeybindingProvider for DialogSelectionProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            format!("{} - Selection Dialog", self.dialog_name),
            vec![
                Keybinding::new(
                    "ESC",
                    "cancel",
                    "Cancel and close dialog",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "j/↓",
                    "down",
                    "Navigate down",
                    KeybindingAction::NavigateDown,
                ),
                Keybinding::new("k/↑", "up", "Navigate up", KeybindingAction::NavigateUp),
                Keybinding::new(
                    "Enter/Space",
                    "select",
                    "Select and confirm",
                    KeybindingAction::SelectItem,
                ),
            ],
        )
    }
}

pub struct DeleteConfirmProvider {
    what: String,
}

impl DeleteConfirmProvider {
    pub fn new(what: impl Into<String>) -> Self {
        Self { what: what.into() }
    }
}

impl KeybindingProvider for DeleteConfirmProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            format!("Delete {} - Confirm", self.what),
            vec![
                Keybinding::new("ESC", "cancel", "Cancel deletion", KeybindingAction::Escape),
                Keybinding::new("n", "no", "Do not delete", KeybindingAction::Escape),
                Keybinding::new("y", "yes", "Confirm deletion", KeybindingAction::SelectItem),
                Keybinding::new(
                    "Enter",
                    "yes",
                    "Confirm deletion",
                    KeybindingAction::SelectItem,
                ),
            ],
        )
    }
}

pub struct ErrorLogProvider;

impl KeybindingProvider for ErrorLogProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Error Log",
            vec![
                Keybinding::new(
                    "ESC/q",
                    "close",
                    "Close error log",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "j/k",
                    "scroll",
                    "Scroll up/down",
                    KeybindingAction::NavigateDown,
                ),
            ],
        )
    }
}

pub struct FilterOptionsProvider;

impl KeybindingProvider for FilterOptionsProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Filter Options",
            vec![
                Keybinding::new(
                    "ESC",
                    "cancel",
                    "Cancel and close filters",
                    KeybindingAction::Escape,
                ),
                Keybinding::new(
                    "j/↓",
                    "down",
                    "Navigate down",
                    KeybindingAction::NavigateDown,
                ),
                Keybinding::new("k/↑", "up", "Navigate up", KeybindingAction::NavigateUp),
                Keybinding::new(
                    "Space",
                    "toggle",
                    "Toggle filter option",
                    KeybindingAction::ToggleFilter,
                ),
                Keybinding::new(
                    "Enter",
                    "apply",
                    "Apply selected filters",
                    KeybindingAction::SelectItem,
                ),
            ],
        )
    }
}

pub struct ConfirmSprintPrefixCollisionProvider;

impl KeybindingProvider for ConfirmSprintPrefixCollisionProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Confirm Sprint Prefix",
            vec![
                Keybinding::new(
                    "y",
                    "yes",
                    "Use this prefix anyway",
                    KeybindingAction::ConfirmPrefixCollision,
                ),
                Keybinding::new(
                    "Enter",
                    "yes",
                    "Use this prefix anyway",
                    KeybindingAction::ConfirmPrefixCollision,
                ),
                Keybinding::new(
                    "n",
                    "no",
                    "Go back and choose a different prefix",
                    KeybindingAction::RejectPrefixCollision,
                ),
                Keybinding::new(
                    "ESC",
                    "cancel",
                    "Cancel",
                    KeybindingAction::CancelPrefixCollision,
                ),
            ],
        )
    }
}

pub struct ConflictResolutionProvider;

impl KeybindingProvider for ConflictResolutionProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "Resolve Conflict",
            vec![
                Keybinding::new(
                    "o",
                    "overwrite",
                    "Keep your changes and overwrite the file on disk",
                    KeybindingAction::ForceOverwriteConflict,
                ),
                Keybinding::new(
                    "t",
                    "take theirs",
                    "Discard your changes and reload from disk",
                    KeybindingAction::TakeTheirsConflict,
                ),
                Keybinding::new(
                    "ESC",
                    "retry later",
                    "Cancel and decide again later",
                    KeybindingAction::CancelConflictResolution,
                ),
            ],
        )
    }
}

pub struct ExternalChangeDetectedProvider;

impl KeybindingProvider for ExternalChangeDetectedProvider {
    fn get_context(&self) -> KeybindingContext {
        KeybindingContext::new(
            "External Change",
            vec![
                Keybinding::new(
                    "r",
                    "reload",
                    "Reload from disk (discards your local changes)",
                    KeybindingAction::ReloadDiscardLocal,
                ),
                Keybinding::new(
                    "k",
                    "keep local",
                    "Keep local changes (discards the external write)",
                    KeybindingAction::KeepLocalChanges,
                ),
                Keybinding::new(
                    "ESC",
                    "dismiss",
                    "Dismiss and continue with current state",
                    KeybindingAction::DismissExternalChange,
                ),
            ],
        )
    }
}

#[cfg(test)]
mod confirm_dialog_tests {
    use super::*;

    #[test]
    fn test_confirm_sprint_prefix_collision_provider_advertises_real_keys_not_list_nav() {
        let context = ConfirmSprintPrefixCollisionProvider.get_context();
        let keys: Vec<&str> = context.bindings.iter().map(|b| b.key.as_str()).collect();
        assert!(
            !keys.contains(&"j/↓"),
            "must not advertise dead list-nav 'j'"
        );
        assert!(
            !keys.contains(&"k/↑"),
            "must not advertise dead list-nav 'k'"
        );
        assert!(
            keys.contains(&"y"),
            "must advertise the real confirm key 'y'"
        );
        assert!(
            keys.contains(&"n"),
            "must advertise the real reject key 'n'"
        );

        let y_binding = context.bindings.iter().find(|b| b.key == "y").unwrap();
        assert_eq!(y_binding.action, KeybindingAction::ConfirmPrefixCollision);
        let n_binding = context.bindings.iter().find(|b| b.key == "n").unwrap();
        assert_eq!(n_binding.action, KeybindingAction::RejectPrefixCollision);
        let esc_binding = context.bindings.iter().find(|b| b.key == "ESC").unwrap();
        assert_eq!(esc_binding.action, KeybindingAction::CancelPrefixCollision);
    }

    #[test]
    fn test_conflict_resolution_provider_advertises_real_keys_not_list_nav() {
        let context = ConflictResolutionProvider.get_context();
        let keys: Vec<&str> = context.bindings.iter().map(|b| b.key.as_str()).collect();
        assert!(
            !keys.contains(&"j/↓"),
            "must not advertise dead list-nav 'j'"
        );
        assert!(
            !keys.contains(&"k/↑"),
            "must not advertise dead list-nav 'k'"
        );
        assert!(
            !keys.contains(&"Enter/Space"),
            "must not advertise dead 'Enter' (nothing is selectable in this dialog)"
        );
        assert!(
            keys.contains(&"o"),
            "must advertise the real force-overwrite key 'o'"
        );
        assert!(
            keys.contains(&"t"),
            "must advertise the real take-theirs key 't'"
        );

        let o_binding = context.bindings.iter().find(|b| b.key == "o").unwrap();
        assert_eq!(o_binding.action, KeybindingAction::ForceOverwriteConflict);
        let t_binding = context.bindings.iter().find(|b| b.key == "t").unwrap();
        assert_eq!(t_binding.action, KeybindingAction::TakeTheirsConflict);
        let esc_binding = context.bindings.iter().find(|b| b.key == "ESC").unwrap();
        assert_eq!(
            esc_binding.action,
            KeybindingAction::CancelConflictResolution
        );
    }

    #[test]
    fn test_external_change_detected_provider_advertises_real_keys_not_list_nav() {
        let context = ExternalChangeDetectedProvider.get_context();
        let keys: Vec<&str> = context.bindings.iter().map(|b| b.key.as_str()).collect();
        assert!(
            !keys.contains(&"j/↓"),
            "must not advertise dead list-nav 'j'"
        );
        assert!(
            !keys.contains(&"Enter/Space"),
            "must not advertise dead 'Enter' (nothing is selectable in this dialog)"
        );
        assert!(
            keys.contains(&"r"),
            "must advertise the real reload key 'r'"
        );
        assert!(
            keys.contains(&"k"),
            "must advertise the real keep-local key 'k'"
        );

        let r_binding = context.bindings.iter().find(|b| b.key == "r").unwrap();
        assert_eq!(r_binding.action, KeybindingAction::ReloadDiscardLocal);
        let k_binding = context.bindings.iter().find(|b| b.key == "k").unwrap();
        assert_eq!(k_binding.action, KeybindingAction::KeepLocalChanges);
        assert!(
            k_binding.description.to_lowercase().contains("discard"),
            "'k' must be described as discarding the external write, not 'up': {}",
            k_binding.description
        );
        let esc_binding = context.bindings.iter().find(|b| b.key == "ESC").unwrap();
        assert_eq!(esc_binding.action, KeybindingAction::DismissExternalChange);
    }
}