socketry-markdown 0.5.0

CommonMark compliant markdown parser in Rust with ASTs and extensions
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use super::{
    check_bullet::check_bullet, check_bullet_ordered::check_bullet_ordered,
    check_bullet_other::check_bullet_other, check_emphasis::check_emphasis,
    check_fence::check_fence, check_quote::check_quote, check_rule::check_rule,
    check_rule_repetition::check_rule_repetition, check_strong::check_strong,
};
use crate::markdown::{state::State, Options};

#[test]
fn validates_markdown_serialization_markers() {
    let options = Options::default();
    let mut state = State::new(&options);
    assert_eq!(check_bullet(&mut state).unwrap(), '-');
    assert_eq!(check_bullet_ordered(&mut state).unwrap(), '.');
    assert_eq!(check_bullet_other(&mut state).unwrap(), '*');
    assert_eq!(check_emphasis(&state).unwrap(), '*');
    assert_eq!(check_fence(&mut state).unwrap(), '`');
    assert_eq!(check_quote(&state).unwrap(), '"');
    assert_eq!(check_rule(&state).unwrap(), '*');
    assert_eq!(check_rule_repetition(&state).unwrap(), 3);
    assert_eq!(check_strong(&state).unwrap(), '*');

    for bullet in ['+', '-'] {
        let options = Options {
            bullet,
            ..Options::default()
        };
        assert_eq!(check_bullet(&mut State::new(&options)).unwrap(), bullet);
    }

    for bullet in ['.', ')'] {
        let options = Options {
            bullet_ordered: bullet,
            ..Options::default()
        };
        assert_eq!(
            check_bullet_ordered(&mut State::new(&options)).unwrap(),
            bullet
        );
    }

    let options = Options {
        bullet: '+',
        bullet_other: '-',
        ..Options::default()
    };
    assert_eq!(check_bullet_other(&mut State::new(&options)).unwrap(), '*');

    for marker in ['_', '*'] {
        let options = Options {
            emphasis: marker,
            strong: marker,
            ..Options::default()
        };
        let state = State::new(&options);
        assert_eq!(check_emphasis(&state).unwrap(), marker);
        assert_eq!(check_strong(&state).unwrap(), marker);
    }

    let options = Options {
        fence: '~',
        quote: '\'',
        rule: '-',
        rule_repetition: 4,
        ..Options::default()
    };
    let state = State::new(&options);
    assert_eq!(check_fence(&mut State::new(&options)).unwrap(), '~');
    assert_eq!(check_quote(&state).unwrap(), '\'');
    assert_eq!(check_rule(&state).unwrap(), '-');
    assert_eq!(check_rule_repetition(&state).unwrap(), 4);

    let invalid = Options {
        bullet: 'x',
        ..Options::default()
    };
    assert!(check_bullet(&mut State::new(&invalid)).is_err());

    let invalid = Options {
        bullet_ordered: 'x',
        ..Options::default()
    };
    assert!(check_bullet_ordered(&mut State::new(&invalid)).is_err());

    let invalid = Options {
        bullet: '*',
        bullet_other: 'x',
        ..Options::default()
    };
    assert!(check_bullet_other(&mut State::new(&invalid)).is_err());

    let invalid = Options {
        bullet: 'x',
        bullet_other: '-',
        ..Options::default()
    };
    assert!(check_bullet_other(&mut State::new(&invalid)).is_err());

    let invalid = Options {
        bullet: '*',
        bullet_other: '*',
        ..Options::default()
    };
    assert!(check_bullet_other(&mut State::new(&invalid)).is_err());

    for options in [
        Options {
            emphasis: 'x',
            ..Options::default()
        },
        Options {
            strong: 'x',
            ..Options::default()
        },
        Options {
            fence: 'x',
            ..Options::default()
        },
        Options {
            quote: 'x',
            ..Options::default()
        },
        Options {
            rule: 'x',
            ..Options::default()
        },
        Options {
            rule_repetition: 2,
            ..Options::default()
        },
    ] {
        let mut state = State::new(&options);
        assert!(check_emphasis(&state).is_err() || options.emphasis == '*');
        assert!(check_strong(&state).is_err() || options.strong == '*');
        assert!(check_fence(&mut state).is_err() || options.fence == '`');
        assert!(check_quote(&state).is_err() || options.quote == '"');
        assert!(check_rule(&state).is_err() || options.rule == '*');
        assert!(check_rule_repetition(&state).is_err() || options.rule_repetition == 3);
    }
}