git-pincer 0.1.3

A simple and efficient terminal Git conflict resolution CLI 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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
//! 界面整体绘制:状态栏、提示条、消息条、帮助浮层与二进制视图。

use crate::i18n::{tr, tr_f};
use ratatui::Frame;
use ratatui::layout::{Constraint, Layout, Rect};
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, BorderType, Clear, Paragraph};

use crate::app::{FileEntry, Session, Side};

use super::UiState;
use super::panes::draw_columns;
use super::theme::Theme;

/// 绘制整个界面(独立成 pub 函数,便于 TestBackend 冒烟测试)。
///
/// 需要可变会话:绘制时会把滚动位置写回当前文件,跨帧保持视口稳定;
/// 需要可变 UI 状态:高亮缓存按需构建。
pub fn draw(frame: &mut Frame, session: &mut Session, ui: &mut UiState) {
    let [header, body, hints, message] = Layout::vertical([
        Constraint::Length(1),
        Constraint::Min(0),
        Constraint::Length(1),
        Constraint::Length(1),
    ])
    .areas(frame.area());

    draw_header(frame, header, session, &ui.theme);
    let folded = session.folded;
    let file_idx = session.current;
    match session.current_file_mut() {
        FileEntry::Text(merge) => {
            let highlight = ui.cache.get(file_idx, merge, ui.revision, ui.theme.light);
            let rows = ui.rows.get(file_idx, merge, ui.revision, folded);
            draw_columns(
                frame,
                body,
                merge,
                &ui.theme,
                highlight,
                rows,
                &mut ui.scroll_request,
            );
        }
        FileEntry::Binary {
            path,
            ours,
            theirs,
            choice,
        } => draw_binary(frame, body, path, ours, theirs, *choice, &ui.theme),
    }
    // 二进制视图不消费滚动请求,统一清零避免残留到后续文本文件
    ui.scroll_request = 0;
    draw_hints(frame, hints, &ui.theme);
    frame.render_widget(
        Paragraph::new(ui.message.as_str()).style(Style::new().fg(ui.theme.amber)),
        message,
    );
    if ui.show_help {
        draw_help(frame, &ui.theme);
    }
}

/// 顶部状态条:操作徽章 · 进度条 · 文件路径 · 冲突计数。
fn draw_header(frame: &mut Frame, area: Rect, session: &Session, theme: &Theme) {
    let entry = session.current_file();
    let pending = match entry {
        FileEntry::Text(m) => m.pending_conflicts(),
        FileEntry::Binary { choice, .. } => usize::from(choice.is_none()),
    };
    let done = session.written.iter().filter(|&&w| w).count();
    let total = session.files.len();

    // █░ 进度条:已写盘文件数 / 总文件数
    const BAR_WIDTH: usize = 10;
    let filled = (done * BAR_WIDTH).checked_div(total).unwrap_or(0);
    let sep = Span::styled("", Style::new().fg(theme.border));

    let mut spans = vec![
        Span::styled(
            format!("{} ", session.op_label.to_uppercase()),
            Style::new()
                .fg(theme.badge_fg)
                .bg(theme.blue)
                .add_modifier(Modifier::BOLD),
        ),
        Span::raw(" "),
        Span::styled("".repeat(filled), Style::new().fg(theme.blue)),
        Span::styled(
            "".repeat(BAR_WIDTH - filled),
            Style::new().fg(theme.border),
        ),
        Span::styled(
            format!(
                " {} ",
                tr_f(
                    "ui.files_badge",
                    &[
                        ("i", &(session.current + 1).to_string()),
                        ("n", &total.to_string()),
                    ],
                )
            ),
            Style::new().fg(theme.fg_bright),
        ),
        sep.clone(),
        Span::raw(format!(" {} ", entry.path())),
        sep,
    ];
    if pending > 0 {
        spans.push(Span::styled(
            format!(
                " {}",
                tr_f("ui.conflicts_pending", &[("n", &pending.to_string())])
            ),
            Style::new().fg(theme.red).add_modifier(Modifier::BOLD),
        ));
    } else {
        spans.push(Span::styled(
            format!(" {}", tr("ui.file_ready")),
            Style::new().fg(theme.green),
        ));
    }
    frame.render_widget(Paragraph::new(Line::from(spans)), area);
}

