yamd 0.18.1

Yet Another Markdown Document (flavour)
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

use std::fmt::Display;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use super::Anchor;

#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(tag = "type", content = "value"))]
pub enum HeadingNodes {
    Text(String),
    Anchor(Anchor),
}

impl From<String> for HeadingNodes {
    fn from(text: String) -> Self {
        Self::Text(text)
    }
}

impl From<Anchor> for HeadingNodes {
    fn from(anchor: Anchor) -> Self {
        Self::Anchor(anchor)
    }
}

impl Display for HeadingNodes {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            HeadingNodes::Text(text) => {
                write!(f, "{}", text.replace("\n\n", "\\\n\n").replace("#", "\\#"))
            }
            HeadingNodes::Anchor(anchor) => write!(f, "{}", anchor),
        }
    }
}

/// # Heading
///
/// Starts with [Hash](type@crate::lexer::TokenKind::Hash) of length < 7, followed by
/// [Space](type@crate::lexer::TokenKind::Space).
///
/// [Level](Heading::level) is determined by the amount of [Hash](type@crate::lexer::TokenKind::Hash)'es
/// before [Space](type@crate::lexer::TokenKind::Space).
///
/// [Body](Heading::body) can contain one or more:
///
/// - [Anchor]
/// - [String]
///
/// Example:
///
/// ```text
/// ### Header can contain an [anchor](#) or regular text.
/// ```
///
/// HTML equivalent:
///
/// ```html
/// <h3>Header can contain an <a href="#">anchor</a> or regular text.</h3>
/// ```
#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Heading {
    pub level: u8,
    pub body: Vec<HeadingNodes>,
}

impl Heading {
    pub fn new(level: u8, nodes: Vec<HeadingNodes>) -> Self {
        Self { level, body: nodes }
    }
}

impl Display for Heading {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} ", "#".repeat(self.level as usize))?;
        for node in &self.body {
            write!(f, "{}", node)?;
        }
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use crate::nodes::{Anchor, Heading, HeadingNodes};

    #[test]
    fn heading() {
        let heading = Heading::new(
            3,
            vec![
                HeadingNodes::from("Header can contain an ".to_string()),
                HeadingNodes::from(Anchor::new("anchor".to_string(), "#".to_string())),
                HeadingNodes::from(" or regular text.".to_string()),
            ],
        );
        assert_eq!(
            heading.to_string(),
            "### Header can contain an [anchor](#) or regular text."
        );
    }

    #[test]
    fn heading_with_hash() {
        let heading = Heading::new(3, vec![HeadingNodes::from("# ##".to_string())]);
        assert_eq!(heading.to_string(), "### \\# \\#\\#");
    }
}