specfold_core/check/
runner.rs

1//! Runs the selected rules and orders their findings.
2
3use super::context::{Ctx, Options};
4use super::finding::Finding;
5use super::rules::catalog;
6use super::scope::{Range, Scope};
7use crate::corpus::Corpus;
8use crate::graph::Graph;
9use crate::plugins;
10use anyhow::Result;
11use rayon::prelude::*;
12
13#[derive(Debug, Clone, Default)]
14pub struct Selection {
15    /// Only these rule ids; empty means all.
16    pub only: Vec<String>,
17    /// Skip these rule ids.
18    pub skip: Vec<String>,
19}
20
21pub struct Report {
22    pub findings: Vec<Finding>,
23    pub rules_run: Vec<&'static str>,
24    pub docs_checked: usize,
25}
26
27pub fn run(c: &Corpus, g: &Graph, range: Range, opts: &Options, sel: &Selection) -> Result<Report> {
28    let scope = Scope::build(c, g, range)?;
29    let ctx = Ctx { corpus: c, graph: g, scope: &scope, opts };
30    let staged = matches!(scope.range, Range::Staged);
31    let rules: Vec<_> = catalog()
32        .into_iter()
33        .filter(|r| {
34            let id = r.info().id;
35            (sel.only.is_empty() || sel.only.iter().any(|o| o == id))
36                && !sel.skip.iter().any(|s| s == id)
37                && (!staged || r.info().on_commit)
38        })
39        .collect();
40    let mut findings: Vec<Finding> = rules
41        .par_iter()
42        .flat_map(|r| {
43            let mut out = vec![];
44            r.run(&ctx, &mut out);
45            out
46        })
47        .collect();
48    let wants_plugins = sel.only.is_empty() || sel.only.iter().any(|o| o.starts_with("x."));
49    if wants_plugins && !c.cfg.raw.plugins.is_empty() && !sel.skip.iter().any(|s| s == "x") {
50        let loaded = plugins::load(&c.cfg);
51        plugins::rules::run(&ctx, &loaded, &mut findings);
52    }
53    let mut findings = super::severity::apply(c, findings);
54    findings.sort_by(|a, b| (a.severity, &a.path, a.line, &a.rule).cmp(&(b.severity, &b.path, b.line, &b.rule)));
55    findings.dedup_by(|a, b| a.rule == b.rule && a.path == b.path && a.line == b.line && a.message == b.message);
56    let docs_checked = if scope.is_all() { c.docs.len() } else { scope.with_neighbours.len() };
57    Ok(Report { findings, rules_run: rules.iter().map(|r| r.info().id).collect(), docs_checked })
58}
specfold_core/check/runner.rs

specfold_core/check/
runner.rs