/// 二进制文件的降级视图:LOCAL / REMOTE 两张卡片整文件二选一。
fn draw_binary(
    frame: &mut Frame,
    area: Rect,
    path: &str,
    ours: &[u8],
    theirs: &[u8],
    choice: Option<Side>,
    theme: &Theme,
) {
    let panel = centered_rect(area, 64, 11);
    let [notice, _, cards, _, hint] = Layout::vertical([
        Constraint::Length(2),
        Constraint::Length(1),
        Constraint::Length(5),
        Constraint::Length(1),
        Constraint::Length(1),
    ])
    .areas(panel);

    frame.render_widget(
        Paragraph::new(vec![
            Line::styled(path.to_owned(), Style::new().add_modifier(Modifier::BOLD)).centered(),
            Line::styled(tr("ui.binary_notice"), Style::new().fg(theme.amber)).centered(),
        ]),
        notice,
    );

    let [left, _, right] = Layout::horizontal([
        Constraint::Fill(1),
        Constraint::Length(2),
        Constraint::Fill(1),
    ])
    .areas(cards);
    binary_card(
        frame,
        left,
        " LOCAL ",
        "h",
        ours,
        choice == Some(Side::Ours),
        theme,
    );
    binary_card(
        frame,
        right,
        " REMOTE ",
        "l",
        theirs,
        choice == Some(Side::Theirs),
        theme,
    );

    frame.render_widget(
        Paragraph::new(Line::styled(
            tr("ui.binary_keys"),
            Style::new().fg(theme.fg_dim),
        ))
        .centered(),
        hint,
    );
}

/// 单张二进制候选卡片:选中侧边框换绿色并在标题加 ✓。
fn binary_card(
    frame: &mut Frame,
    area: Rect,
    title: &str,
    key: &str,
    bytes: &[u8],
    selected: bool,
    theme: &Theme,
) {
    let (border, title_text) = if selected {
        (theme.green, format!("{title}"))
    } else {
        (theme.border, title.to_owned())
    };
    let block = Block::bordered()
        .border_type(BorderType::Rounded)
        .border_style(Style::new().fg(border))
        .title(Span::styled(
            title_text,
            Style::new()
                .fg(theme.fg_bright)
                .add_modifier(Modifier::BOLD),
        ));
    let inner = block.inner(area);
    frame.render_widget(block, area);
    frame.render_widget(
        Paragraph::new(vec![
            Line::styled(
                tr_f("ui.bytes", &[("n", &bytes.len().to_string())]),
                Style::new().fg(theme.fg_bright),
            )
            .centered(),
            Line::styled(
                tr_f("ui.press_pick", &[("key", key)]),
                Style::new().fg(theme.fg_dim),
            )
            .centered(),
        ]),
        inner,
    );
}

/// 键帽样式的按键 Span(底色微凸起)。
fn keycap(key: &str, theme: &Theme) -> Span<'static> {
    Span::styled(
        format!(" {key} "),
        Style::new().fg(theme.keycap_fg).bg(theme.keycap_bg),
    )
}

/// 底部按键提示条(键帽 + 描述),条目来自 [`keymap`](super::keymap) 单一绑定表。
fn draw_hints(frame: &mut Frame, area: Rect, theme: &Theme) {
    let mut spans = vec![Span::raw(" ")];
    for (key, desc) in super::keymap::hint_entries() {
        spans.push(keycap(key, theme));
        spans.push(Span::styled(
            format!(" {}  ", tr(desc)),
            Style::new().fg(theme.hint_fg),
        ));
    }
    frame.render_widget(Paragraph::new(Line::from(spans)), area);
}

