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

//! Orphans: active documents that govern nothing and that nothing cites.

use super::super::types::{Item, Kind};
use crate::corpus::Corpus;
use crate::graph::Graph;

pub fn run(c: &Corpus, g: &Graph, docs: &[usize], out: &mut Vec<Item>) {
    for &i in docs {
        let d = &c.docs[i];
        // C136: an audit record is a dated snapshot, not something that should govern code.
        if d.id.ty == "audit" {
            continue;
        }
        if d.status().as_deref() != Some("active") || !d.rel().get("governs").is_none_or(Vec::is_empty) {
            continue;
        }
        if g.edges_to(i).next().is_none() && g.edges_from(i).next().is_none() {
            out.push(Item {
                kind: Kind::Orphan,
                subject: d.id.to_string(),
                path: d.path.clone(),
                line: 1,
                detail: "active, governs no code, and no document cites it".into(),
                next: Some(format!(
                    "spec set {} rel.governs+=<path> --write   # or: {}",
                    crate::shell::word(&d.id),
                    super::archive(c, i)
                )),
            });
        }
    }
}