pegmd 0.2.3

A PEG based markdown parser for creating an Abstract Syntax Tree
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

use crate::error::ParseError;
use crate::first_child;
use crate::parser::{MarkdownParser, Rule};
use pest::Parser;

use self::model::Node;

mod macros;

pub mod model;
pub mod traversal;

/// Generate an abstract syntax tree (AST) for the markdown document. Since the AST nodes
/// store segments of the slice in their leaves, the lifetime of the AST is tied to that of
/// the input.
///
/// ### Parameters
/// - `input` - The markdown source.
///
///  
/// ### Returns
/// A result that on success contains the root of the AST, and on failure a [`ParseError`].
pub fn parse_document(input: &str) -> Result<Node<'_>, ParseError> {
    let mut raw_tokens = MarkdownParser::parse(Rule::document, input)?;
    let document = Node::try_from(first_child!(raw_tokens)?)?;
    Ok(document)
}

#[cfg(all(feature = "serde_support", test))]
pub mod test {
    use super::*;
    use crate::test_utils::read_file_to_string;
    use pretty_assertions::assert_eq;

    #[test]
    pub fn markup_test() {
        let input = read_file_to_string("markdown/markup.md");
        let root =
            parse_document(&input).unwrap_or_else(|e| panic!("Failed to parse document: {e}"));
        let actual = serde_json::to_string_pretty(&root)
            .unwrap_or_else(|e| panic!("Failed to serialize AST: {e}"));
        let expected = read_file_to_string("ast_json/markup.json");
        assert_eq!(&actual, &expected);
    }

    #[test]
    pub fn list_test() {
        let input = read_file_to_string("markdown/lists.md");
        let document =
            parse_document(&input).unwrap_or_else(|e| panic!("Failed to parse document: {e:?}"));
        let actual = serde_json::to_string_pretty(&document)
            .unwrap_or_else(|e| panic!("Failed to serialize AST: {e}"));
        let expected = read_file_to_string("ast_json/lists.json");
        assert_eq!(&actual, &expected);
    }

    #[test]
    pub fn blocks_test() {
        let input = read_file_to_string("markdown/blocks.md");
        let document =
            parse_document(&input).unwrap_or_else(|e| panic!("Failed to parse document: {e:?}"));
        let actual = serde_json::to_string_pretty(&document)
            .unwrap_or_else(|e| panic!("Failed to serialize AST: {e}"));
        let expected = read_file_to_string("ast_json/blocks.json");

        assert_eq!(&actual, &expected);
    }
}