barad-dur 0.17.3

The all-seeing repository analyzer
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

mod css;
mod js_age;
mod js_audit;
mod js_authors;
mod js_coupling;
mod js_deps;
mod js_hotspots;
mod js_overview;
mod js_ownership;
mod js_shared;
mod js_treemap_layout;
mod js_treemap_ui;
mod js_trends;

#[cfg(test)]
mod tests;

#[cfg(test)]
mod tests_extra;

use crate::scorer::AnalysisReport;
use anyhow::Result;

/// Render the analysis report as a self-contained HTML file.
/// All CSS, JS, and data are inlined. No external dependencies.
pub fn render(report: &AnalysisReport) -> Result<String> {
    let json = serde_json::to_string(report)?;
    let json = json.replace("</", "<\\/");
    let title = format!("{} — Barad-dûr Report", report.repo_name);

    let html = format!(
        "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"UTF-8\">\n\
<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n\
<title>{title}</title>\n<style>\n{css}\n</style>\n</head>\n<body>\n\
<script>window.R={json};</script>\n\
<div id=\"app\"></div>\n\
<script>\n{js}\n</script>\n</body>\n</html>",
        title = title,
        json = json,
        css = css::CSS,
        js = build_js(report),
    );
    Ok(html)
}

// _report is kept for future per-report JS customisation (feature flags, conditional modules).
fn build_js(_report: &AnalysisReport) -> String {
    [
        js_shared::JS,
        js_overview::JS,
        js_hotspots::JS,
        js_coupling::JS,
        js_ownership::JS,
        js_age::JS,
        js_treemap_layout::JS,
        js_treemap_ui::JS,
        js_trends::JS,
        js_deps::JS,
        js_audit::JS,
        js_authors::JS,
    ]
    .concat()
}