octorus 0.6.2

A TUI tool for GitHub PR review, designed for Helix editor users
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
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

use crate::keybinding::{KeyBinding, KeySequence, NamedKey};

/// Configurable keybindings
///
/// Supports three formats in TOML:
/// - Simple string: `move_down = "j"`
/// - Object with modifiers: `page_down = { key = "d", ctrl = true }`
/// - Array for sequences: `jump_to_first = ["g", "g"]`
#[derive(Debug, Clone, Deserialize)]
#[serde(default)]
pub struct KeybindingsConfig {
    pub move_down: KeySequence,
    pub move_up: KeySequence,
    pub move_left: KeySequence,
    pub move_right: KeySequence,
    pub page_down: KeySequence,
    pub page_up: KeySequence,
    pub jump_to_first: KeySequence,
    pub jump_to_last: KeySequence,
    pub jump_back: KeySequence,
    pub next_comment: KeySequence,
    pub prev_comment: KeySequence,

    pub approve: KeySequence,
    pub request_changes: KeySequence,
    pub comment: KeySequence,
    pub suggestion: KeySequence,
    pub reply: KeySequence,
    pub refresh: KeySequence,
    pub submit: KeySequence,

    pub quit: KeySequence,
    pub help: KeySequence,
    pub comment_list: KeySequence,
    pub ai_rally: KeySequence,
    pub open_panel: KeySequence,

    pub go_to_definition: KeySequence,
    pub go_to_file: KeySequence,
    pub open_in_browser: KeySequence,

    pub toggle_local_mode: KeySequence,
    pub toggle_auto_focus: KeySequence,

    pub toggle_zen_mode: KeySequence,
    pub toggle_markdown_rich: KeySequence,
    pub filter: KeySequence,
    pub multiline_select: KeySequence,
    pub pr_description: KeySequence,
    pub ci_checks: KeySequence,
    pub git_ops: KeySequence,
    pub git_ops_stage: KeySequence,
    pub git_ops_stage_all: KeySequence,
    pub git_ops_discard: KeySequence,
    pub git_ops_commit: KeySequence,
    pub git_ops_undo: KeySequence,
    pub git_ops_reset: KeySequence,
    pub git_ops_push: KeySequence,

    pub issue_list: KeySequence,
    pub tab_switch: KeySequence,
    pub mark_viewed: KeySequence,
    pub mark_viewed_dir: KeySequence,

    pub tree_toggle: KeySequence,
    pub shell_command: KeySequence,

    pub filter_open: KeySequence,
    pub filter_closed: KeySequence,
    pub filter_all: KeySequence,
    pub tab_prev: KeySequence,
    pub tab_next: KeySequence,
    pub rally_background: KeySequence,
    pub rally_pause: KeySequence,
    pub retry: KeySequence,
    pub confirm_yes: KeySequence,
    pub confirm_no: KeySequence,
}

