mdwright-lint 0.1.1

Lint diagnostics, rule execution, suppressions, and standard rules for mdwright
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

#![forbid(unsafe_code)]

mod diagnostic;
mod regex_util;
mod rule;
mod rule_set;
pub mod stdlib;
mod suppression;

use std::ops::Range;

use mdwright_document::Document;

pub use diagnostic::{DOCS_URL_DEFAULT, Diagnostic, Fix, Severity, Snippet, docs_url, rule_doc_url};
pub use rule::LintRule;
pub use rule_set::{DuplicateRuleName, RuleSet};

/// Knobs that change lint execution.
#[derive(Copy, Clone, Debug)]
pub struct LintOptions {
    /// Whether `<!-- mdwright: allow ... -->` comments filter diagnostics.
    pub respect_suppressions: bool,
}

impl Default for LintOptions {
    fn default() -> Self {
        Self {
            respect_suppressions: true,
        }
    }
}

/// Apply every safe fix from `diags` to the document's original source.
#[must_use]
pub fn apply_safe_fixes(doc: &Document, diags: &[Diagnostic]) -> (String, usize) {
    let mut edits: Vec<(Range<usize>, &str)> = diags
        .iter()
        .filter_map(|d| {
            let fix = d.fix.as_ref().filter(|f| f.safe)?;
            let orig = doc.canonical_to_original_range(d.span.start..d.span.end);
            Some((orig, fix.replacement.as_str()))
        })
        .collect();
    edits.sort_by_key(|e| std::cmp::Reverse(e.0.start));
    let mut out = doc.original_source().to_owned();
    let mut applied = 0usize;
    let mut last_start = usize::MAX;
    for (range, replacement) in edits {
        if range.end > last_start {
            continue;
        }
        out.replace_range(range.clone(), replacement);
        last_start = range.start;
        applied = applied.saturating_add(1);
    }
    (out, applied)
}