mq-markdown 0.5.26

#[cfg(feature = "html-to-markdown")]
use crate::html_to_markdown;
#[cfg(feature = "html-to-markdown")]
use crate::html_to_markdown::ConversionOptions;
use crate::node::{ColorTheme, Node, Position, RenderOptions, TableAlign, TableCell, render_values};
use markdown::Constructs;
use miette::miette;
use std::{fmt, str::FromStr};

#[derive(Debug, Clone)]
pub struct Markdown {
    pub nodes: Vec<Node>,
    pub options: RenderOptions,
}

impl FromStr for Markdown {
    type Err = miette::Error;

    fn from_str(content: &str) -> Result<Self, Self::Err> {
        Self::from_markdown_str(content)
    }
}

impl fmt::Display for Markdown {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.render_with_theme(&ColorTheme::PLAIN))
    }
}

impl Markdown {
    pub fn new(nodes: Vec<Node>) -> Self {
        Self {
            nodes,
            options: RenderOptions::default(),
        }
    }

    pub fn set_options(&mut self, options: RenderOptions) {
        self.options = options;
    }

    /// Returns a colored string representation of the markdown using ANSI escape codes.
    #[cfg(feature = "color")]
    pub fn to_colored_string(&self) -> String {
        self.render_with_theme(&ColorTheme::COLORED)
    }

    /// Returns a colored string representation using the given color theme.
    #[cfg(feature = "color")]
    pub fn to_colored_string_with_theme(&self, theme: &ColorTheme<'_>) -> String {
        self.render_with_theme(theme)
    }

    fn render_with_theme(&self, theme: &ColorTheme<'_>) -> String {
        let mut pre_position: Option<Position> = None;
        let mut is_first = true;
        let mut current_table_row: Option<usize> = None;
        let mut in_table = false;

        let mut buffer = String::with_capacity(self.nodes.len() * 50);

        for (i, node) in self.nodes.iter().enumerate() {
            if let Node::TableCell(TableCell { row, values, .. }) = node {
                let value = render_values(values, &self.options, theme);

                let is_new_row = current_table_row != Some(*row);

                if is_new_row {
                    if current_table_row.is_some() {
                        buffer.push_str("|\n");
                    } else if !in_table && let Some(pos) = node.position() {
                        // Insert newlines before the first row of a table
                        let new_line_count = pre_position
                            .as_ref()
                            .map(|p| pos.start.line.saturating_sub(p.end.line))
                            .unwrap_or_else(|| if is_first { 0 } else { 1 })
                            .min(2);
                        for _ in 0..new_line_count {
                            buffer.push('\n');
                        }
                    }
                    current_table_row = Some(*row);
                }

                buffer.push('|');
                buffer.push_str(&value);

                let next_node = self.nodes.get(i + 1);
                let next_is_different_row = next_node.is_none_or(
                    |next| !matches!(next, Node::TableCell(TableCell { row: next_row, .. }) if *next_row == *row),
                );

                if next_is_different_row {
                    buffer.push_str("|\n");
                    current_table_row = None;
                }

                pre_position = node.position();
                is_first = false;
                in_table = true;
                continue;
            }

            if let Node::TableAlign(TableAlign { align, .. }) = node {
                use itertools::Itertools;
                buffer.push('|');
                buffer.push_str(&align.iter().map(|a| a.to_string()).join("|"));
                buffer.push_str("|\n");
                pre_position = node.position();
                is_first = false;
                in_table = true;
                continue;
            }

            current_table_row = None;
            in_table = false;

            let value = node.render_with_theme(&self.options, theme);

            if value.is_empty() || value == "\n" {
                pre_position = None;
                continue;
            }

            if let Some(pos) = node.position() {
                let new_line_count = pre_position
                    .as_ref()
                    .map(|p| pos.start.line.saturating_sub(p.end.line))
                    .unwrap_or_else(|| if is_first { 0 } else { 1 })
                    .min(2);

                pre_position = Some(pos.clone());

                for _ in 0..new_line_count {
                    buffer.push('\n');
                }
                buffer.push_str(&value);
            } else {
                if !is_first {
                    buffer.push('\n');
                }
                pre_position = None;
                buffer.push_str(&value);
            }

            if is_first {
                is_first = false;
            }
        }

        if buffer.is_empty() || buffer.ends_with('\n') {
            buffer
        } else {
            buffer.push('\n');
            buffer
        }
    }

