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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Starter import maps for layouts other ADR tools write. They are printed for the project to
//! edit, never applied directly: custom templates and statuses vary.

pub const NAMES: &[&str] = &["adr-tools", "madr", "log4brains"];

pub fn get(name: &str) -> Option<&'static str> {
    match name {
        "adr-tools" => Some(ADR_TOOLS),
        "madr" => Some(MADR),
        "log4brains" => Some(LOG4BRAINS),
        _ => None,
    }
}

const ADR_TOOLS: &str = r##"# Starter import map for adr-tools (doc/adr/NNNN-title.md; see .adr-dir if moved).
# Edit it, then: spec import --map import.toml
# Applying needs `[aliases] file = ".spec/_aliases.tsv"` in spec.toml (old names resolve through it).
stem_aliases = true             # links name old files: 0001-record-architecture-decisions.md
strip_title_number = true       # "# 1. Record architecture decisions" -> "Record architecture decisions"

[status]
accepted = "active"
proposed = "draft"
rejected = "rejected"
deprecated = "superseded"
"superceded by" = "superseded"  # adr-tools' spelling
"superseded by" = "superseded"

[body]
status = "section:Status"
date = "line:Date"

drop_status_section = false     # true removes the Status section once it is in frontmatter

[body.links]
Supercedes = "supersedes"       # both spellings: adr-tools writes "Supercedes"
Supersedes = "supersedes"
"Superceded by" = "-"           # the newer record lists it
"Superseded by" = "-"

[[sources]]
glob = "doc/adr/*.md"
exclude = ["doc/adr/README.md", "doc/adr/index.md"]
type = "adr"
key = "created"
name = '^(?P<alias>\d{4})-(?P<slug>.+)\.md$'
"##;

const MADR: &str = r##"# Starter import map for MADR (2.x: docs/adr with "* Status:" bullets; 3.x and 4.x:
# docs/decisions with frontmatter). Edit it, then: spec import --map import.toml
# Applying needs `[aliases] file = ".spec/_aliases.tsv"` in spec.toml (old names resolve through it).
# "superseded by [ADR-0005](0005-x.md)" adds rel.supersedes to 0005 when it is in the same import.
stem_aliases = true
strip_title_number = true

[status]
accepted = "active"
proposed = "draft"
rejected = "rejected"
deprecated = "superseded"
superseded = "superseded"

[[status_patterns]]             # "superseded by ADR-0005" / "superseded by [ADR-0005](0005-x.md)"
pattern = '^superseded by\b(?P<by>.*)$'
status = "superseded"

[body]                          # MADR 2 only; frontmatter wins where it exists
status = "bullet:Status"
date = "bullet:Date"

[[sources]]
glob = "docs/decisions/*.md"
exclude = ["docs/decisions/README.md", "docs/decisions/index.md", "docs/decisions/adr-template*.md"]
type = "adr"
key = "created"
name = '^(?P<alias>\d{4})-(?P<slug>.+)\.md$'

[[sources]]
glob = "docs/adr/*.md"
exclude = ["docs/adr/README.md", "docs/adr/index.md", "docs/adr/template.md"]
type = "adr"
key = "created"
name = '^(?P<alias>\d{4})-(?P<slug>.+)\.md$'
"##;

const LOG4BRAINS: &str = r##"# Starter import map for Log4brains (docs/adr/YYYYMMDD-title.md, and
# packages/<name>/docs/adr for package records). Edit it, then: spec import --map import.toml
# Applying needs `[aliases] file = ".spec/_aliases.tsv"` in spec.toml (old names resolve through it).
stem_aliases = true

[status]
accepted = "active"
proposed = "draft"
draft = "draft"
rejected = "rejected"
deprecated = "superseded"
"superseded by" = "superseded"

[body]
status = "bullet:Status"
date = "bullet:Date"

[[sources]]
glob = "docs/adr/*.md"
exclude = ["docs/adr/README.md", "docs/adr/index.md", "docs/adr/template.md"]
type = "adr"
key = "name"
name = '^(?P<key>\d{8})-(?P<slug>.+)\.md$'

[[sources]]
glob = "packages/*/docs/adr/*.md"
exclude = ["packages/*/docs/adr/README.md", "packages/*/docs/adr/index.md", "packages/*/docs/adr/template.md"]
type = "adr"
key = "name"
name = '^(?P<key>\d{8})-(?P<slug>.+)\.md$'
"##;

#[cfg(test)]
mod tests {
    #[test]
    fn every_preset_is_a_valid_map() {
        for n in super::NAMES {
            let m: crate::import::ImportMap =
                toml::from_str(super::get(n).unwrap()).unwrap_or_else(|e| panic!("{n}: {e}"));
            assert!(!m.sources.is_empty(), "{n}");
        }
    }
}