mdforge 0.1.0

Define, validate, and render typed Markdown extensions for LLM-generated content.
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

use crate::ast::ArgSpec;

use super::{BlockSpec, Forge, InlineSpec};

#[derive(Debug, Clone, Default)]
/// Builder for registering mdforge block and inline extensions.
pub struct ForgeBuilder {
    blocks: Vec<BlockSpec>,
    inlines: Vec<InlineSpec>,
}

impl ForgeBuilder {
    /// Start defining a block extension.
    pub fn block(self, name: impl Into<String>) -> BlockBuilder {
        BlockBuilder {
            parent: self,
            name: name.into(),
            args: Vec::new(),
            body_markdown: false,
        }
    }

    /// Start defining an inline extension.
    pub fn inline(self, name: impl Into<String>) -> InlineBuilder {
        InlineBuilder {
            parent: self,
            name: name.into(),
            args: Vec::new(),
        }
    }

    /// Finish the schema and return a [`Forge`].
    pub fn build(self) -> Forge {
        Forge {
            blocks: self.blocks,
            inlines: self.inlines,
        }
    }
}

#[derive(Debug, Clone)]
/// Builder for a single block extension.
pub struct BlockBuilder {
    parent: ForgeBuilder,
    name: String,
    args: Vec<(String, ArgSpec)>,
    body_markdown: bool,
}

impl BlockBuilder {
    /// Add an argument to the block definition.
    pub fn arg(mut self, name: impl Into<String>, spec: ArgSpec) -> Self {
        self.args.push((name.into(), spec));
        self
    }

    /// Mark this block body as Markdown.
    pub fn body_markdown(mut self) -> Self {
        self.body_markdown = true;
        self
    }

    /// Register the block and return to the parent [`ForgeBuilder`].
    pub fn register(self) -> ForgeBuilder {
        let mut parent = self.parent;
        parent.blocks.push(BlockSpec {
            name: self.name,
            args: self.args,
            body_markdown: self.body_markdown,
        });
        parent
    }
}

#[derive(Debug, Clone)]
/// Builder for a single inline extension.
pub struct InlineBuilder {
    parent: ForgeBuilder,
    name: String,
    args: Vec<(String, ArgSpec)>,
}

impl InlineBuilder {
    /// Add an argument to the inline definition.
    pub fn arg(mut self, name: impl Into<String>, spec: ArgSpec) -> Self {
        self.args.push((name.into(), spec));
        self
    }

    /// Register the inline and return to the parent [`ForgeBuilder`].
    pub fn register(self) -> ForgeBuilder {
        let mut parent = self.parent;
        parent.inlines.push(InlineSpec {
            name: self.name,
            args: self.args,
        });
        parent
    }
}