ferromark 0.3.3

Ultra-high-performance Markdown to HTML compiler
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

use ferromark::{Options, Profile, RenderPolicy, to_html_with_options};

#[test]
fn essentials_should_enable_everyday_markdown_extensions() {
    let options = Options::from(Profile::Essentials);

    assert!(options.tables && options.strikethrough && options.task_lists);
}

#[test]
fn essentials_should_disable_expensive_and_specialized_features() {
    let options = Options::from(Profile::Essentials);

    assert!(
        !options.allow_html
            && !options.allow_link_refs
            && !options.autolink_literals
            && !options.footnotes
            && !options.front_matter
            && !options.heading_ids
            && !options.math
            && !options.callouts
            && !options.highlight
            && !options.subscript
            && !options.superscript
    );
}

#[test]
fn extended_should_match_the_existing_default_contract() {
    assert_eq!(Options::from(Profile::Extended), Options::default());
}

#[test]
fn full_should_enable_every_supported_feature() {
    let options = Options::from(Profile::Full);

    assert!(
        options.allow_html
            && options.allow_link_refs
            && options.tables
            && options.strikethrough
            && options.highlight
            && options.superscript
            && options.subscript
            && options.task_lists
            && options.autolink_literals
            && options.disallowed_raw_html
            && options.footnotes
            && options.front_matter
            && options.heading_ids
            && options.math
            && options.callouts
    );
}

#[test]
fn profiles_should_keep_untrusted_rendering() {
    for profile in [Profile::Essentials, Profile::Extended, Profile::Full] {
        assert_eq!(
            Options::from(profile).render_policy,
            RenderPolicy::Untrusted
        );
    }
}

#[test]
fn essentials_should_render_its_extension_set() {
    let markdown = "~~done~~\n\n- [x] shipped\n\n| A | B |\n| - | - |\n| 1 | 2 |";
    let html = to_html_with_options(markdown, &Options::from(Profile::Essentials));

    assert!(
        html.contains("<del>done</del>")
            && html.contains("type=\"checkbox\"")
            && html.contains("<table>")
    );
}

#[test]
fn essentials_should_leave_reference_links_unresolved() {
    let markdown = "Read [the guide][guide].\n\n[guide]: https://example.com";
    let html = to_html_with_options(markdown, &Options::from(Profile::Essentials));

    assert!(!html.contains("href=\"https://example.com\""));
}

#[test]
fn extended_should_resolve_reference_links() {
    let markdown = "Read [the guide][guide].\n\n[guide]: https://example.com";
    let html = to_html_with_options(markdown, &Options::from(Profile::Extended));

    assert!(html.contains("href=\"https://example.com\""));
}

#[test]
fn full_should_render_specialized_extensions() {
    let markdown = "==mark== and H~2~O and x^2^ and $a+b$.";
    let html = to_html_with_options(markdown, &Options::from(Profile::Full));

    assert!(
        html.contains("<mark>mark</mark>")
            && html.contains("<sub>2</sub>")
            && html.contains("<sup>2</sup>")
            && html.contains("class=\"language-math math-inline\"")
    );
}