cordance-advise 0.1.1

Cordance advisory engine. Deterministic doctrine checks against project state.
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

//! R-adr-1 — require docs/adr/README.md when ADR directory has files.

use camino::Utf8PathBuf;
use cordance_core::advise::{AdviseFinding, Severity};
use cordance_core::pack::CordancePack;

use super::AdviseRule;

pub struct RAdrReadme1;

impl AdviseRule for RAdrReadme1 {
    fn id(&self) -> &'static str {
        "R-adr-1"
    }

    fn doctrine_anchor(&self) -> &'static str {
        "doctrine/principles/documentation-knowledge.md"
    }

    fn check(&self, pack: &CordancePack) -> Vec<AdviseFinding> {
        let has_adr_files = pack
            .sources
            .iter()
            .any(|r| !r.blocked && r.path.as_str().starts_with("docs/adr/"));

        if !has_adr_files {
            return vec![];
        }

        let has_readme = pack
            .sources
            .iter()
            .any(|r| !r.blocked && r.path.as_str() == "docs/adr/README.md");

        if has_readme {
            return vec![];
        }

        vec![AdviseFinding {
            id: self.id().into(),
            severity: Severity::Warning,
            summary: "ADR directory exists but docs/adr/README.md is missing.".into(),
            doctrine_anchor: Utf8PathBuf::from(self.doctrine_anchor()),
            project_paths: vec!["docs/adr/".into()],
            remediation: "Add docs/adr/README.md with an index of your ADRs.".into(),
        }]
    }
}