eugene 0.8.3

Careful with That Lock, Eugene
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

use handlebars::Handlebars;
use once_cell::sync::Lazy;

use crate::output::{FullTraceData, LintReport};

pub(crate) static HBARS: Lazy<Handlebars> = Lazy::new(|| {
    let mut hbars = Handlebars::new();
    hbars.set_strict_mode(true);
    hbars.register_escape_fn(handlebars::no_escape);
    hbars
        .register_template_string("locks_table_md", include_str!("locks_table.md.hbs"))
        .expect("Failed to register lock_table");
    hbars
        .register_template_string("trace_report_md", include_str!("trace_report.md.hbs"))
        .expect("Failed to register trace_report");
    hbars
        .register_template_string("lint_report_md", include_str!("lint_report.md.hbs"))
        .expect("Failed to register lint_report");
    hbars
});

/// Render a markdown report from a `FullTraceData`
pub fn to_markdown(trace: &FullTraceData) -> crate::Result<String> {
    Ok(HBARS.render("trace_report_md", trace)?)
}

pub fn lint_report_to_markdown(report: &LintReport) -> crate::Result<String> {
    Ok(HBARS.render("lint_report_md", report)?)
}

pub fn trace_text(trace: &FullTraceData) -> crate::Result<String> {
    if trace.passed_all_checks {
        Ok(String::new())
    } else {
        let fname = trace.name.as_deref().unwrap_or("unnamed");
        let mut out = String::new();
        for statement in &trace.statements {
            if !statement.triggered_rules.is_empty() {
                let line = statement.line_number;
                for rule in &statement.triggered_rules {
                    let id = rule.id.as_str();
                    let name = rule.name.as_str();
                    let url = rule.url.as_str();
                    out.push_str(&format!("{fname}:{line} {id} {name} {url}\n"));
                }
            }
        }
        out.pop();
        Ok(out)
    }
}

pub fn lint_text(report: &LintReport) -> crate::Result<String> {
    let mut out = String::new();
    let fname = report.name.as_deref().unwrap_or("unnamed");
    for statement in &report.statements {
        if !statement.triggered_rules.is_empty() {
            let line = statement.line_number;
            for rule in &statement.triggered_rules {
                let id = rule.id.as_str();
                let name = rule.name.as_str();
                let url = rule.url.as_str();
                out.push_str(&format!("{fname}:{line} {id} {name} {url}\n"));
            }
        }
    }
    out.pop();
    Ok(out)
}