cartulary 0.3.0-alpha.1

The knowledge layer of your project — decisions, issues, docs, all in one place.
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

//! Enforce that every issue's id prefix matches the prefix configured
//! in `cartulary.toml`.

use crate::domain::model::check::{CheckViolationKind, Severity};
use crate::domain::usecases::check::{CheckViolation, IssueCheckCtx, IssueFinding, IssueRule};

pub struct ConfiguredPrefixRule;

pub const RULE_ID: &str = "issue/configured-prefix";

impl IssueRule for ConfiguredPrefixRule {
    fn id(&self) -> &'static str {
        RULE_ID
    }

    fn find(&self, ctx: &IssueCheckCtx<'_>) -> anyhow::Result<Vec<IssueFinding>> {
        let Some(configured) = ctx.repo.configured_id_prefix() else {
            return Ok(Vec::new());
        };
        let configured = configured.trim_end_matches('-');
        let mut out = Vec::new();
        for (path, issue) in ctx.issues {
            if issue.id.prefix() == configured {
                continue;
            }
            let kind = CheckViolationKind::WrongIdPrefix {
                id: issue.id.as_entity_ref().clone(),
                expected: configured.to_string(),
            };
            out.push(CheckViolation {
                rule_id: RULE_ID,
                path: path.clone(),
                severity: Severity::Error,
                kind,
            });
        }
        Ok(out.into_iter().map(IssueFinding::report).collect())
    }
}