specfold-core 0.3.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

//! U1: the project's guards pass for the range being checked.

use crate::check::context::Ctx;
use crate::check::finding::Finding;
use crate::check::rule::{Rule, RuleInfo};
use crate::check::scope::Range;
use crate::guards::{self, GuardRange};

pub struct GuardsPass;

impl Rule for GuardsPass {
    fn info(&self) -> &RuleInfo {
        &RuleInfo {
            id: "U1",
            title: "guards pass",
            explain: "Guards are named checks in spec.toml over any file and over commit messages: denied terms (inline, from a private file, or from an environment variable), regexes, file patterns, size limits and built-in secret formats. Terms are masked in output. Staged and ranged checks run them over what changed; a full `spec check` runs them only with --guards, since reading every published file belongs to `spec guard`.",
            on_commit: true,
        }
    }

    fn run(&self, ctx: &Ctx, out: &mut Vec<Finding>) {
        if ctx.corpus.cfg.raw.guards.is_empty() || (ctx.scope.is_all() && !ctx.opts.guards) {
            return;
        }
        let range = match &ctx.scope.range {
            Range::All => GuardRange::All,
            Range::Staged => GuardRange::Staged,
            Range::Changed(base) => GuardRange::Push(Some(format!("{base}..HEAD"))),
        };
        match guards::run(&ctx.corpus.cfg, &[], Some(&range)) {
            Ok(f) => out.extend(f),
            Err(e) => out.push(Finding::error("U1", "spec.toml", 1, e.to_string())),
        }
    }
}