impl Default for KeybindingsConfig {
    fn default() -> Self {
        Self {
            move_down: KeySequence::single(KeyBinding::char('j'))
                .with_alt(vec![KeyBinding::named(crate::keybinding::NamedKey::Down)]),
            move_up: KeySequence::single(KeyBinding::char('k'))
                .with_alt(vec![KeyBinding::named(crate::keybinding::NamedKey::Up)]),
            move_left: KeySequence::single(KeyBinding::char('h'))
                .with_alt(vec![KeyBinding::named(crate::keybinding::NamedKey::Left)]),
            move_right: KeySequence::single(KeyBinding::char('l'))
                .with_alt(vec![KeyBinding::named(crate::keybinding::NamedKey::Right)]),
            page_down: KeySequence::single(KeyBinding::ctrl('d')),
            page_up: KeySequence::single(KeyBinding::ctrl('u')),
            jump_to_first: KeySequence::double(KeyBinding::char('g'), KeyBinding::char('g')),
            jump_to_last: KeySequence::single(KeyBinding::char('G')),
            jump_back: KeySequence::single(KeyBinding::ctrl('o')),
            next_comment: KeySequence::single(KeyBinding::char('n')),
            prev_comment: KeySequence::single(KeyBinding::char('N')),

            approve: KeySequence::single(KeyBinding::char('a')),
            request_changes: KeySequence::single(KeyBinding::char('r')),
            comment: KeySequence::single(KeyBinding::char('c')),
            suggestion: KeySequence::single(KeyBinding::char('s')),
            reply: KeySequence::single(KeyBinding::char('r')),
            refresh: KeySequence::single(KeyBinding::char('R')),
            submit: KeySequence::single(KeyBinding::ctrl('s')),

            quit: KeySequence::single(KeyBinding::char('q'))
                .with_alt(vec![KeyBinding::named(crate::keybinding::NamedKey::Esc)]),
            help: KeySequence::single(KeyBinding::char('?')),
            comment_list: KeySequence::single(KeyBinding::char('C')),
            ai_rally: KeySequence::single(KeyBinding::char('A')),
            open_panel: KeySequence::single(KeyBinding::named(NamedKey::Enter)),

            go_to_definition: KeySequence::double(KeyBinding::char('g'), KeyBinding::char('d')),
            go_to_file: KeySequence::double(KeyBinding::char('g'), KeyBinding::char('f')),
            open_in_browser: KeySequence::single(KeyBinding::char('O')),

            toggle_local_mode: KeySequence::single(KeyBinding::char('L')),
            toggle_auto_focus: KeySequence::single(KeyBinding::char('F')),

            toggle_zen_mode: KeySequence::single(KeyBinding::char('Z')),
            toggle_markdown_rich: KeySequence::single(KeyBinding::char('M')),
            filter: KeySequence::double(KeyBinding::char(' '), KeyBinding::char('/')),
            multiline_select: KeySequence::single(KeyBinding::char('V')),
            pr_description: KeySequence::single(KeyBinding::char('d')),
            ci_checks: KeySequence::single(KeyBinding::char('S')),
            git_ops: KeySequence::single(KeyBinding::char('G')),
            git_ops_stage: KeySequence::single(KeyBinding::char(' ')),
            git_ops_stage_all: KeySequence::single(KeyBinding::char('s')),
            git_ops_discard: KeySequence::single(KeyBinding::char('d')),
            git_ops_commit: KeySequence::single(KeyBinding::char('c')),
            git_ops_undo: KeySequence::single(KeyBinding::char('u')),
            git_ops_reset: KeySequence::single(KeyBinding::char('r')),
            git_ops_push: KeySequence::single(KeyBinding::char('P')),

            issue_list: KeySequence::single(KeyBinding::char('I')),
            tab_switch: KeySequence::single(KeyBinding::named(crate::keybinding::NamedKey::Tab)),
            mark_viewed: KeySequence::single(KeyBinding::char('v')),
            mark_viewed_dir: KeySequence::single(KeyBinding::char('V')),
            tree_toggle: KeySequence::single(KeyBinding::char('t')),
            shell_command: KeySequence::single(KeyBinding::char('!')),

            filter_open: KeySequence::single(KeyBinding::char('o')),
            filter_closed: KeySequence::single(KeyBinding::char('c')),
            filter_all: KeySequence::single(KeyBinding::char('a')),
            tab_prev: KeySequence::single(KeyBinding::char('[')),
            tab_next: KeySequence::single(KeyBinding::char(']')),
            rally_background: KeySequence::single(KeyBinding::char('b')),
            rally_pause: KeySequence::single(KeyBinding::char('p')),
            retry: KeySequence::single(KeyBinding::char('r')),
            confirm_yes: KeySequence::single(KeyBinding::char('y'))
                .with_alt(vec![KeyBinding::char('Y')]),
            confirm_no: KeySequence::single(KeyBinding::char('n'))
                .with_alt(vec![KeyBinding::char('N')]),
        }
    }
}

