h2m 0.3.1

HTML to Markdown converter.
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

//! Built-in `CommonMark` conversion rules.

mod blockquote;
mod code_block;
mod emphasis;
mod heading;
mod horizontal_rule;
mod iframe;
mod image;
mod inline_code;
mod line_break;
mod link;
mod list;
mod paragraph;
mod strong;

use crate::converter::{ConverterBuilder, Plugin};

/// Wraps each non-empty line with `delimiter` so that bold/italic spanning
/// multiple lines is rendered correctly.
///
/// Shared by [`strong::Strong`] and [`emphasis::Emphasis`].
pub(crate) fn wrap_delimiter_per_line(text: &str, delimiter: &str) -> String {
    if !text.contains('\n') {
        return format!("{delimiter}{text}{delimiter}");
    }

    let mut result = String::with_capacity(text.len() + delimiter.len() * 4);
    for (i, line) in text.split('\n').enumerate() {
        if i > 0 {
            result.push('\n');
        }
        let trimmed = line.trim();
        if trimmed.is_empty() {
            continue;
        }
        result.push_str(delimiter);
        result.push_str(trimmed);
        result.push_str(delimiter);
    }
    result
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn wrap_single_line() {
        assert_eq!(wrap_delimiter_per_line("bold", "**"), "**bold**");
    }

    #[test]
    fn wrap_multiline() {
        assert_eq!(
            wrap_delimiter_per_line("line1\nline2", "**"),
            "**line1**\n**line2**"
        );
    }

    #[test]
    fn wrap_multiline_preserves_blank_line() {
        assert_eq!(
            wrap_delimiter_per_line("line1\n\nline2", "**"),
            "**line1**\n\n**line2**"
        );
    }

    #[test]
    fn wrap_single_char_delimiter() {
        assert_eq!(wrap_delimiter_per_line("text", "*"), "*text*");
    }
}

/// The `CommonMark` plugin — registers all built-in rules for standard HTML
/// tags.
///
/// This plugin handles headings, paragraphs, emphasis, strong, inline code,
/// code blocks, links, images, lists, blockquotes, horizontal rules, and
/// line breaks.
#[derive(Debug, Clone, Copy)]
#[allow(clippy::exhaustive_structs)]
pub struct CommonMark;

impl Plugin for CommonMark {
    fn register(&self, builder: &mut ConverterBuilder) {
        builder.add_rule(paragraph::Paragraph);
        builder.add_rule(heading::Heading);
        builder.add_rule(code_block::CodeBlock);
        builder.add_rule(blockquote::Blockquote);
        builder.add_rule(list::List);
        builder.add_rule(list::ListItem);
        builder.add_rule(horizontal_rule::HorizontalRule);
        builder.add_rule(line_break::LineBreak);
        builder.add_rule(strong::Strong);
        builder.add_rule(emphasis::Emphasis);
        builder.add_rule(inline_code::InlineCode);
        builder.add_rule(link::Link);
        builder.add_rule(image::Image);
        builder.add_rule(iframe::Iframe);
    }
}