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

//! The spec.toml `spec init` writes for a new project.

pub struct StarterKind {
    pub pattern: String,
    pub id: String,
    pub manifest: bool,
}

pub fn render(root_owner: &str, kinds: &[StarterKind]) -> String {
    let mut s = String::new();
    s.push_str("# specfold configuration. Run `spec explain config` for every key.\n");
    s.push_str("[spec]\nschema = 1\n\n[owners]\n");
    s.push_str(&format!("root = \"{root_owner}\"\n"));
    for k in kinds {
        s.push_str(&format!(
            "\n[[owners.kinds]]\npattern = \"{}\"\nid = \"{}\"\nmanifest = {}\n",
            k.pattern, k.id, k.manifest
        ));
    }
    s.push_str(concat!(
        "\n# Plain markdown outside documents whose <!-- spec:count --> markers N1 keeps current.\n",
        "# [check]\n",
        "# count_paths = [\"README.md\", \"docs/**/*.md\"]\n",
    ));
    s
}

#[cfg(test)]
mod tests {
    #[test]
    fn the_starter_shows_count_paths_commented_out_and_still_parses() {
        let s = super::render("ws", &[]);
        assert!(s.contains("# count_paths = ["), "{s}");
        let v: toml::Value = toml::from_str(&s).unwrap();
        assert!(v.get("check").is_none());
    }
}