helixforge 1.5.1

Build, configure and optimise a Linux machine from a terminal menu: installs, dotfiles, updates, backups and health checks, every change planned and confirmed first.
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

//! The Markdown walkthrough of the catalog.

use helixforge_core::{Item, Tab};

pub fn walkthrough(tabs: &[Tab]) -> String {
    let mut text = String::from(
        "<!-- Generated by helixforge docgen; do not edit by hand. -->\n# Walkthrough\n",
    );
    for tab in tabs {
        text.push_str(&format!("\n## {}\n\n", tab.name));
        items(&tab.items, 3, &mut text);
    }
    text
}

/// A level's own entries first, then its groups as headings one level down,
/// so no entry reads as part of the group above it.
fn items(list: &[Item], level: usize, text: &mut String) {
    for item in list {
        if let Item::Entry(entry) = item
            && !entry.description.is_empty()
        {
            text.push_str(&format!("- **{}**: {}\n", entry.name, entry.description));
        }
    }
    for item in list {
        if let Item::Group(group) = item {
            text.push_str(&format!(
                "\n{} {}\n\n",
                "#".repeat(level.min(6)),
                group.name
            ));
            if !group.description.is_empty() {
                text.push_str(&format!("{}\n\n", group.description));
            }
            items(&group.items, level + 1, text);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use helixforge_core::{Action, Entry, Group};

    #[test]
    fn groups_become_headings_and_described_entries_bullets() {
        let entry = |name: &str, description: &str| {
            Item::Entry(Entry {
                id: name.to_lowercase(),
                name: name.into(),
                description: description.into(),
                flags: String::new(),
                multi_select: true,
                writes: Vec::new(),
                action: Action::Command {
                    line: "true".into(),
                },
                detect: None,
                needs: Default::default(),
                effects: Default::default(),
            })
        };
        let tab = Tab {
            id: "apps".into(),
            name: "Apps".into(),
            items: vec![
                Item::Group(Group {
                    id: "browsers".into(),
                    name: "Browsers".into(),
                    description: String::new(),
                    multi_select: true,
                    items: vec![
                        entry("Brave", "A browser."),
                        Item::Group(Group {
                            id: "nightly".into(),
                            name: "Nightly".into(),
                            description: String::new(),
                            multi_select: true,
                            items: vec![entry("Firefox", "Another.")],
                        }),
                    ],
                }),
                entry("Quiet", ""),
                entry("Loose", "Outside any group."),
            ],
        };
        let text = walkthrough(&[tab]);
        assert!(text.contains("## Apps\n"));
        assert!(text.contains("### Browsers\n"));
        assert!(text.contains("- **Brave**: A browser.\n"));
        assert!(!text.contains("Quiet"));
        assert!(text.contains("#### Nightly\n\n- **Firefox**: Another.\n"));
        // An entry listed after a group still comes before its heading.
        let loose = text.find("- **Loose**").unwrap();
        assert!(loose < text.find("### Browsers").unwrap(), "{text}");
    }
}