lint-ai 0.1.3

Semantic wiki and docs linting for contradictions, stale claims, orphan pages, and missing cross-references
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

pub struct Report {
    issues: Vec<String>,
}

impl Report {
    /// Create an empty report.
    pub fn new() -> Self {
        Self { issues: vec![] }
    }

    /// Add a new issue line.
    pub fn add(&mut self, msg: String) {
        self.issues.push(msg);
    }

    /// Print issues to stdout.
    pub fn print(&self) {
        if self.issues.is_empty() {
            println!("No issues found");
        } else {
            println!("Issues:");
            for i in &self.issues {
                println!("- {}", i);
            }
        }
    }

    /// Render issues as a single string.
    pub fn to_string(&self) -> String {
        if self.issues.is_empty() {
            "No issues found".to_string()
        } else {
            let mut out = String::from("Issues:");
            for i in &self.issues {
                out.push_str("\n- ");
                out.push_str(i);
            }
            out
        }
    }
}