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
33
34
35
36
37
38
39
40

//! Finds the spec directories: one per owner that has one, plus the local directory.

use super::types::{SpecRoot, Stray};
use crate::config::Config;
use crate::model::Tier;
use crate::workspace::Owners;

pub fn committed(cfg: &Config, owners: &Owners) -> Vec<SpecRoot> {
    owners
        .list
        .iter()
        .filter_map(|o| {
            let dir = owners.spec_dir(o, cfg.spec_dir());
            let root = SpecRoot { owner: o.id.clone(), dir, tier: Tier::Committed, pending: o.pending };
            cfg.root.join(&root.dir).is_dir().then_some(root)
        })
        .collect()
}

/// `.spec.local/<owner-id>/` directories. Unknown owner ids are reported as strays.
pub fn local(cfg: &Config, owners: &Owners, strays: &mut Vec<Stray>) -> Vec<SpecRoot> {
    let base = cfg.local_dir();
    let Ok(rd) = std::fs::read_dir(cfg.root.join(base)) else { return vec![] };
    let mut out = vec![];
    for entry in rd.flatten() {
        let name = entry.file_name().to_string_lossy().into_owned();
        let rel = format!("{base}/{name}");
        if !entry.path().is_dir() {
            strays.push(Stray { path: rel, reason: "local files go in a directory named after their owner (.spec.local/<owner>/<type>/); create local documents with spec new <type> --local --write, and keep plain notes outside .spec.local".into() });
            continue;
        }
        if owners.by_id(&name).is_none() {
            strays.push(Stray { path: rel, reason: format!("'{name}' is not an owner id") });
            continue;
        }
        out.push(SpecRoot { owner: name, dir: rel, tier: Tier::Local, pending: false });
    }
    out.sort_by(|a, b| a.dir.cmp(&b.dir));
    out
}