cli-tutor 0.1.0

Interactive terminal app for learning Unix command-line tools
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

use crate::app::{App, ContentView};
use crate::ui::{command_list, content_pane, help_overlay};
use ratatui::{
    layout::{Constraint, Direction, Layout, Rect},
    style::{Color, Modifier, Style},
    text::{Line, Span},
    widgets::{Block, Borders, Paragraph},
    Frame,
};

// content_display.LAYOUT.1-5
pub fn render(app: &App, frame: &mut Frame) {
    let area = frame.area();

    // content_display.LAYOUT.4 — enforce minimum terminal size
    if area.width < 80 || area.height < 24 {
        render_resize_prompt(frame, area);
        return;
    }

    let rows = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Length(1), // header
            Constraint::Min(0),    // main content
            Constraint::Length(1), // footer
        ])
        .split(area);

    render_header(app, frame, rows[0]);
    render_main(app, frame, rows[1]);
    render_footer(app, frame, rows[2]);

    if app.show_help {
        help_overlay::render(app, frame, area);
    }
}

fn render_header(app: &App, frame: &mut Frame, area: Rect) {
    // content_display.LAYOUT.2
    let module = app.current_module();
    let ex_count = app.exercise_count();
    let progress_text = if ex_count > 0 {
        let completed = app
            .module_progress()
            .map(|p| p.completed.len())
            .unwrap_or(0);
        format!(
            "  {} — {}  ({}/{})",
            module.module.name, module.module.description, completed, ex_count
        )
    } else {
        format!("  {} — {}", module.module.name, module.module.description)
    };

    let view_label = match app.current_view {
        ContentView::Intro => "[Intro]",
        ContentView::Examples => "[Examples]",
        ContentView::Exercise => "[Exercise]",
    };

    let title = Line::from(vec![
        Span::styled(
            " CLI Tutor ",
            Style::default()
                .fg(Color::Cyan)
                .add_modifier(Modifier::BOLD),
        ),
        Span::styled(&progress_text, Style::default().fg(Color::White)),
        Span::styled("  ", Style::default()),
        Span::styled(view_label, Style::default().fg(Color::Yellow)),
        Span::styled("  [?] Help", Style::default().fg(Color::DarkGray)),
    ]);

    frame.render_widget(
        Paragraph::new(title).style(Style::default().bg(Color::DarkGray)),
        area,
    );
}

fn render_main(app: &App, frame: &mut Frame, area: Rect) {
    // content_display.LAYOUT.1 — 25% / 75% split
    let cols = Layout::default()
        .direction(Direction::Horizontal)
        .constraints([Constraint::Percentage(25), Constraint::Percentage(75)])
        .split(area);

    command_list::render(app, frame, cols[0]);
    content_pane::render(app, frame, cols[1]);
}

fn render_footer(app: &App, frame: &mut Frame, area: Rect) {
    // content_display.LAYOUT.3
    let hints = match app.current_view {
        ContentView::Intro => " ↑↓ Scroll  Tab: Next view  ↑↓ Module  q: Quit",
        ContentView::Examples => " ↑↓ Scroll  Tab: Next view  ↑↓ Module  q: Quit",
        ContentView::Exercise => {
            " Enter: Submit  h: Hint  s: Solution  f: Files  r: Reset  Tab: View  q: Quit"
        }
    };

    frame.render_widget(
        Paragraph::new(hints).style(Style::default().bg(Color::DarkGray).fg(Color::White)),
        area,
    );
}

// content_display.LAYOUT.4
fn render_resize_prompt(frame: &mut Frame, area: Rect) {
    let msg = Paragraph::new("Please resize your terminal (min 80×24)")
        .style(Style::default().fg(Color::Yellow))
        .block(Block::default().borders(Borders::ALL));
    let center = centered_rect(50, 20, area);
    frame.render_widget(msg, center);
}

fn centered_rect(percent_x: u16, percent_y: u16, r: Rect) -> Rect {
    let layout = Layout::default()
        .direction(Direction::Vertical)
        .constraints([
            Constraint::Percentage((100 - percent_y) / 2),
            Constraint::Percentage(percent_y),
            Constraint::Percentage((100 - percent_y) / 2),
        ])
        .split(r);
    Layout::default()
        .direction(Direction::Horizontal)
        .constraints([
            Constraint::Percentage((100 - percent_x) / 2),
            Constraint::Percentage(percent_x),
            Constraint::Percentage((100 - percent_x) / 2),
        ])
        .split(layout[1])[1]
}