markdown-it-sup 1.0.2

//! A [`markdown-it`](https://crates.io/crates/markdown-it) plugin to process superscript.
//!
//! To load the plugin:
//!
//! ```rust
//! # use markdown_it;
//! # use markdown_it_sup;
//! let mut parser = markdown_it::MarkdownIt::new();
//! markdown_it::plugins::cmark::add(&mut parser);
//!
//! markdown_it_sup::add(&mut parser);
//!
//! let html = parser.parse("Markdown^TM^").xrender();
//! assert_eq!(html, String::from("<p>Markdown<sup>TM</sup></p>\n"));
//!```

use markdown_it::{generics::inline::emph_pair, MarkdownIt, Node, NodeValue, Renderer};

#[derive(Debug)]
pub struct Sup;

impl NodeValue for Sup {
    fn render(&self, node: &Node, fmt: &mut dyn Renderer) {
        fmt.open("sup", &node.attrs);
        fmt.contents(&node.children);
        fmt.close("sup");
    }
}

/// Adds the superscript plugin to the parser.
pub fn add(md: &mut MarkdownIt) {
    emph_pair::add_with::<'^', 1, true>(md, || Node::new(Sup));
}

#[cfg(test)]
mod test {
    use super::add;
    use markdown_it::{
        plugins::{cmark, extra},
        MarkdownIt,
    };
    use rstest::rstest;
    use std::sync::LazyLock;

    static MARKDOWN_PARSER: LazyLock<MarkdownIt> = LazyLock::new(|| {
        let mut parser = MarkdownIt::new();
        cmark::add(&mut parser);
        extra::add(&mut parser);
        add(&mut parser);

        parser
    });

    #[rstest]
    #[case("^foo^", "<p><sup>foo</sup></p>\n")]
    #[case("foo^", "<p>foo^</p>\n")]
    #[case("^foo", "<p>^foo</p>\n")]
    #[case("foo^bar^", "<p>foo<sup>bar</sup></p>\n")]
    #[case("\\^foo^", "<p>^foo^</p>\n")]
    #[case("^foo\\^", "<p>^foo^</p>\n")]
    fn test(#[case] md_str: &str, #[case] expected: &str) {
        let result = MARKDOWN_PARSER.parse(md_str).xrender();

        assert_eq!(result, String::from(expected));
    }
}