mull 0.9.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
38
39
40
41
42
43
44

use crate::{error::Error, format::CodeStr, parser, validator, wiki::Wiki};
use similar::TextDiff;
use std::path::Path;

// Parse and validate source contents against the wiki's surrounding filesystem.
pub fn analyze(
    wiki_path: &Path,
    source_path: &Path,
    source_contents: &str,
) -> Result<Wiki, Vec<Error>> {
    // Parse and score the wiki before performing validations that require its structure.
    let wiki = parser::parse(source_path, source_contents)?;
    validator::validate(&wiki, wiki_path, source_path, source_contents)?;
    Ok(wiki)
}

// Perform every check required by the check command while retaining the parsed wiki.
pub fn check(
    wiki_path: &Path,
    source_path: &Path,
    source_contents: &str,
) -> Result<Wiki, Vec<Error>> {
    // Analyze the source before comparing it with its canonical rendering.
    let wiki = analyze(wiki_path, source_path, 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(),
            ),
            Some(source_path),
            None,
            None,
        )]);
    }

    // Every check succeeded.
    Ok(wiki)
}