    pub fn from_mdx_str(content: &str) -> miette::Result<Self> {
        let root = markdown::to_mdast(content, &markdown::ParseOptions::mdx()).map_err(|e| miette!(e.reason))?;
        let nodes = Node::from_mdast_node(root);

        Ok(Self {
            nodes,
            options: RenderOptions::default(),
        })
    }

    pub fn to_html(&self) -> String {
        markdown::to_html(self.to_string().as_str())
    }

    pub fn to_text(&self) -> String {
        let mut result = String::with_capacity(self.nodes.len() * 20); // Reasonable estimate
        for node in &self.nodes {
            result.push_str(&node.value());
            result.push('\n');
        }
        result
    }

    #[cfg(feature = "json")]
    pub fn to_json(&self) -> miette::Result<String> {
        let nodes = self
            .nodes
            .iter()
            .filter(|node| !node.is_empty() && !node.is_empty_fragment())
            .collect::<Vec<_>>();
        serde_json::to_string_pretty(&nodes).map_err(|e| miette!("Failed to serialize to JSON: {}", e))
    }

    #[cfg(feature = "html-to-markdown")]
    pub fn from_html_str(content: &str) -> miette::Result<Self> {
        Self::from_html_str_with_options(content, ConversionOptions::default())
    }

    #[cfg(feature = "html-to-markdown")]
    pub fn from_html_str_with_options(content: &str, options: ConversionOptions) -> miette::Result<Self> {
        html_to_markdown::convert_html_to_markdown(content, options)
            .map_err(|e| miette!(e))
            .and_then(|md_string| Self::from_markdown_str(&md_string))
    }

    pub fn from_markdown_str(content: &str) -> miette::Result<Self> {
        let root = markdown::to_mdast(
            content,
            &markdown::ParseOptions {
                gfm_strikethrough_single_tilde: true,
                math_text_single_dollar: true,
                mdx_expression_parse: None,
                mdx_esm_parse: None,
                constructs: Constructs {
                    attention: true,
                    autolink: true,
                    block_quote: true,
                    character_escape: true,
                    character_reference: true,
                    code_indented: true,
                    code_fenced: true,
                    code_text: true,
                    definition: true,
                    frontmatter: true,
                    gfm_autolink_literal: true,
                    gfm_label_start_footnote: true,
                    gfm_footnote_definition: true,
                    gfm_strikethrough: true,
                    gfm_table: true,
                    gfm_task_list_item: true,
                    hard_break_escape: true,
                    hard_break_trailing: true,
                    heading_atx: true,
                    heading_setext: true,
                    html_flow: true,
                    html_text: true,
                    label_start_image: true,
                    label_start_link: true,
                    label_end: true,
                    list_item: true,
                    math_flow: true,
                    math_text: true,
                    mdx_esm: false,
                    mdx_expression_flow: false,
                    mdx_expression_text: false,
                    mdx_jsx_flow: false,
                    mdx_jsx_text: false,
                    thematic_break: true,
                },
            },
        )
        .map_err(|e| miette!(e.reason))?;
        let nodes = Node::from_mdast_node(root);

        Ok(Self {
            nodes,
            options: RenderOptions::default(),
        })
    }
}

