rox-cli 0.8.2

Composable build tool inspired by Make
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

use crate::models::{Docs, DocsKind};
use std::io::{stdout, Write};
use termimad::crossterm::{
    cursor::{Hide, Show},
    event::{self, Event, KeyCode, KeyEvent},
    queue,
    style::Color::*,
    terminal::{self, Clear, ClearType, EnterAlternateScreen, LeaveAlternateScreen},
};
use termimad::MadSkin;
use termimad::*;

static KEYBINDINGS: &str = r#"
# Navigation Keybindings

| Key(s) | Action |
| :---: | :------: |
| q/Esc | Exit |
| k/Up | Scroll up one line|
| j/Down | Scroll down one line |
| g | Jump to top |
| G | Jump to Bottom |
| u | Page Up |
| d | Page Down |

------
"#;

pub fn display_docs(docs: &Docs) {
    match docs.kind {
        DocsKind::Markdown => {
            let markdown = std::fs::read_to_string(&docs.path).unwrap();
            run_app(&markdown).unwrap();
        }
        DocsKind::Text => {
            let contents = std::fs::read_to_string(&docs.path).unwrap();
            println!("{}", contents);
        }
        DocsKind::URL => {
            println!("> Opening '{}' in your browser...", docs.path);
            webbrowser::open(&docs.path).unwrap()
        }
    }
}

/// Build and Run the terminal application
/// Taken from -> https://github.com/Canop/termimad/blob/main/examples/scrollable/main.rs
fn run_app(docs: &str) -> Result<(), Error> {
    let mut w = stdout(); // we could also have used stderr
    let skin = make_skin();
    queue!(w, EnterAlternateScreen)?;
    terminal::enable_raw_mode()?;
    queue!(w, Hide)?; // hiding the cursor

    let markdown = format!("{}\n{}", KEYBINDINGS, docs);
    let mut view = MadView::from(markdown, view_area(), skin);
    loop {
        view.write_on(&mut w)?;
        w.flush()?;
        match event::read() {
            Ok(Event::Key(KeyEvent { code, .. })) => match code {
                // Negative number is up, Positive number is down
                KeyCode::Up => view.try_scroll_lines(-1),
                KeyCode::Down => view.try_scroll_lines(1),
                KeyCode::Char('k') => view.try_scroll_lines(-1),
                KeyCode::Char('j') => view.try_scroll_lines(1),

                KeyCode::Char('u') => view.try_scroll_lines(-30),
                KeyCode::Char('d') => view.try_scroll_lines(30),

                KeyCode::Char('g') => view.try_scroll_lines(-100000),
                KeyCode::Char('G') => view.try_scroll_lines(100000),

                KeyCode::Char('q') => break,
                KeyCode::Esc => break,
                _ => continue,
            },
            Ok(Event::Resize(..)) => {
                queue!(w, Clear(ClearType::All))?;
                view.resize(&view_area());
            }
            _ => {}
        }
    }
    terminal::disable_raw_mode()?;
    queue!(w, Show)?; // we must restore the cursor
    queue!(w, LeaveAlternateScreen)?;
    w.flush()?;
    Ok(())
}

fn make_skin() -> MadSkin {
    let mut skin = MadSkin::default();
    skin.table.align = Alignment::Center;
    skin.set_headers_fg(AnsiValue(178));
    skin.bold.set_fg(Yellow);
    skin.italic.set_fg(Magenta);
    skin.scrollbar.thumb.set_fg(AnsiValue(178));
    skin.code_block.align = Alignment::Center;
    skin
}

fn view_area() -> Area {
    let mut area = Area::full_screen();
    area.pad_for_max_width(120); // we don't want a too wide text column
    area
}