normalize-rules 0.3.1

Rule orchestration and CLI service for normalize (syntax + fact + native + SARIF engines)
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

//! Diagnostic formatting helpers for fact rules.
//!
//! The dylib rule pack loader has been removed. Rules run as interpreted `.dl` files
//! via `normalize-facts-rules-interpret`; there is no dynamic library loading.

use normalize_facts_rules_api::Diagnostic;

/// Format a diagnostic for display
pub fn format_diagnostic(diag: &Diagnostic, use_colors: bool) -> String {
    use normalize_facts_rules_api::DiagnosticLevel;

    let level_str = match diag.level {
        DiagnosticLevel::Hint => {
            if use_colors {
                "\x1b[36mhint\x1b[0m"
            } else {
                "hint"
            }
        }
        DiagnosticLevel::Warning => {
            if use_colors {
                "\x1b[33mwarning\x1b[0m"
            } else {
                "warning"
            }
        }
        DiagnosticLevel::Error => {
            if use_colors {
                "\x1b[31merror\x1b[0m"
            } else {
                "error"
            }
        }
    };

    let mut out = String::new();

    // Location
    if let Some(ref loc) = diag.location {
        out.push_str(&format!("{}:{}: ", loc.file, loc.line));
    }

    // Level and rule
    out.push_str(&format!("{} [{}]: ", level_str, diag.rule_id));

    // Message
    out.push_str(&diag.message);

    // Related locations
    for related in diag.related.iter() {
        out.push_str(&format!("\n  --> {}:{}", related.file, related.line));
    }

    // Suggestion
    if let Some(ref suggestion) = diag.suggestion {
        out.push_str(&format!("\n  suggestion: {}", suggestion));
    }

    out
}