cmark-writer 0.8.0

A CommonMark writer implementation in Rust for serializing AST nodes to CommonMark format
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

// Shared test utilities for integration and unit test suites

pub mod logger {
    use log::{LevelFilter, Log};
    use std::sync::Once;

    #[allow(dead_code)]
    static INIT: Once = Once::new();

    /// Initialize a simple stdout logger once for tests.
    /// Safe to call multiple times; only first call takes effect.
    #[allow(dead_code)]
    pub fn init(level: LevelFilter) {
        INIT.call_once(|| {
            struct TestLogger;
            impl Log for TestLogger {
                fn enabled(&self, metadata: &log::Metadata) -> bool {
                    metadata.level() <= LevelFilter::Warn
                }

                fn log(&self, record: &log::Record) {
                    if self.enabled(record.metadata()) {
                        let color_code = match record.level() {
                            log::Level::Error => "\x1b[31m",
                            log::Level::Warn => "\x1b[33m",
                            log::Level::Info => "\x1b[32m",
                            log::Level::Debug => "\x1b[34m",
                            log::Level::Trace => "\x1b[90m",
                        };
                        let reset = "\x1b[0m";
                        println!(
                            "{}[{}]{} {}: {}",
                            color_code,
                            record.level(),
                            reset,
                            record.target(),
                            record.args()
                        );
                    }
                }

                fn flush(&self) {}
            }

            let _ = log::set_boxed_logger(Box::new(TestLogger)).map(|()| log::set_max_level(level));
        });
    }
}

pub mod cmark {
    use cmark_writer::options::WriterOptionsBuilder;
    use cmark_writer::writer::CommonMarkWriter;

    /// Create a CommonMark writer with GFM features enabled.
    #[cfg(feature = "gfm")]
    #[allow(dead_code)]
    pub fn writer_with_gfm() -> CommonMarkWriter {
        let options = WriterOptionsBuilder::new().enable_gfm().build();
        CommonMarkWriter::with_options(options)
    }
}

pub mod html {
    use cmark_writer::ast::Node;
    use cmark_writer::writer::{HtmlWriteResult, HtmlWriter, HtmlWriterOptions};
    use cmark_writer::ToHtml;
    use ecow::EcoString;

    /// Render a node to HTML using provided options.
    #[allow(dead_code)]
    pub fn render_node(node: &Node, options: &HtmlWriterOptions) -> HtmlWriteResult<EcoString> {
        let mut html_writer = HtmlWriter::with_options(options.clone());
        match node.to_html(&mut html_writer) {
            Ok(()) => {}
            Err(e) => return Err(cmark_writer::HtmlWriteError::CustomNodeError(e.to_string())),
        }
        Ok(html_writer.into_string())
    }

    /// Render a node to HTML using default options.
    #[allow(dead_code)]
    pub fn render_node_default(node: &Node) -> HtmlWriteResult<EcoString> {
        render_node(
            node,
            #[cfg(feature = "gfm")]
            &HtmlWriterOptions::default().with_gfm_enabled(true),
            #[cfg(not(feature = "gfm"))]
            &HtmlWriterOptions::default(),
        )
    }
}