ferromark 0.1.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
107
108
109
110
111
112
113
114
115
116
117
118
119

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

fn html_with_ids(input: &str) -> String {
    let options = Options {
        heading_ids: true,
        ..Options::default()
    };
    to_html_with_options(input, &options)
}

fn html_without_ids(input: &str) -> String {
    let options = Options {
        heading_ids: false,
        ..Options::default()
    };
    to_html_with_options(input, &options)
}

#[test]
fn test_basic_heading_id() {
    let html = html_with_ids("# Hello World");
    assert_eq!(html, "<h1 id=\"hello-world\">Hello World</h1>\n");
}

#[test]
fn test_heading_with_emphasis() {
    let html = html_with_ids("## Hello **World**");
    assert!(html.contains("id=\"hello-world\""), "Got: {html}");
}

#[test]
fn test_heading_with_code() {
    let html = html_with_ids("## The `code` function");
    assert!(html.contains("id=\"the-code-function\""), "Got: {html}");
}

#[test]
fn test_duplicate_headings() {
    let html = html_with_ids("# Hello\n\n# Hello\n\n# Hello");
    assert!(html.contains("id=\"hello\""), "First heading");
    assert!(html.contains("id=\"hello-1\""), "Second heading: {html}");
    assert!(html.contains("id=\"hello-2\""), "Third heading: {html}");
}

#[test]
fn test_heading_preserves_unicode() {
    let html = html_with_ids("# Héllo Wörld");
    assert!(html.contains("id=\"héllo-wörld\""), "Got: {html}");
}

#[test]
fn test_heading_underscore_hyphen() {
    let html = html_with_ids("# foo_bar-baz");
    assert!(html.contains("id=\"foo_bar-baz\""), "Got: {html}");
}

#[test]
fn test_heading_ids_disabled() {
    let html = html_without_ids("# Hello World");
    assert_eq!(html, "<h1>Hello World</h1>\n");
    assert!(!html.contains("id="));
}

#[test]
fn test_setext_heading_gets_id() {
    let html = html_with_ids("Hello World\n===========");
    assert!(html.contains("id=\"hello-world\""), "Got: {html}");
}

#[test]
fn test_heading_all_levels() {
    for level in 1..=6 {
        let input = format!("{} Test Heading", "#".repeat(level));
        let html = html_with_ids(&input);
        assert!(
            html.contains(&format!("<h{level} id=\"test-heading\">")),
            "Level {level}: {html}"
        );
    }
}

#[test]
fn test_heading_strips_special_chars() {
    let html = html_with_ids("# Hello, World! (2024)");
    // Commas, exclamation, parens stripped
    assert!(html.contains("id=\"hello-world-2024\""), "Got: {html}");
}

#[test]
fn test_heading_with_numbers() {
    let html = html_with_ids("# Section 42");
    assert!(html.contains("id=\"section-42\""), "Got: {html}");
}

#[test]
fn test_heading_default_options_have_ids() {
    // Default options should have heading_ids = true
    let html = to_html("# Hello");
    assert!(html.contains("id=\"hello\""), "Got: {html}");
}

#[test]
fn test_empty_heading() {
    let html = html_with_ids("# ");
    // Empty heading after stripping should get fallback
    assert!(html.contains("id=\"heading\""), "Got: {html}");
}

#[test]
fn test_heading_leading_trailing_spaces() {
    let html = html_with_ids("# Hello World");
    assert!(html.contains("id=\"hello-world\""), "Got: {html}");
}

#[test]
fn test_heading_mixed_case() {
    let html = html_with_ids("# Hello WORLD FoO");
    assert!(html.contains("id=\"hello-world-foo\""), "Got: {html}");
}