h2m 0.6.0

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
103

//! Code block (`<pre>`) conversion rule.

use std::fmt::Write;

use scraper::ElementRef;

use crate::context::Context;
use crate::converter::{Action, Rule};
use crate::dom;
use crate::options::CodeBlockStyle;

/// Handles `<pre>` elements (typically containing a `<code>` child).
#[derive(Debug, Clone, Copy)]
pub(super) struct CodeBlock;

impl Rule for CodeBlock {
    fn tags(&self) -> &'static [&'static str] {
        &["pre"]
    }

    fn apply(&self, content: &str, element: &ElementRef<'_>, ctx: &mut Context<'_>) -> Action {
        match ctx.options().code_block_style() {
            CodeBlockStyle::Fenced => Self::fenced(content, element, ctx),
            CodeBlockStyle::Indented => Self::indented(content),
        }
    }
}

impl CodeBlock {
    /// Renders a fenced code block.
    fn fenced(content: &str, element: &ElementRef<'_>, ctx: &Context<'_>) -> Action {
        let language = detect_language(element);
        let fence_char = ctx.options().fence().char();

        // Calculate fence length: must exceed longest consecutive run of the
        // fence character in the content.
        let max_run = dom::max_consecutive_char(content, fence_char);
        let fence_len = std::cmp::max(3, max_run + 1);
        let lang_tag = language.as_deref().unwrap_or_default();

        // Trim a single leading/trailing newline from content (html5ever often
        // leaves one).
        let without_prefix = content.strip_prefix('\n').unwrap_or(content);
        let trimmed = without_prefix.strip_suffix('\n').unwrap_or(without_prefix);

        let mut md = String::with_capacity(trimmed.len() + lang_tag.len() + fence_len * 2 + 6);
        md.push_str("\n\n");
        md.extend(std::iter::repeat_n(fence_char, fence_len));
        md.push_str(lang_tag);
        md.push('\n');
        md.push_str(trimmed);
        md.push('\n');
        md.extend(std::iter::repeat_n(fence_char, fence_len));
        md.push_str("\n\n");

        Action::Replace(md)
    }

    /// Renders an indented code block (4-space indent).
    fn indented(content: &str) -> Action {
        let mut result = String::with_capacity(content.len() + content.lines().count() * 4 + 4);
        result.push_str("\n\n");
        for (i, line) in content.lines().enumerate() {
            if i > 0 {
                result.push('\n');
            }
            _ = write!(result, "    {line}");
        }
        result.push_str("\n\n");
        Action::Replace(result)
    }
}

/// Attempts to detect the programming language from a `<code>` child's
/// `class` attribute (e.g., `class="language-rust"` or `class="lang-js"`).
fn detect_language(pre: &ElementRef<'_>) -> Option<String> {
    for child in pre.children() {
        let Some(el) = child.value().as_element() else {
            continue;
        };
        if el.name() != "code" {
            continue;
        }
        let Some(class) = el.attr("class") else {
            continue;
        };
        for cls in class.split_whitespace() {
            if let Some(lang) = cls
                .strip_prefix("language-")
                .or_else(|| cls.strip_prefix("lang-"))
            {
                return Some(lang.to_owned());
            }
        }
        // Fall back to the first class as the language.
        return class
            .split_whitespace()
            .next()
            .filter(|f| !f.is_empty())
            .map(str::to_owned);
    }
    None
}