markdownlint-rs 0.3.15

A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files
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

use crate::types::{FileResult, Violation};
use std::path::PathBuf;

#[derive(Debug, Default)]
pub struct LintResult {
    pub file_results: Vec<FileResult>,
    pub total_errors: usize,
    /// Total number of files that were linted (including those with no violations).
    pub total_files_checked: usize,
}

impl LintResult {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn add_file_result(
        &mut self,
        path: PathBuf,
        violations: Vec<Violation>,
        source_lines: Vec<String>,
    ) {
        self.total_errors += violations.len();
        self.total_files_checked += 1;
        self.file_results.push(FileResult {
            path,
            violations,
            source_lines,
        });
    }

    /// Record that a file was checked but had no violations.
    pub fn record_clean_file(&mut self) {
        self.total_files_checked += 1;
    }

    pub fn has_errors(&self) -> bool {
        self.total_errors > 0
    }
}