mull 0.11.0

Organize your knowledge.
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

use crate::{
    error::Error, format::CodeStr, parser, path_util::WikiLocation, validator, wiki::Wiki,
};
use similar::TextDiff;

// Parse and validate source contents with any available surrounding filesystem.
pub fn analyze(location: WikiLocation<'_>, source_contents: &str) -> Result<Wiki, Vec<Error>> {
    // Parse and score the wiki before performing validations that require its structure.
    let wiki = parser::parse(location.display_path(), source_contents)?;
    validator::validate(&wiki, location, source_contents)?;
    Ok(wiki)
}

// Perform every check required by the check command while retaining the parsed wiki.
pub fn check(location: WikiLocation<'_>, source_contents: &str) -> Result<Wiki, Vec<Error>> {
    // Analyze the source before comparing it with its canonical rendering.
    let wiki = analyze(location, source_contents)?;
    let rendered_wiki = wiki.to_string();
    if source_contents != rendered_wiki {
        let diff = TextDiff::from_lines(source_contents, &rendered_wiki)
            .unified_diff()
            .header("wiki", "rendered")
            .to_string();
        return Err(vec![Error::new(
            &format!(
                "The wiki is not formatted correctly. {} can fix it.\n\n{diff}",
                "mull fix".code_str(),
            ),
            location.display_path(),
            None,
            None,
        )]);
    }

    // Every check succeeded.
    Ok(wiki)
}