impl KeybindingsConfig {
    /// Validate keybindings for conflicts
    ///
    /// Detects:
    /// - Single keys that conflict with sequence prefixes
    /// - Duplicate keybindings for different actions
    pub fn validate(&self) -> Result<(), Vec<String>> {
        let mut errors = Vec::new();
        let mut single_keys: HashMap<KeyBinding, &str> = HashMap::new();
        let mut sequence_prefixes: HashMap<KeyBinding, &str> = HashMap::new();

        let bindings: Vec<(&str, &KeySequence)> = vec![
            ("move_down", &self.move_down),
            ("move_up", &self.move_up),
            ("move_left", &self.move_left),
            ("move_right", &self.move_right),
            ("page_down", &self.page_down),
            ("page_up", &self.page_up),
            ("jump_to_first", &self.jump_to_first),
            ("jump_to_last", &self.jump_to_last),
            ("jump_back", &self.jump_back),
            ("next_comment", &self.next_comment),
            ("prev_comment", &self.prev_comment),
            ("approve", &self.approve),
            ("request_changes", &self.request_changes),
            ("comment", &self.comment),
            ("suggestion", &self.suggestion),
            ("reply", &self.reply),
            ("refresh", &self.refresh),
            ("submit", &self.submit),
            ("quit", &self.quit),
            ("help", &self.help),
            ("comment_list", &self.comment_list),
            ("ai_rally", &self.ai_rally),
            ("open_panel", &self.open_panel),
            ("go_to_definition", &self.go_to_definition),
            ("go_to_file", &self.go_to_file),
            ("open_in_browser", &self.open_in_browser),
            ("toggle_local_mode", &self.toggle_local_mode),
            ("toggle_auto_focus", &self.toggle_auto_focus),
            ("toggle_zen_mode", &self.toggle_zen_mode),
            ("toggle_markdown_rich", &self.toggle_markdown_rich),
            ("filter", &self.filter),
            ("multiline_select", &self.multiline_select),
            ("pr_description", &self.pr_description),
            ("ci_checks", &self.ci_checks),
            ("git_ops", &self.git_ops),
            ("git_ops_stage", &self.git_ops_stage),
            ("git_ops_stage_all", &self.git_ops_stage_all),
            ("git_ops_discard", &self.git_ops_discard),
            ("git_ops_commit", &self.git_ops_commit),
            ("git_ops_undo", &self.git_ops_undo),
            ("git_ops_reset", &self.git_ops_reset),
            ("git_ops_push", &self.git_ops_push),
            ("issue_list", &self.issue_list),
            ("tab_switch", &self.tab_switch),
            ("mark_viewed", &self.mark_viewed),
            ("mark_viewed_dir", &self.mark_viewed_dir),
            ("tree_toggle", &self.tree_toggle),
            ("shell_command", &self.shell_command),
            ("filter_open", &self.filter_open),
            ("filter_closed", &self.filter_closed),
            ("filter_all", &self.filter_all),
            ("tab_prev", &self.tab_prev),
            ("tab_next", &self.tab_next),
            ("rally_background", &self.rally_background),
            ("rally_pause", &self.rally_pause),
            ("retry", &self.retry),
            ("confirm_yes", &self.confirm_yes),
            ("confirm_no", &self.confirm_no),
        ];

        for (name, seq) in &bindings {
            if seq.keys.is_empty() {
                errors.push(format!("keybinding '{}' is empty", name));
                continue;
            }

            if seq.is_single() {
                let key = seq.keys[0];
                if let Some(existing) = single_keys.get(&key) {
                    // Allow same key for different contexts (e.g., 'r' for reply and request_changes)
                    // This is intentional - context determines which action is triggered
                    if !is_context_compatible(name, existing) {
                        errors.push(format!(
                            "duplicate keybinding: '{}' and '{}' both use {}",
                            name,
                            existing,
                            key.display()
                        ));
                    }
                } else {
                    single_keys.insert(key, name);
                }
            } else {
                // For sequences, track the first key as a prefix
                if let Some(first) = seq.first() {
                    sequence_prefixes.insert(*first, name);
                }
            }
        }

        // Check for conflicts between single keys and sequence prefixes
        for (key, single_name) in &single_keys {
            if let Some(seq_name) = sequence_prefixes.get(key) {
                // Only warn if they're in the same context
                if !is_context_compatible(single_name, seq_name) {
                    errors.push(format!(
                        "keybinding conflict: '{}' ({}) conflicts with sequence prefix for '{}' ({})",
                        single_name,
                        key.display(),
                        seq_name,
                        key.display()
                    ));
                }
            }
        }

        if errors.is_empty() {
            Ok(())
        } else {
            Err(errors)
        }
    }
}

