drft-cli 0.7.0

A structural integrity checker for linked file systems
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use crate::config::RuleSeverity;
use serde::Serialize;

#[derive(Debug, Clone, Serialize)]
pub struct Diagnostic {
    pub rule: String,
    pub severity: RuleSeverity,
    pub message: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub via: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub path: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fix: Option<String>,
}

impl Default for Diagnostic {
    fn default() -> Self {
        Diagnostic {
            rule: String::new(),
            severity: RuleSeverity::Warn,
            message: String::new(),
            source: None,
            target: None,
            node: None,
            via: None,
            path: None,
            fix: None,
        }
    }
}

impl Diagnostic {
    pub fn format_text(&self) -> String {
        let severity = match self.severity {
            RuleSeverity::Error => "error",
            RuleSeverity::Warn => "warn",
            RuleSeverity::Off => "off",
        };

        match (&self.source, &self.target) {
            (Some(source), Some(target)) => {
                let via_suffix = self
                    .via
                    .as_ref()
                    .map(|v| format!(" via {v}"))
                    .unwrap_or_default();
                format!(
                    "{severity}[{}]: {source} \u{2192} {target} ({}{})",
                    self.rule, self.message, via_suffix
                )
            }
            _ if self.path.is_some() => {
                let path = self.path.as_ref().unwrap();
                let cycle = path.join(" \u{2192} ");
                format!("{severity}[{}]: {}: {cycle}", self.rule, self.message)
            }
            _ if self.node.is_some() => {
                let node = self.node.as_ref().unwrap();
                match &self.via {
                    Some(via) => {
                        format!("{severity}[{}]: {node} ({} {via})", self.rule, self.message)
                    }
                    None => format!("{severity}[{}]: {node} ({})", self.rule, self.message),
                }
            }
            _ => format!("{severity}[{}]: {}", self.rule, self.message),
        }
    }

    pub fn format_text_color(&self) -> String {
        let (severity_str, color) = match self.severity {
            RuleSeverity::Error => ("error", "\x1b[1;31m"), // bold red
            RuleSeverity::Warn => ("warn", "\x1b[1;33m"),   // bold yellow
            RuleSeverity::Off => ("off", "\x1b[0m"),
        };
        let reset = "\x1b[0m";
        let bold = "\x1b[1m";
        let cyan = "\x1b[36m";

        match (&self.source, &self.target) {
            (Some(source), Some(target)) => {
                let via_suffix = self
                    .via
                    .as_ref()
                    .map(|v| format!(" via {cyan}{v}{reset}"))
                    .unwrap_or_default();
                format!(
                    "{color}{severity_str}{reset}[{bold}{}{reset}]: {cyan}{source}{reset} \u{2192} {cyan}{target}{reset} ({}{})",
                    self.rule, self.message, via_suffix
                )
            }
            _ if self.path.is_some() => {
                let path = self.path.as_ref().unwrap();
                let cycle = path
                    .iter()
                    .map(|p| format!("{cyan}{p}{reset}"))
                    .collect::<Vec<_>>()
                    .join(" \u{2192} ");
                format!(
                    "{color}{severity_str}{reset}[{bold}{}{reset}]: {}: {cycle}",
                    self.rule, self.message
                )
            }
            _ if self.node.is_some() => {
                let node = self.node.as_ref().unwrap();
                match &self.via {
                    Some(via) => format!(
                        "{color}{severity_str}{reset}[{bold}{}{reset}]: {cyan}{node}{reset} ({} {cyan}{via}{reset})",
                        self.rule, self.message
                    ),
                    None => format!(
                        "{color}{severity_str}{reset}[{bold}{}{reset}]: {cyan}{node}{reset} ({})",
                        self.rule, self.message
                    ),
                }
            }
            _ => format!(
                "{color}{severity_str}{reset}[{bold}{}{reset}]: {}",
                self.rule, self.message
            ),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn text_format_edge_rule() {
        let d = Diagnostic {
            rule: "unresolved-edge".into(),
            severity: RuleSeverity::Warn,
            message: "file not found".into(),
            source: Some("index.md".into()),
            target: Some("gone.md".into()),
            ..Default::default()
        };
        assert_eq!(
            d.format_text(),
            "warn[unresolved-edge]: index.md \u{2192} gone.md (file not found)"
        );
    }

    #[test]
    fn json_serialization() {
        let d = Diagnostic {
            rule: "unresolved-edge".into(),
            severity: RuleSeverity::Warn,
            message: "file not found".into(),
            source: Some("index.md".into()),
            target: Some("gone.md".into()),
            ..Default::default()
        };
        let json = serde_json::to_string(&d).unwrap();
        assert!(json.contains("\"rule\":\"unresolved-edge\""));
        assert!(json.contains("\"severity\":\"warn\""));
        assert!(json.contains("\"source\":\"index.md\""));
        assert!(json.contains("\"target\":\"gone.md\""));
        assert!(!json.contains("\"node\""));
    }
}