cmark-writer 0.9.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
use crate::ast::{CodeBlockType, HeadingType, ListItem, Node};
#[cfg(feature = "gfm")]
use crate::ast::{TableAlignment, TaskListStatus};
use crate::error::{WriteError, WriteResult};
use ecow::EcoString;

use super::super::utils::table_contains_block_elements;
use super::super::CommonMarkWriter;

impl CommonMarkWriter {
    /// Apply a prefix to multi-line content, preserving the first-line prefix if provided.
    fn apply_prefix(
        &self,
        content: &str,
        prefix: &str,
        first_line_prefix: Option<&str>,
    ) -> EcoString {
        if content.is_empty() {
            return EcoString::new();
        }

        let mut result = EcoString::new();
        let lines: Vec<&str> = content.lines().collect();

        if let Some(first) = lines.first() {
            let actual_prefix = first_line_prefix.unwrap_or(prefix);
            result.push_str(actual_prefix);
            result.push_str(first);
        }

        for line in &lines[1..] {
            result.push('\n');
            result.push_str(prefix);
            result.push_str(line);
        }

        result
    }

    /// Write a document node and insert appropriate spacing between blocks.
    pub(crate) fn write_document(&mut self, children: &[Node]) -> WriteResult<()> {
        let mut prev_was_block = false;

        for (index, child) in children.iter().enumerate() {
            if index > 0 {
                self.prepare_block_sequence(prev_was_block, child.is_block())?;
            }

            self.write(child)?;

            if child.is_block() {
                self.ensure_trailing_newline()?;
            }

            prev_was_block = child.is_block();
        }

        Ok(())
    }

    /// Write a heading node, normalising invalid levels when non-strict.
    pub(crate) fn write_heading(
        &mut self,
        mut level: u8,
        content: &[Node],
        heading_type: &HeadingType,
    ) -> WriteResult<()> {
        if level == 0 || level > 6 {
            if self.is_strict_mode() {
                return Err(WriteError::InvalidHeadingLevel(level));
            } else {
                let original = level;
                level = level.clamp(1, 6);
                self.emit_warning(format!(
                    "Invalid heading level: {original}. Corrected to {level}."
                ));
            }
        }

        match heading_type {
            HeadingType::Atx => {
                for _ in 0..level {
                    self.write_char('#')?;
                }
                self.write_char(' ')?;

                for node in content {
                    self.write(node)?;
                }

                self.write_char('\n')?;
            }
            HeadingType::Setext => {
                let heading_text = self.capture_with_buffer(|writer| {
                    for node in content {
                        writer.write(node)?;
                    }
                    Ok(())
                })?;

                self.write_str(&heading_text)?;
                self.write_char('\n')?;

                let underline_char = if level == 1 { '=' } else { '-' };
                let max_line_width = heading_text
                    .lines()
                    .map(|line| line.chars().count())
                    .max()
                    .unwrap_or(0)
                    .max(3);

                for _ in 0..max_line_width {
                    self.write_char(underline_char)?;
                }

                self.write_char('\n')?;
            }
        }

        Ok(())
    }

    /// Write a paragraph node with optional trimming of trailing hard breaks.
    pub(crate) fn write_paragraph(&mut self, content: &[Node]) -> WriteResult<()> {
        if self.options.trim_paragraph_trailing_hard_breaks {
            let mut last_non_hard_break = content.len();

            while last_non_hard_break > 0 {
                if !matches!(content[last_non_hard_break - 1], Node::HardBreak) {
                    break;
                }
                last_non_hard_break -= 1;
            }

            for node in content.iter().take(last_non_hard_break) {
                self.write(node)?;
            }
        } else {
            for node in content {
                self.write(node)?;
            }
        }

        self.ensure_trailing_newline()
    }

    /// Write a blockquote, indenting inner content with the `> ` prefix.
    pub(crate) fn write_blockquote(&mut self, content: &[Node]) -> WriteResult<()> {
        let all_content = self.capture_with_buffer(|writer| {
            writer.write_document(content)?;
            Ok(())
        })?;

        let prefix = "> ";
        let formatted_content = self.apply_prefix(&all_content, prefix, Some(prefix));
        self.buffer.push_str(&formatted_content);
        Ok(())
    }