/// Check if two keybindings are in compatible contexts
/// (i.e., they won't conflict because they're used in different views)
fn is_context_compatible(name1: &str, name2: &str) -> bool {
    // These keybindings are used in different contexts:
    // - 'r' is used for 'reply' in comment panel and 'request_changes' in file list
    //
    // NOTE: 'comment' and 'suggestion' are NOT compatible - both are active in diff view
    // and comment panel contexts, so they must have different bindings.
    // 特定画面でのみ有効なキー(他の全キーと context compatible)
    const SCREEN_SPECIFIC_KEYS: &[&str] = &[
        "git_ops_stage",
        "git_ops_stage_all",
        "git_ops_discard",
        "git_ops_commit",
        "git_ops_undo",
        "git_ops_reset",
        "git_ops_push",
        "tab_switch",
        "mark_viewed",
        "mark_viewed_dir",
        "tree_toggle",
        "shell_command",
        "filter_open",
        "filter_closed",
        "filter_all",
        "tab_prev",
        "tab_next",
        "rally_background",
        "rally_pause",
        "retry",
        "confirm_yes",
        "confirm_no",
    ];

    let context_groups: &[&[&str]] = &[
        &["reply", "request_changes"],
        &["toggle_local_mode", "move_right"], // L vs l: different cases
        &["toggle_auto_focus", "go_to_file"], // F vs gf: different sequence lengths
        &["git_ops", "jump_to_last"],         // G: git ops in file list, jump_to_last in diff/other views
        &["filter_closed", "comment"],
        &["filter_all", "approve"],
        &["retry", "reply", "request_changes"],
        &["confirm_no", "next_comment"],
    ];

    // git ops 固有キーは git ops 画面でのみ有効なので、他の全キーと context compatible
    if SCREEN_SPECIFIC_KEYS.contains(&name1) || SCREEN_SPECIFIC_KEYS.contains(&name2) {
        return true;
    }

    for group in context_groups {
        if group.contains(&name1) && group.contains(&name2) {
            return true;
        }
    }

    false
}

// Custom Serialize for KeybindingsConfig to maintain backwards compatibility
impl Serialize for KeybindingsConfig {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        use serde::ser::SerializeMap;

        // For serialization, we output a simplified format
        let mut map = serializer.serialize_map(None)?;

        // Helper to serialize a KeySequence
        fn seq_to_value(seq: &KeySequence) -> toml::Value {
            if seq.is_single() && seq.alt.is_empty() {
                toml::Value::String(seq.display())
            } else if seq.alt.is_empty() {
                toml::Value::Array(
                    seq.keys
                        .iter()
                        .map(|k| toml::Value::String(k.display()))
                        .collect(),
                )
            } else {
                // primary | alt1 | alt2 ...
                toml::Value::String(seq.display())
            }
        }

