govctl 0.15.0

Project governance CLI for RFC, ADR, and Work Item management
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

//! SSOT to Markdown rendering.
//!
//! Implements [[ADR-0003]] signatures and [[ADR-0011]] inline reference expansion.
//!
//! Rendered markdown files are read-only projections. Each includes:
//! - A "GENERATED" comment warning not to edit
//! - A SHA-256 signature for tampering detection
//! - Inline `[[artifact-id]]` references expanded to markdown links

mod adr;
mod links;
mod output;
mod rfc;
#[cfg(test)]
mod tests;
mod work;

#[cfg(test)]
pub use adr::render_adr;
pub use adr::{render_adr_with_projection, write_adr_md};
pub use links::expand_inline_refs;
use links::render_refs;
use output::write_expanded_rendered_md;
#[cfg(test)]
pub use rfc::render_clause;
pub use rfc::{render_clause_with_projection, render_rfc_with_projection, write_rfc};
pub use work::{render_work_item, render_work_item_with_projection, write_work_item_md};

/// Selects whether lifecycle-obsolete body content is included in human-readable output.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum RenderProjection {
    Current,
    Archive,
}

pub fn ref_link_from_root(ref_id: &str, docs_output: &str) -> String {
    links::ref_link_from_root(ref_id, docs_output)
}

pub fn expand_inline_refs_from_root(text: &str, pattern: &str, docs_output: &str) -> String {
    links::expand_inline_refs_with_linker(text, pattern, |ref_id| {
        ref_link_from_root(ref_id, docs_output)
    })
}