    /// Write a thematic break (horizontal rule).
    pub(crate) fn write_thematic_break(&mut self) -> WriteResult<()> {
        let ch = self.options.thematic_break_char;
        self.write_str(&format!("{ch}{ch}{ch}"))?;
        self.ensure_trailing_newline()
    }

    /// Write a code block, supporting indented and fenced styles.
    pub(crate) fn write_code_block(
        &mut self,
        language: &Option<EcoString>,
        content: &EcoString,
        block_type: &CodeBlockType,
    ) -> WriteResult<()> {
        let content = content.as_ref();
        match block_type {
            CodeBlockType::Indented => {
                let indent = "    ";
                let indented = self.apply_prefix(content, indent, Some(indent));
                self.buffer.push_str(&indented);
            }
            CodeBlockType::Fenced => {
                let max_backticks = content
                    .chars()
                    .fold((0, 0), |(max, current), c| {
                        if c == '`' {
                            (max.max(current + 1), current + 1)
                        } else {
                            (max, 0)
                        }
                    })
                    .0;

                let fence_len = std::cmp::max(max_backticks + 1, 3);
                let fence = "`".repeat(fence_len);

                self.write_str(&fence)?;
                if let Some(lang) = language {
                    self.write_str(lang)?;
                }
                self.write_char('\n')?;

                self.buffer.push_str(content);
                if !content.ends_with('\n') {
                    self.write_char('\n')?;
                }

                self.write_str(&fence)?;
            }
        }

        Ok(())
    }

    /// Write an unordered list using the configured list marker.
    pub(crate) fn write_unordered_list(&mut self, items: &[ListItem]) -> WriteResult<()> {
        let list_marker = self.options.list_marker;
        let prefix = format!("{list_marker} ");

        for (index, item) in items.iter().enumerate() {
            if index > 0 {
                self.write_char('\n')?;
            }
            self.write_list_item(item, &prefix)?;
        }

        Ok(())
    }

    /// Write an ordered list, respecting explicit numbering overrides.
    pub(crate) fn write_ordered_list(&mut self, start: u32, items: &[ListItem]) -> WriteResult<()> {
        let mut current_number = start;

        for (index, item) in items.iter().enumerate() {
            if index > 0 {
                self.write_char('\n')?;
            }

            match item {
                ListItem::Ordered {
                    number: Some(custom),
                    ..
                } => {
                    let prefix = format!("{custom}. ");
                    self.write_list_item(item, &prefix)?;
                    current_number = custom + 1;
                }
                _ => {
                    let prefix = format!("{current_number}. ");
                    self.write_list_item(item, &prefix)?;
                    current_number += 1;
                }
            }
        }

        Ok(())
    }

    fn write_list_item(&mut self, item: &ListItem, prefix: &str) -> WriteResult<()> {
        match item {
            ListItem::Unordered { content } => {
                self.write_str(prefix)?;
                self.write_list_item_content(content, prefix.len())?;
            }
            ListItem::Ordered { number, content } => {
                if let Some(num) = number {
                    let custom_prefix = format!("{num}. ");
                    self.write_str(&custom_prefix)?;
                    self.write_list_item_content(content, custom_prefix.len())?;
                } else {
                    self.write_str(prefix)?;
                    self.write_list_item_content(content, prefix.len())?;
                }
            }
            #[cfg(feature = "gfm")]
            ListItem::Task { status, content } => {
                if self.options.gfm_tasklists {
                    let checkbox = match status {
                        TaskListStatus::Checked => "[x] ",
                        TaskListStatus::Unchecked => "[ ] ",
                    };

                    let task_prefix = format!("{prefix}{checkbox}");
                    self.write_str(&task_prefix)?;
                    self.write_list_item_content(content, task_prefix.len())?;
                } else {
                    self.write_str(prefix)?;
                    self.write_list_item_content(content, prefix.len())?;
                }
            }
        }

        Ok(())
    }