        map.serialize_entry("move_down", &seq_to_value(&self.move_down))?;
        map.serialize_entry("move_up", &seq_to_value(&self.move_up))?;
        map.serialize_entry("move_left", &seq_to_value(&self.move_left))?;
        map.serialize_entry("move_right", &seq_to_value(&self.move_right))?;
        map.serialize_entry("page_down", &seq_to_value(&self.page_down))?;
        map.serialize_entry("page_up", &seq_to_value(&self.page_up))?;
        map.serialize_entry("jump_to_first", &seq_to_value(&self.jump_to_first))?;
        map.serialize_entry("jump_to_last", &seq_to_value(&self.jump_to_last))?;
        map.serialize_entry("jump_back", &seq_to_value(&self.jump_back))?;
        map.serialize_entry("next_comment", &seq_to_value(&self.next_comment))?;
        map.serialize_entry("prev_comment", &seq_to_value(&self.prev_comment))?;
        map.serialize_entry("approve", &seq_to_value(&self.approve))?;
        map.serialize_entry("request_changes", &seq_to_value(&self.request_changes))?;
        map.serialize_entry("comment", &seq_to_value(&self.comment))?;
        map.serialize_entry("suggestion", &seq_to_value(&self.suggestion))?;
        map.serialize_entry("reply", &seq_to_value(&self.reply))?;
        map.serialize_entry("refresh", &seq_to_value(&self.refresh))?;
        map.serialize_entry("submit", &seq_to_value(&self.submit))?;
        map.serialize_entry("quit", &seq_to_value(&self.quit))?;
        map.serialize_entry("help", &seq_to_value(&self.help))?;
        map.serialize_entry("comment_list", &seq_to_value(&self.comment_list))?;
        map.serialize_entry("ai_rally", &seq_to_value(&self.ai_rally))?;
        map.serialize_entry("open_panel", &seq_to_value(&self.open_panel))?;
        map.serialize_entry("go_to_definition", &seq_to_value(&self.go_to_definition))?;
        map.serialize_entry("go_to_file", &seq_to_value(&self.go_to_file))?;
        map.serialize_entry("open_in_browser", &seq_to_value(&self.open_in_browser))?;
        map.serialize_entry("toggle_local_mode", &seq_to_value(&self.toggle_local_mode))?;
        map.serialize_entry("toggle_auto_focus", &seq_to_value(&self.toggle_auto_focus))?;
        map.serialize_entry("toggle_zen_mode", &seq_to_value(&self.toggle_zen_mode))?;
        map.serialize_entry(
            "toggle_markdown_rich",
            &seq_to_value(&self.toggle_markdown_rich),
        )?;
        map.serialize_entry("filter", &seq_to_value(&self.filter))?;
        map.serialize_entry("multiline_select", &seq_to_value(&self.multiline_select))?;
        map.serialize_entry("pr_description", &seq_to_value(&self.pr_description))?;
        map.serialize_entry("ci_checks", &seq_to_value(&self.ci_checks))?;
        map.serialize_entry("git_ops", &seq_to_value(&self.git_ops))?;
        map.serialize_entry("git_ops_stage", &seq_to_value(&self.git_ops_stage))?;
        map.serialize_entry("git_ops_stage_all", &seq_to_value(&self.git_ops_stage_all))?;
        map.serialize_entry("git_ops_discard", &seq_to_value(&self.git_ops_discard))?;
        map.serialize_entry("git_ops_commit", &seq_to_value(&self.git_ops_commit))?;
        map.serialize_entry("git_ops_undo", &seq_to_value(&self.git_ops_undo))?;
        map.serialize_entry("git_ops_reset", &seq_to_value(&self.git_ops_reset))?;
        map.serialize_entry("git_ops_push", &seq_to_value(&self.git_ops_push))?;
        map.serialize_entry("issue_list", &seq_to_value(&self.issue_list))?;
        map.serialize_entry("tab_switch", &seq_to_value(&self.tab_switch))?;
        map.serialize_entry("mark_viewed", &seq_to_value(&self.mark_viewed))?;
        map.serialize_entry("mark_viewed_dir", &seq_to_value(&self.mark_viewed_dir))?;
        map.serialize_entry("tree_toggle", &seq_to_value(&self.tree_toggle))?;
        map.serialize_entry("shell_command", &seq_to_value(&self.shell_command))?;
        map.serialize_entry("filter_open", &seq_to_value(&self.filter_open))?;
        map.serialize_entry("filter_closed", &seq_to_value(&self.filter_closed))?;
        map.serialize_entry("filter_all", &seq_to_value(&self.filter_all))?;
        map.serialize_entry("tab_prev", &seq_to_value(&self.tab_prev))?;
        map.serialize_entry("tab_next", &seq_to_value(&self.tab_next))?;
        map.serialize_entry("rally_background", &seq_to_value(&self.rally_background))?;
        map.serialize_entry("rally_pause", &seq_to_value(&self.rally_pause))?;
        map.serialize_entry("retry", &seq_to_value(&self.retry))?;
        map.serialize_entry("confirm_yes", &seq_to_value(&self.confirm_yes))?;
        map.serialize_entry("confirm_no", &seq_to_value(&self.confirm_no))?;

        map.end()
    }
}