/// 帮助浮层:圆角边框 + 双栏按键布局,条目来自 [`keymap`](super::keymap) 单一绑定表。
fn draw_help(frame: &mut Frame, theme: &Theme) {
    let (left_items, right_items) = super::keymap::help_columns();
    let column = |entries: &[(&'static str, &'static str)]| -> Vec<Line<'static>> {
        entries
            .iter()
            .map(|(key, desc)| {
                Line::from(vec![
                    Span::styled(
                        format!(" {key:<7}"),
                        Style::new().fg(theme.blue).add_modifier(Modifier::BOLD),
                    ),
                    Span::raw(tr(desc).to_owned()),
                ])
            })
            .collect()
    };

    // 高度按最长一栏自适应(上下边框各占一行)
    let overlay_h = left_items.len().max(right_items.len()) as u16 + 2;
    let area = centered_rect(frame.area(), 78, overlay_h);
    frame.render_widget(Clear, area);
    let block = Block::bordered()
        .border_type(BorderType::Rounded)
        .border_style(Style::new().fg(theme.border))
        .title(Span::styled(
            format!(" {} ", tr("ui.help_title")),
            Style::new()
                .fg(theme.fg_bright)
                .add_modifier(Modifier::BOLD),
        ))
        .title_bottom(
            Line::from(Span::styled(
                format!(" {} ", tr("common.close_any_key")),
                Style::new().fg(theme.fg_dim),
            ))
            .centered(),
        );
    let inner = block.inner(area);
    frame.render_widget(block, area);
    let [left, right] =
        Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)]).areas(inner);
    frame.render_widget(Paragraph::new(column(&left_items)), left);
    frame.render_widget(Paragraph::new(column(&right_items)), right);
}