    fn write_list_item_content(&mut self, content: &[Node], prefix_len: usize) -> WriteResult<()> {
        if content.is_empty() {
            return Ok(());
        }

        let all_content = self.capture_with_buffer(|writer| {
            writer.write_document(content)?;
            Ok(())
        })?;

        let indent = " ".repeat(prefix_len);
        let formatted = self.apply_prefix(&all_content, &indent, Some(""));
        self.buffer.push_str(&formatted);
        Ok(())
    }

    /// Write a table, falling back to HTML when block elements appear in cells.
    pub(crate) fn write_table(&mut self, headers: &[Node], rows: &[Vec<Node>]) -> WriteResult<()> {
        if table_contains_block_elements(headers, rows) {
            if self.is_strict_mode() {
                return Err(WriteError::InvalidStructure(
                    "Table contains block-level elements which are not allowed in strict mode"
                        .to_string()
                        .into(),
                ));
            } else {
                self.emit_info(
                    "Table contains block-level elements, falling back to HTML output in soft mode",
                );
                return self.write_table_as_html(headers, rows);
            }
        }

        self.write_char('|')?;
        for header in headers {
            self.check_no_newline(header, "Table Header")?;
            self.write_char(' ')?;
            self.write(header)?;
            self.write_str(" |")?;
        }
        self.write_char('\n')?;

        self.write_char('|')?;
        for _ in 0..headers.len() {
            self.write_str(" --- |")?;
        }
        self.write_char('\n')?;

        for row in rows {
            self.write_char('|')?;
            for cell in row {
                self.check_no_newline(cell, "Table Cell")?;
                self.write_char(' ')?;
                self.write(cell)?;
                self.write_str(" |")?;
            }
            self.write_char('\n')?;
        }

        Ok(())
    }

    /// Write a GFM table with per-column alignment when enabled.
    #[cfg(feature = "gfm")]
    pub(crate) fn write_table_with_alignment(
        &mut self,
        headers: &[Node],
        alignments: &[TableAlignment],
        rows: &[Vec<Node>],
    ) -> WriteResult<()> {
        if !self.options.gfm_tables {
            return self.write_table(headers, rows);
        }

        if table_contains_block_elements(headers, rows) {
            if self.is_strict_mode() {
                return Err(WriteError::InvalidStructure(
                    "GFM table contains block-level elements which are not allowed in strict mode"
                        .to_string()
                        .into(),
                ));
            } else {
                self.emit_info(
                        "GFM table contains block-level elements, falling back to HTML output in soft mode",
                    );
                return self.write_table_as_html_with_alignment(headers, alignments, rows);
            }
        }

        self.write_char('|')?;
        for header in headers {
            self.check_no_newline(header, "Table Header")?;
            self.write_char(' ')?;
            self.write(header)?;
            self.write_str(" |")?;
        }
        self.write_char('\n')?;

        self.write_char('|')?;
        for index in 0..headers.len() {
            let alignment = alignments.get(index).unwrap_or(&TableAlignment::Center);
            match alignment {
                TableAlignment::Left => self.write_str(" :--- |")?,
                TableAlignment::Center => self.write_str(" :---: |")?,
                TableAlignment::Right => self.write_str(" ---: |")?,
                TableAlignment::None => self.write_str(" --- |")?,
            }
        }
        self.write_char('\n')?;

        for row in rows {
            self.write_char('|')?;
            for cell in row {
                self.check_no_newline(cell, "Table Cell")?;
                self.write_char(' ')?;
                self.write(cell)?;
                self.write_str(" |")?;
            }
            self.write_char('\n')?;
        }

        Ok(())
    }

    /// Write an HTML block verbatim.
    pub(crate) fn write_html_block(&mut self, content: &EcoString) -> WriteResult<()> {
        self.buffer.push_str(content.as_ref());
        Ok(())
    }
}