Skip to main content

diff_to_markdown

Function diff_to_markdown 

Source
pub fn diff_to_markdown(diff: &Diff) -> String
Available on crate feature markdown only.
Expand description

Render a Diff to a CommonMark-compatible Markdown string.

ยงExample

use dev_report::{markdown, CheckResult, Report, Severity};

let mut prev = Report::new("c", "0.1.0");
prev.push(CheckResult::pass("a"));
let mut curr = Report::new("c", "0.1.0");
curr.push(CheckResult::fail("a", Severity::Error));

let diff = curr.diff(&prev);
let md = markdown::diff_to_markdown(&diff);
assert!(md.starts_with("# Diff"));
assert!(md.contains("Newly failing"));