cli-tutor 0.1.1

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

use serde::Deserialize;

// command_modules.ENG.1 — content structs derive Clone, Debug, Deserialize
#[derive(Debug, Clone, Deserialize)]
pub struct ModuleFile {
    pub module: ModuleInfo,
    pub intro: Intro,
    #[serde(default)]
    pub examples: Vec<Example>,
    #[serde(default)]
    pub exercises: Vec<Exercise>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct ModuleInfo {
    pub name: String,
    pub description: String,
    #[serde(default)]
    pub version: u32,
}

#[derive(Debug, Clone, Deserialize)]
pub struct Intro {
    pub text: String,
}

#[derive(Debug, Clone, Deserialize)]
pub struct Example {
    pub title: String,
    pub command: String,
    pub output: String,
    #[serde(default)]
    pub description: String,
}

#[derive(Debug, Clone, Deserialize)]
pub struct Exercise {
    pub id: String,
    pub difficulty: Difficulty,
    pub question: String,
    pub expected_output: String,
    #[serde(default)]
    pub hints: Vec<String>,
    pub solution: String,
    pub match_mode: MatchMode,
    // command_modules.SCHEMA.8 — fixtures optional
    #[serde(default)]
    pub fixtures: Vec<Fixture>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct Fixture {
    pub filename: String,
    pub content: String,
}

// command_modules.SCHEMA.6
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum Difficulty {
    Beginner,
    Intermediate,
    Advanced,
}

impl std::fmt::Display for Difficulty {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Difficulty::Beginner => write!(f, "Beginner"),
            Difficulty::Intermediate => write!(f, "Intermediate"),
            Difficulty::Advanced => write!(f, "Advanced"),
        }
    }
}

// command_modules.SCHEMA.7
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
pub enum MatchMode {
    Exact,
    Normalized,
    Sorted,
    Regex,
}