pub fn to_html(s: &str) -> String {
    markdown::to_html(s)
}

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

    use crate::{ListStyle, TitleSurroundStyle, UrlSurroundStyle};

    use super::*;

    #[rstest]
    #[case::header("# Title", 1, "# Title\n")]
    #[case::header("# Title\nParagraph", 2, "# Title\nParagraph\n")]
    #[case::header("# Title\n\nParagraph", 2, "# Title\n\nParagraph\n")]
    #[case::list("- Item 1\n- Item 2", 2, "- Item 1\n- Item 2\n")]
    #[case::quote("> Quote\n>Second line", 1, "> Quote\n> Second line\n")]
    #[case::code("```rust\nlet x = 1;\n```", 1, "```rust\nlet x = 1;\n```\n")]
    #[case::toml("+++\n[test]\ntest = 1\n+++", 1, "+++\n[test]\ntest = 1\n+++\n")]
    #[case::code_inline("`inline`", 1, "`inline`\n")]
    #[case::math_inline("$math$", 1, "$math$\n")]
    #[case::math("$$\nmath\n$$", 1, "$$\nmath\n$$\n")]
    #[case::html("<div>test</div>", 1, "<div>test</div>\n")]
    #[case::footnote("[^a]: b", 1, "[^a]: b\n")]
    #[case::definition("[a]: b", 1, "[a]: b\n")]
    #[case::footnote("[^a]: b", 1, "[^a]: b\n")]
    #[case::footnote_ref("[^a]: b\n\n[^a]", 2, "[^a]: b\n[^a]\n")]
    #[case::image("![a](b)", 1, "![a](b)\n")]
    #[case::image_with_title("![a](b \"c\")", 1, "![a](b \"c\")\n")]
    #[case::image_ref("[a]: b\n\n ![c][a]", 2, "[a]: b\n\n![c][a]\n")]
    #[case::yaml(
        "---\ntitle: Test\ndescription: YAML front matter\n---\n",
        1,
        "---\ntitle: Test\ndescription: YAML front matter\n---\n"
    )]
    #[case::link("[a](b)", 1, "[a](b)\n")]
    #[case::link_ref("[a]: b\n\n[c][a]", 2, "[a]: b\n\n[c][a]\n")]
    #[case::break_("a\\b", 1, "a\\b\n")]
    #[case::delete("~~a~~", 1, "~~a~~\n")]
    #[case::emphasis("*a*", 1, "*a*\n")]
    #[case::horizontal_rule("---", 1, "---\n")]
    #[case::table(
        "| Column1 | Column2 | Column3 |\n|:--------|:--------:|---------:|\n| Left    | Center  | Right   |\n",
        7,
        "|Column1|Column2|Column3|\n|:---|:---:|---:|\n|Left|Center|Right|\n"
    )]
    #[case::table_after_paragraph(
        "Paragraph\n\n| A | B |\n|---|---|\n| 1 | 2 |\n",
        6,
        "Paragraph\n\n|A|B|\n|---|---|\n|1|2|\n"
    )]
    #[case::table_after_heading(
        "# Title\n\n| A | B |\n|---|---|\n| 1 | 2 |\n",
        6,
        "# Title\n\n|A|B|\n|---|---|\n|1|2|\n"
    )]
    #[case::excessive_blank_lines("# Title\n\n\n\nParagraph", 2, "# Title\n\nParagraph\n")]
    #[case::three_blank_lines("Para 1\n\n\n\n\nPara 2", 2, "Para 1\n\nPara 2\n")]
    // GFM autolink literal: link text is the same URL — must not nest on round-trip
    #[case::link_url_as_text(
        "[https://example.com](https://example.com)",
        1,
        "[https://example.com](https://example.com)\n"
    )]
    fn test_markdown_from_str(#[case] input: &str, #[case] expected_nodes: usize, #[case] expected_output: &str) {
        let md = input.parse::<Markdown>().unwrap();
        assert_eq!(md.nodes.len(), expected_nodes);
        assert_eq!(md.to_string(), expected_output);
    }

    #[rstest]
    #[case::mdx("{test}", 1, "{test}\n")]
    #[case::mdx("<a />", 1, "<a />\n")]
    #[case::mdx("<MyComponent {...props}/>", 1, "<MyComponent {...props} />\n")]
    #[case::mdx("text<MyComponent {...props}/>text", 3, "text<MyComponent {...props} />text\n")]
    #[case::mdx(
        "<Chart color=\"#fcb32c\" year={year} />",
        1,
        "<Chart color=\"#fcb32c\" year={year} />\n"
    )]
    fn test_markdown_from_mdx_str(#[case] input: &str, #[case] expected_nodes: usize, #[case] expected_output: &str) {
        let md = Markdown::from_mdx_str(input).unwrap();
        assert_eq!(md.nodes.len(), expected_nodes);
        assert_eq!(md.to_string(), expected_output);
    }

    /// Round-tripping a link whose text equals its URL must be idempotent.
    /// Previously, GFM autolink literal parsing caused the URL text to be
    /// wrapped in a second Link node, producing `[[url](url)](url)` after
    /// the first serialisation and deeper nesting on every subsequent pass.
    #[test]
    fn test_link_url_as_text_is_idempotent() {
        let input = "[https://example.com](https://example.com)";
        let first = input.parse::<Markdown>().unwrap().to_string();
        let second = first.parse::<Markdown>().unwrap().to_string();
        assert_eq!(first, second, "round-trip must be idempotent");
        assert_eq!(first, "[https://example.com](https://example.com)\n");
    }

    #[test]
    fn test_markdown_to_html() {
        let md = "# Hello".parse::<Markdown>().unwrap();
        let html = md.to_html();
        assert_eq!(html, "<h1>Hello</h1>\n");
    }

    #[test]
    fn test_markdown_to_text() {
        let md = "# Hello\n\nWorld".parse::<Markdown>().unwrap();
        let text = md.to_text();
        assert_eq!(text, "Hello\nWorld\n");
    }

    #[test]
    fn test_render_options() {
        let mut md = "- Item 1\n- Item 2".parse::<Markdown>().unwrap();
        assert_eq!(md.options, RenderOptions::default());

        md.set_options(RenderOptions {
            list_style: ListStyle::Plus,
            ..RenderOptions::default()
        });
        assert_eq!(md.options.list_style, ListStyle::Plus);

        let pretty = md.to_string();
        assert!(pretty.contains("+ Item 1"));
    }

    #[test]
    fn test_display_simple() {
        let md = "# Header\nParagraph".parse::<Markdown>().unwrap();
        assert_eq!(md.to_string(), "# Header\nParagraph\n");
    }

    #[test]
    fn test_display_with_empty_nodes() {
        let md = "# Header\nContent".parse::<Markdown>().unwrap();
        assert_eq!(md.to_string(), "# Header\nContent\n");
    }

    #[test]
    fn test_display_with_newlines() {
        let md = "# Header\n\nParagraph 1\n\nParagraph 2".parse::<Markdown>().unwrap();
        assert_eq!(md.to_string(), "# Header\n\nParagraph 1\n\nParagraph 2\n");
    }

    #[test]
    fn test_display_format_lists() {
        let md = "- Item 1\n- Item 2\n- Item 3".parse::<Markdown>().unwrap();
        assert_eq!(md.to_string(), "- Item 1\n- Item 2\n- Item 3\n");
    }

    #[test]
    fn test_display_with_different_list_styles() {
        let mut md = "- Item 1\n- Item 2".parse::<Markdown>().unwrap();

        md.set_options(RenderOptions {
            list_style: ListStyle::Star,
            link_title_style: TitleSurroundStyle::default(),
            link_url_style: UrlSurroundStyle::default(),
        });

        let formatted = md.to_string();
        assert!(formatted.contains("* Item 1"));
        assert!(formatted.contains("* Item 2"));
    }

    #[test]
    fn test_display_with_ordered_list() {
        let md = "1. Item 1\n2. Item 2\n\n3. Item 2".parse::<Markdown>().unwrap();
        let formatted = md.to_string();

        assert!(formatted.contains("1. Item 1"));
        assert!(formatted.contains("2. Item 2"));
        assert!(formatted.contains("3. Item 2"));
    }
}