/// 居中的浮层矩形(不超出屏幕)。
fn centered_rect(area: Rect, width: u16, height: u16) -> Rect {
    let w = width.min(area.width);
    let h = height.min(area.height);
    Rect {
        x: area.x + (area.width - w) / 2,
        y: area.y + (area.height - h) / 2,
        width: w,
        height: h,
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::app::FileMerge;
    use crate::ui::rows::build_rows;
    use ratatui::Terminal;
    use ratatui::backend::TestBackend;

    /// 用 TestBackend 渲染一帧,断言关键内容存在且不 panic
    #[test]
    fn draw_smoke_renders_key_elements() {
        let merge =
            FileMerge::from_three_way("demo.txt".to_owned(), "a\nb\nc\n", "a\nX\nc\n", "a\nY\nc\n");
        let mut session = Session::new(vec![FileEntry::Text(merge)], "merge".to_owned());
        let mut ui = UiState::default();

        let backend = TestBackend::new(120, 24);
        let mut terminal = Terminal::new(backend).unwrap();
        terminal
            .draw(|frame| draw(frame, &mut session, &mut ui))
            .unwrap();

        let content = format!("{:?}", terminal.backend().buffer());
        assert!(content.contains("demo.txt"));
        // 状态栏操作徽章与进度条
        assert!(content.contains("MERGE"));
        assert!(content.contains(""));
        // 圆角边框面板与嵌入边框的栏头
        assert!(content.contains(""));
        assert!(content.contains("LOCAL"));
        assert!(content.contains("RESULT"));
        assert!(content.contains("REMOTE"));
        // 未解决冲突:结果栏占位带 + 两侧 gutter 取用箭头
        assert!(content.contains("pending"));
        assert!(content.contains("»"));
        assert!(content.contains("«"));
    }

    /// 窄终端(60 列)渲染不 panic,预算逐级降级
    #[test]
    fn draw_narrow_terminal_smoke() {
        let merge =
            FileMerge::from_three_way("demo.txt".to_owned(), "a\nb\nc\n", "a\nX\nc\n", "a\nY\nc\n");
        let mut session = Session::new(vec![FileEntry::Text(merge)], "merge".to_owned());
        let mut ui = UiState::default();
        for width in [60u16, 30, 12] {
            let backend = TestBackend::new(width, 16);
            let mut terminal = Terminal::new(backend).unwrap();
            terminal
                .draw(|frame| draw(frame, &mut session, &mut ui))
                .unwrap();
        }
    }

    /// 回归:跳转冲突后选中块应留在视口内且不贴底(依赖 scroll 跨帧持久化)
    #[test]
    fn scroll_keeps_selected_chunk_in_view() {
        // 三个冲突,彼此隔着 40 行稳定区;展开渲染保证行数远超视口
        let stable: String = (1..=40).map(|i| format!("s{i}\n")).collect();
        let base = format!("a\n{stable}b\n{stable}c\n");
        let ours = format!("A\n{stable}B\n{stable}C\n");
        let theirs = format!("X\n{stable}Y\n{stable}Z\n");
        let merge = FileMerge::from_three_way("demo.txt".to_owned(), &base, &ours, &theirs);
        let mut session = Session::new(vec![FileEntry::Text(merge)], "merge".to_owned());
        session.folded = false;
        let mut ui = UiState::default();
        let backend = TestBackend::new(100, 24);
        let mut terminal = Terminal::new(backend).unwrap();
        // 视口正文高度 = 24 - 状态条/提示/消息各 1 行 - 上下边框 2 行
        let body_height = 19usize;

        // 跳到最后一个冲突,再跳回中间的冲突
        terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        for step in ["next", "next", "prev"] {
            let FileEntry::Text(m) = session.current_file_mut() else {
                unreachable!()
            };
            if step == "next" {
                m.next_conflict();
            } else {
                m.prev_conflict();
            }
            terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        }

        let FileEntry::Text(m) = session.current_file() else {
            unreachable!()
        };
        let (_, starts) = build_rows(m, false);
        let target = starts[m.cursor];
        assert!(target >= m.scroll, "选中块滚出了视口上方");
        assert!(target < m.scroll + body_height, "选中块滚出了视口下方");
        // 不贴底:块首行下方至少还能看到两行块内容
        assert!(
            target + 2 < m.scroll + body_height,
            "选中块贴在视口底部(target={target}, scroll={})",
            m.scroll
        );
    }

    /// 手动滚动脱离光标跟随且重绘不回拉;作用于光标的动作重新吸附
    #[test]
    fn manual_scroll_detaches_and_actions_reattach() {
        let stable: String = (1..=200).map(|i| format!("s{i}\n")).collect();
        let base = format!("a\n{stable}");
        let ours = format!("A\n{stable}");
        let theirs = format!("X\n{stable}");
        let merge = FileMerge::from_three_way("demo.txt".to_owned(), &base, &ours, &theirs);
        let mut session = Session::new(vec![FileEntry::Text(merge)], "merge".to_owned());
        session.folded = false;
        let mut ui = UiState::default();
        let mut terminal = Terminal::new(TestBackend::new(100, 24)).unwrap();
        let scroll_of = |s: &Session| match s.current_file() {
            FileEntry::Text(m) => (m.scroll, m.follow),
            FileEntry::Binary { .. } => unreachable!(),
        };

        terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        assert_eq!(scroll_of(&session), (0, true));

        // 两次半页下滚:请求被消费,视口前进并脱离跟随
        ui.scroll_request = 2;
        terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        let (scrolled, follow) = scroll_of(&session);
        assert!(scrolled > 0);
        assert!(!follow);
        assert_eq!(ui.scroll_request, 0);

        // 光标块已在视口外,重绘不得回拉(脱离跟随的意义所在)
        terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        assert_eq!(scroll_of(&session), (scrolled, false));

        // 作用于光标的动作(如跳冲突)恢复跟随,视口吸附回光标块
        super::super::handle_file_key(
            &mut session,
            super::super::keymap::Action::NextConflict,
            &mut ui,
        );
        terminal.draw(|f| draw(f, &mut session, &mut ui)).unwrap();
        let (snapped, follow) = scroll_of(&session);
        assert!(follow);
        assert!(snapped < scrolled, "视口应吸附回顶部的冲突块");
    }

    /// 二进制条目渲染不 panic
    #[test]
    fn draw_binary_entry_smoke() {
        let mut session = Session::new(
            vec![FileEntry::Binary {
                path: "logo.png".to_owned(),
                ours: vec![0, 1],
                theirs: vec![2, 3],
                choice: None,
            }],
            "merge".to_owned(),
        );
        let backend = TestBackend::new(100, 20);
        let mut terminal = Terminal::new(backend).unwrap();
        terminal
            .draw(|frame| draw(frame, &mut session, &mut UiState::default()))
            .unwrap();
        let content = format!("{:?}", terminal.backend().buffer());
        assert!(content.contains("logo.png"));
    }
}