aven 0.1.16

Local-first task manager CLI and sync server
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

use ratatui::Frame;
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span, Text};

use ratatui::widgets::Paragraph;

use super::super::dialog::{Dialog, dialog_hint_line};
use crate::tui::theme::{ACCENT, BG_ALT, FG, FG_MUTED};

const ONBOARDING_WIDTH: u16 = 66;
const ONBOARDING_HEIGHT: u16 = 16;

pub(in crate::tui::ui) fn render_onboarding(frame: &mut Frame) {
    render_onboarding_raised(frame, 1.0);
}

pub(in crate::tui::ui) fn render_onboarding_raised(frame: &mut Frame, reveal: f32) {
    if reveal <= 0.0 {
        return;
    }
    let dialog = Dialog::new("Welcome to aven", ONBOARDING_WIDTH, ONBOARDING_HEIGHT);
    let mut area = dialog.area(frame);
    area.y = area
        .y
        .saturating_add(((1.0 - reveal.clamp(0.0, 1.0)) * 2.0).round() as u16);
    let inner = dialog.render_block_at(frame, area);
    frame.render_widget(
        Paragraph::new(Text::from(onboarding_lines())).style(Style::new().fg(FG).bg(BG_ALT)),
        inner,
    );
}

fn onboarding_lines() -> Vec<Line<'static>> {
    vec![
        Line::from(Span::styled(
            "Local-first tasks for power users and coding agents.",
            Style::new().fg(FG_MUTED),
        )),
        Line::default(),
        section_heading("Everyday keys"),
        shortcut_line("a", "Add a task and capture what's on your mind"),
        shortcut_line("Enter", "Open the selected task and see its details"),
        shortcut_line("s / d", "Change status or mark the selected task done"),
        shortcut_line("u", "Undo the last change"),
        shortcut_line(":", "Open the command panel"),
        Line::default(),
        section_heading("Learn more"),
        resource_line("TUI guide", "https://aven.raine.dev/tui/"),
        resource_line("Agents guide", "https://aven.raine.dev/agents/"),
        Line::default(),
        dialog_hint_line(&[
            ("a", "create first task"),
            ("?", "shortcuts"),
            ("Enter", "explore"),
        ]),
    ]
}

fn section_heading(title: &'static str) -> Line<'static> {
    Line::from(Span::styled(
        title,
        Style::new().fg(ACCENT).add_modifier(Modifier::BOLD),
    ))
}

fn resource_line(label: &'static str, value: &'static str) -> Line<'static> {
    Line::from(vec![
        Span::styled(
            format!("  {label:<13}"),
            Style::new().fg(FG).add_modifier(Modifier::BOLD),
        ),
        Span::styled(value, Style::new().fg(FG_MUTED)),
    ])
}

fn shortcut_line(key: &'static str, label: &'static str) -> Line<'static> {
    Line::from(vec![
        Span::styled(
            format!("  {key:<7}"),
            Style::new().fg(FG).add_modifier(Modifier::BOLD),
        ),
        Span::styled(label, Style::new().fg(FG_MUTED)),
    ])
}

#[cfg(test)]
pub(in crate::tui::ui) fn onboarding_lines_for_test() -> Vec<Line<'static>> {
    onboarding_lines()
}

#[cfg(test)]
mod tests {
    use super::*;
    use ratatui::Terminal;
    use ratatui::backend::TestBackend;

    #[test]
    fn completed_entrance_matches_stable_dialog() {
        let mut stable = Terminal::new(TestBackend::new(100, 30)).unwrap();
        stable.draw(render_onboarding).unwrap();
        let stable_buffer = stable.backend().buffer().clone();

        let mut animated = Terminal::new(TestBackend::new(100, 30)).unwrap();
        animated
            .draw(|frame| render_onboarding_raised(frame, 1.0))
            .unwrap();

        assert_eq!(animated.backend().buffer(), &stable_buffer);
    }
}