#[cfg(test)]
#[cfg(feature = "color")]
mod color_tests {
    use rstest::rstest;

    use super::*;

    #[rstest]
    #[case::heading("# Title", "\x1b[1m\x1b[36m# Title\x1b[0m\n")]
    #[case::emphasis("*italic*", "\x1b[3m\x1b[33m*italic*\x1b[0m\n")]
    #[case::strong("**bold**", "\x1b[1m**bold**\x1b[0m\n")]
    #[case::code_inline("`code`", "\x1b[32m`code`\x1b[0m\n")]
    #[case::code_block("```rust\nlet x = 1;\n```", "\x1b[32m```rust\nlet x = 1;\n```\x1b[0m\n")]
    #[case::link("[text](url)", "\x1b[4m\x1b[34m[text](url)\x1b[0m\n")]
    #[case::image("![alt](url)", "\x1b[35m![alt](url)\x1b[0m\n")]
    #[case::delete("~~deleted~~", "\x1b[31m\x1b[2m~~deleted~~\x1b[0m\n")]
    #[case::horizontal_rule("---", "\x1b[2m---\x1b[0m\n")]
    #[case::blockquote("> quote", "\x1b[2m> \x1b[0mquote\n")]
    #[case::math_inline("$x^2$", "\x1b[32m$x^2$\x1b[0m\n")]
    #[case::list("- item", "\x1b[33m-\x1b[0m item\n")]
    fn test_to_colored_string(#[case] input: &str, #[case] expected: &str) {
        let md = input.parse::<Markdown>().unwrap();
        assert_eq!(md.to_colored_string(), expected);
    }

