friendly-errors 0.2.0

Create developer-friendly error messages
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

pub use code_snippet::{FriendlyCodeSnippet, FriendlyCodeSnippetError};

mod code_snippet;
mod description;
mod doc_url;
mod header;
mod print_snippets;
mod summary;

#[derive(PartialEq, Debug, Clone)]
pub enum ErrorKind {
    Error,
    Warning,
    Improvement,
    CodeStyle,
}

#[derive(PartialEq, Debug, Clone)]
struct ErrorData {
    code_snippets: Vec<FriendlyCodeSnippet>,
    description: Option<String>,
    doc_url: Option<String>,
    error_code: Option<String>,
    kind: ErrorKind,
    summary: Option<String>,
    title: Option<String>,
}

pub struct FriendlyError {
    data: ErrorData,
    pub(crate) output: String,
}

#[derive(PartialEq, Debug, Clone)]
pub enum FriendlyErrorError {
    CodeSnippetError(FriendlyCodeSnippetError),
}

pub type FriendlyErrorResult = Result<String, FriendlyErrorError>;

impl FriendlyError {
    pub fn new() -> Self {
        FriendlyError {
            data: {
                ErrorData {
                    code_snippets: Vec::new(),
                    description: None,
                    doc_url: None,
                    error_code: None,
                    kind: ErrorKind::Error,
                    summary: None,
                    title: None,
                }
            },
            output: String::new(),
        }
    }

    pub fn add_code_snippet(mut self, code_snippet: FriendlyCodeSnippet) -> Self {
        self.data.code_snippets.push(code_snippet);
        self
    }

    pub fn description<S: Into<String>>(mut self, description: S) -> Self {
        self.data.description = Some(description.into());
        self
    }

    pub fn doc_url<S: Into<String>>(mut self, url: S) -> Self {
        self.data.doc_url = Some(url.into());
        self
    }

    pub fn error_code<S: Into<String>>(mut self, code: S) -> Self {
        self.data.error_code = Some(code.into());
        self
    }

    pub fn kind(mut self, kind: ErrorKind) -> Self {
        self.data.kind = kind;
        self
    }

    pub fn summary<S: Into<String>>(mut self, summary: S) -> Self {
        self.data.summary = Some(summary.into());
        self
    }

    pub fn title<S: Into<String>>(mut self, title: S) -> Self {
        self.data.title = Some(title.into());
        self
    }

    pub fn build(mut self) -> FriendlyErrorResult {
        self.print_header();
        self.print_summary();
        self.print_code_snippets()?;
        self.print_description();
        self.print_doc_url();
        Ok(self.output)
    }

    #[cfg(test)]
    pub(crate) fn set_output<S: Into<String>>(mut self, output: S) -> Self {
        self.output = output.into();
        self
    }

    pub(crate) fn add_empty_line(&mut self) {
        if !self.output.is_empty() {
            self.output.push('\n');
            self.output.push('\n');
        }
    }
}

impl Default for FriendlyError {
    fn default() -> Self {
        Self::new()
    }
}