specfold-core 0.1.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
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Audit items contributed by plugins that provide `audits`.

use super::types::{Item, Kind};
use crate::corpus::Corpus;
use crate::graph::Graph;
use crate::plugins::{self, payload, process};
use serde::Deserialize;
use serde_json::json;

#[derive(Deserialize)]
struct PluginItem {
    subject: String,
    #[serde(default)]
    path: String,
    #[serde(default)]
    line: usize,
    detail: String,
    next: Option<String>,
}

#[derive(Deserialize)]
struct Response {
    #[serde(default)]
    items: Vec<PluginItem>,
}

pub fn run(c: &Corpus, g: &Graph, out: &mut Vec<Item>) {
    for p in plugins::load(&c.cfg) {
        let Ok(d) = &p.description else { continue };
        if d.provides.audits.is_empty() {
            continue;
        }
        let params =
            json!({"audits": d.provides.audits, "docs": payload::docs(c, None), "edges": payload::edges(c, g)});
        match process::call::<Response>(&c.cfg, &p.def, "audit.run", params) {
            Ok(r) => out.extend(r.items.into_iter().map(|x| Item {
                kind: Kind::Plugin,
                subject: x.subject,
                path: x.path,
                line: x.line,
                detail: format!("[{}] {}", p.def.name, x.detail),
                next: x.next,
            })),
            Err(e) => out.push(Item {
                kind: Kind::Plugin,
                subject: p.def.name.clone(),
                path: "spec.toml".into(),
                line: 0,
                detail: e.to_string(),
                next: None,
            }),
        }
    }
}