    #[test]
    fn test_colored_output_contains_ansi_codes() {
        let md = "# Hello\n\n**bold** and *italic*".parse::<Markdown>().unwrap();
        let colored = md.to_colored_string();

        assert!(colored.contains("\x1b["));
        assert!(colored.contains("\x1b[0m"));
    }

    #[test]
    fn test_plain_output_has_no_ansi_codes() {
        let md = "# Hello\n\n**bold** and *italic*".parse::<Markdown>().unwrap();
        let plain = md.to_string();

        assert!(!plain.contains("\x1b["));
    }

    #[test]
    fn test_parse_colors_overrides_specified_keys() {
        let theme = ColorTheme::parse_colors("heading=1;31:code=34");
        assert_eq!(theme.heading.0, "\x1b[1;31m");
        assert_eq!(theme.heading.1, "\x1b[0m");
        assert_eq!(theme.code.0, "\x1b[34m");
        assert_eq!(theme.code.1, "\x1b[0m");
        // Unspecified keys remain default
        assert_eq!(theme.emphasis, ColorTheme::COLORED.emphasis);
    }

    #[test]
    fn test_parse_colors_ignores_invalid_entries() {
        let theme = ColorTheme::parse_colors("heading=abc:code=32:=:badformat");
        // Invalid "abc" is skipped, heading stays default
        assert_eq!(theme.heading, ColorTheme::COLORED.heading);
        // Valid "32" is applied
        assert_eq!(theme.code.0, "\x1b[32m");
        assert_eq!(theme.code.1, "\x1b[0m");
    }

    #[test]
    fn test_parse_colors_ignores_unknown_keys() {
        let theme = ColorTheme::parse_colors("unknown=31:heading=33");
        assert_eq!(theme.heading.0, "\x1b[33m");
        assert_eq!(theme.heading.1, "\x1b[0m");
    }

    #[test]
    fn test_parse_colors_all_keys() {
        let theme = ColorTheme::parse_colors(
            "heading=1:code=2:code_inline=3:emphasis=4:strong=5:link=6:link_url=7:\
             image=8:blockquote=9:delete=10:hr=11:html=12:frontmatter=13:list=14:\
             table=15:math=16",
        );
        assert_eq!(theme.heading.0, "\x1b[1m");
        assert_eq!(theme.code.0, "\x1b[2m");
        assert_eq!(theme.code_inline.0, "\x1b[3m");
        assert_eq!(theme.emphasis.0, "\x1b[4m");
        assert_eq!(theme.strong.0, "\x1b[5m");
        assert_eq!(theme.link.0, "\x1b[6m");
        assert_eq!(theme.link_url.0, "\x1b[7m");
        assert_eq!(theme.image.0, "\x1b[8m");
        assert_eq!(theme.blockquote_marker.0, "\x1b[9m");
        assert_eq!(theme.delete.0, "\x1b[10m");
        assert_eq!(theme.horizontal_rule.0, "\x1b[11m");
        assert_eq!(theme.html.0, "\x1b[12m");
        assert_eq!(theme.frontmatter.0, "\x1b[13m");
        assert_eq!(theme.list_marker.0, "\x1b[14m");
        assert_eq!(theme.table_separator.0, "\x1b[15m");
        assert_eq!(theme.math.0, "\x1b[16m");
    }

