ferromark 0.7.0

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
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
144
145
146
147
148
149
150
151
152

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

#[test]
fn minimal_should_disable_every_optional_syntax_feature() {
    let options = Options::minimal();

    assert_eq!(
        options,
        Options {
            render_policy: RenderPolicy::Untrusted,
            allow_html: false,
            allow_link_refs: false,
            tables: false,
            merged_table_cells: false,
            table_column_widths: false,
            strikethrough: false,
            highlight: false,
            superscript: false,
            subscript: false,
            task_lists: false,
            autolink_literals: false,
            disallowed_raw_html: false,
            footnotes: false,
            inline_footnotes: false,
            front_matter: false,
            heading_ids: false,
            math: false,
            callouts: false,
            definition_lists: false,
            line_comments: false,
            indented_code_blocks: true,
            link_base_path: None,
        }
    );
}

#[test]
fn commonmark_should_enable_only_commonmark_syntax_boundaries() {
    let options = Options::commonmark();

    assert!(options.allow_html && options.allow_link_refs);
    assert_eq!(
        options,
        Options {
            allow_html: true,
            allow_link_refs: true,
            ..Options::minimal()
        }
    );
}

#[test]
fn gfm_should_extend_commonmark_with_exact_gfm_extensions() {
    let options = Options::gfm();

    assert_eq!(
        options,
        Options {
            tables: true,
            strikethrough: true,
            task_lists: true,
            autolink_literals: true,
            disallowed_raw_html: true,
            ..Options::commonmark()
        }
    );
}

#[test]
fn syntax_presets_should_keep_untrusted_rendering() {
    for options in [Options::minimal(), Options::commonmark(), Options::gfm()] {
        assert_eq!(options.render_policy, RenderPolicy::Untrusted);
    }
}

#[test]
fn default_should_retain_the_existing_feature_mix() {
    assert_eq!(
        Options::default(),
        Options {
            render_policy: RenderPolicy::Untrusted,
            allow_html: true,
            allow_link_refs: true,
            tables: true,
            merged_table_cells: false,
            table_column_widths: false,
            strikethrough: true,
            highlight: false,
            superscript: false,
            subscript: false,
            task_lists: true,
            autolink_literals: false,
            disallowed_raw_html: true,
            footnotes: false,
            inline_footnotes: false,
            front_matter: false,
            heading_ids: true,
            math: false,
            callouts: true,
            definition_lists: false,
            line_comments: false,
            indented_code_blocks: true,
            link_base_path: None,
        }
    );
}

#[test]
fn minimal_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::minimal());

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

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

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

#[test]
fn commonmark_should_parse_html_without_implicitly_trusting_it() {
    let markdown = "<div>content</div>";
    let untrusted = to_html_with_options(markdown, &Options::commonmark());
    let trusted = to_html_with_options(
        markdown,
        &Options {
            render_policy: RenderPolicy::Trusted,
            ..Options::commonmark()
        },
    );

    assert_eq!(untrusted, "&lt;div&gt;content&lt;/div&gt;");
    assert_eq!(trusted, "<div>content</div>");
}

#[test]
fn gfm_should_render_its_extension_set() {
    let markdown =
        "~~done~~ at https://example.com\n\n- [x] shipped\n\n| A | B |\n| - | - |\n| 1 | 2 |";
    let html = to_html_with_options(markdown, &Options::gfm());

    assert!(
        html.contains("<del>done</del>")
            && html.contains("<a href=\"https://example.com\">")
            && html.contains("type=\"checkbox\"")
            && html.contains("<table>")
    );
}