MCPcopy Create free account
hub / github.com/atomicdotdev/atomic / render_walkthrough

Function render_walkthrough

atomic-cli/src/commands/triage/output.rs:625–731  ·  view source on GitHub ↗

The walkthrough section: a reading-order nav plus one numbered collapsible chapter per layer (first chapter open). Each chapter shows the canonical rationale, its tasks/criteria, `depends_on` anchor links to earlier chapters, and the per-file diffs scoped to that layer's files.

(report: &TriageReport)

Source from the content-addressed store, hash-verified

623/// rationale, its tasks/criteria, `depends_on` anchor links to earlier
624/// chapters, and the per-file diffs scoped to that layer's files.
625fn render_walkthrough(report: &TriageReport) -> String {
626 // layer id → (1-based chapter number, title) for depends_on anchors.
627 let chapter_of: BTreeMap<&str, (usize, &str)> = report
628 .walkthrough
629 .iter()
630 .enumerate()
631 .map(|(i, l)| (l.id.as_str(), (i + 1, l.title.as_str())))
632 .collect();
633
634 let mut h = String::new();
635 h.push_str("<section id=\"walkthrough\">\n<h2>Walkthrough</h2>\n");
636 h.push_str("<p class=\"tour-intro\">Guided reading order — foundations first.</p>\n");
637
638 // Reading-order nav.
639 h.push_str("<ol class=\"toc\">\n");
640 for (i, layer) in report.walkthrough.iter().enumerate() {
641 h.push_str(&format!(
642 "<li><a href=\"#chapter-{}\">{}</a></li>\n",
643 i + 1,
644 html_escape(&layer.title)
645 ));
646 }
647 h.push_str("</ol>\n");
648
649 for (i, layer) in report.walkthrough.iter().enumerate() {
650 let n = i + 1;
651 let open = if i == 0 { " open" } else { "" };
652 h.push_str(&format!(
653 "<details class=\"chapter\" id=\"chapter-{n}\"{open}>\n"
654 ));
655 h.push_str(&format!(
656 "<summary><span class=\"chapter-num\">{n}</span> <span class=\"chapter-title\">{}</span> <span class=\"stat\">{} file(s) · {} change(s)</span></summary>\n",
657 html_escape(&layer.title),
658 layer.files.len(),
659 layer.changes.len()
660 ));
661 h.push_str(&format!(
662 "<p class=\"rationale\">{}</p>\n",
663 html_escape(&layer.rationale)
664 ));
665
666 // depends_on → anchor links to the chapters this one builds on.
667 if !layer.depends_on.is_empty() {
668 h.push_str("<div class=\"chapter-deps\">builds on: ");
669 let mut first = true;
670 for dep in &layer.depends_on {
671 if !first {
672 h.push_str(" · ");
673 }
674 first = false;
675 match chapter_of.get(dep.as_str()) {
676 Some((dn, title)) => h.push_str(&format!(
677 "<a href=\"#chapter-{dn}\">{dn}. {}</a>",
678 html_escape(title)
679 )),
680 // A dep outside the rendered set (defensive): plain text.
681 None => h.push_str(&html_escape(dep)),
682 }

Callers 1

render_htmlFunction · 0.85

Calls 9

render_diff_fileFunction · 0.85
html_escapeFunction · 0.70
getMethod · 0.65
collectMethod · 0.45
iterMethod · 0.45
as_strMethod · 0.45
is_emptyMethod · 0.45
cloneMethod · 0.45
containsMethod · 0.45

Tested by

no test coverage detected