specfold-core 0.1.0

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
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

//! Runs the selected rules and orders their findings.

use super::context::{Ctx, Options};
use super::finding::Finding;
use super::rules::catalog;
use super::scope::{Range, Scope};
use crate::corpus::Corpus;
use crate::graph::Graph;
use crate::plugins;
use anyhow::Result;
use rayon::prelude::*;

#[derive(Debug, Clone, Default)]
pub struct Selection {
    /// Only these rule ids; empty means all.
    pub only: Vec<String>,
    /// Skip these rule ids.
    pub skip: Vec<String>,
}

pub struct Report {
    pub findings: Vec<Finding>,
    pub rules_run: Vec<&'static str>,
    pub docs_checked: usize,
}

pub fn run(c: &Corpus, g: &Graph, range: Range, opts: &Options, sel: &Selection) -> Result<Report> {
    let scope = Scope::build(c, g, range)?;
    let ctx = Ctx { corpus: c, graph: g, scope: &scope, opts };
    let staged = matches!(scope.range, Range::Staged);
    let rules: Vec<_> = catalog()
        .into_iter()
        .filter(|r| {
            let id = r.info().id;
            (sel.only.is_empty() || sel.only.iter().any(|o| o == id))
                && !sel.skip.iter().any(|s| s == id)
                && (!staged || r.info().on_commit)
        })
        .collect();
    let mut findings: Vec<Finding> = rules
        .par_iter()
        .flat_map(|r| {
            let mut out = vec![];
            r.run(&ctx, &mut out);
            out
        })
        .collect();
    let wants_plugins = sel.only.is_empty() || sel.only.iter().any(|o| o.starts_with("x."));
    if wants_plugins && !c.cfg.raw.plugins.is_empty() && !sel.skip.iter().any(|s| s == "x") {
        let loaded = plugins::load(&c.cfg);
        plugins::rules::run(&ctx, &loaded, &mut findings);
    }
    findings.sort_by(|a, b| (a.severity, &a.path, a.line, &a.rule).cmp(&(b.severity, &b.path, b.line, &b.rule)));
    findings.dedup_by(|a, b| a.rule == b.rule && a.path == b.path && a.line == b.line && a.message == b.message);
    let docs_checked = if scope.is_all() { c.docs.len() } else { scope.with_neighbours.len() };
    Ok(Report { findings, rules_run: rules.iter().map(|r| r.info().id).collect(), docs_checked })
}