    #[test]
    fn test_parse_colors_empty_string() {
        let theme = ColorTheme::parse_colors("");
        assert_eq!(theme.heading, ColorTheme::COLORED.heading);
    }

    #[test]
    fn test_colored_string_with_custom_theme() {
        let theme = ColorTheme::parse_colors("heading=1;31");
        let md = "# Title".parse::<Markdown>().unwrap();
        let colored = md.to_colored_string_with_theme(&theme);
        assert_eq!(colored, "\x1b[1;31m# Title\x1b[0m\n");
    }
}

#[cfg(test)]
#[cfg(feature = "json")]
mod json_tests {
    use rstest::rstest;

    use super::*;

    #[test]
    fn test_to_json_simple() {
        let md = "# Hello".parse::<Markdown>().unwrap();
        let json = md.to_json().unwrap();
        assert!(json.contains("\"type\": \"Heading\""));
        assert!(json.contains("\"depth\": 1"));
        assert!(json.contains("\"values\":"));
    }

    #[test]
    fn test_to_json_complex() {
        let md = "# Header\n\n- Item 1\n- Item 2\n\n*Emphasis* and **Strong**"
            .parse::<Markdown>()
            .unwrap();
        let json = md.to_json().unwrap();

        assert!(json.contains("\"type\": \"Heading\""));
        assert!(json.contains("\"type\": \"List\""));
        assert!(json.contains("\"type\": \"Strong\""));
        assert!(json.contains("\"type\": \"Emphasis\""));
    }

    #[test]
    fn test_to_json_code_blocks() {
        let md = "```rust\nfn main() {\n    println!(\"Hello\");\n}\n```"
            .parse::<Markdown>()
            .unwrap();
        let json = md.to_json().unwrap();

        assert!(json.contains("\"type\": \"Code\""));
        assert!(json.contains("\"lang\": \"rust\""));
        assert!(json.contains("\"value\": \"fn main() {\\n    println!(\\\"Hello\\\");\\n}\""));
    }

    #[test]
    fn test_to_json_table() {
        let md = "| A | B |\n|---|---|\n| 1 | 2 |".parse::<Markdown>().unwrap();
        let json = md.to_json().unwrap();

        assert!(json.contains("\"type\": \"TableCell\""));
    }

    #[rstest]
    #[case("<h1>Hello</h1>", 1, "# Hello\n")]
    #[case("<p>Paragraph</p>", 1, "Paragraph\n")]
    #[case("<ul><li>Item 1</li><li>Item 2</li></ul>", 2, "- Item 1\n- Item 2\n")]
    #[case("<ol><li>First</li><li>Second</li></ol>", 2, "1. First\n2. Second\n")]
    #[case("<blockquote>Quote</blockquote>", 1, "> Quote\n")]
    #[case("<code>inline</code>", 1, "`inline`\n")]
    #[case("<pre><code>block</code></pre>", 1, "```\nblock\n```\n")]
    #[case("<table><tr><td>A</td><td>B</td></tr></table>", 3, "|A|B|\n|---|---|\n")]
    #[cfg(feature = "html-to-markdown")]
    fn test_markdown_from_html(#[case] input: &str, #[case] expected_nodes: usize, #[case] expected_output: &str) {
        let md = Markdown::from_html_str(input).unwrap();
        assert_eq!(md.nodes.len(), expected_nodes);
        assert_eq!(md.to_string(), expected_output);
    }
}