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

//! R-docs-1 — require a non-empty README.md.

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

use super::AdviseRule;

pub struct RDocs1;

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

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

    fn check(&self, pack: &CordancePack) -> Vec<AdviseFinding> {
        let readme = pack
            .sources
            .iter()
            .find(|r| !r.blocked && r.path.as_str() == "README.md");

        let has_content = readme.is_some_and(|r| r.size_bytes > 0);

        if has_content {
            return vec![];
        }

        vec![AdviseFinding {
            id: self.id().into(),
            severity: Severity::Warning,
            summary: "README.md missing or empty.".into(),
            doctrine_anchor: Utf8PathBuf::from(self.doctrine_anchor()),
            project_paths: vec!["README.md".into()],
            remediation: "Add README.md with: what it does, how to set up, how to run.".into(),
        }]
    }
}