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

//! GFM task list support
//!
//! This module provides utilities for working with GitHub Flavored Markdown
//! task lists (checkboxes).

pub use crate::ast::TaskListStatus;
use crate::ast::{ListItem, Node};

/// Creates a checked (completed) task list item
///
/// # Arguments
/// * `content` - The content of the task list item
///
/// # Returns
/// A task list item with a checked status
pub fn checked_task(content: Vec<Node>) -> ListItem {
    Node::task_list_item(TaskListStatus::Checked, content)
}

/// Creates an unchecked (pending) task list item
///
/// # Arguments
/// * `content` - The content of the task list item
///
/// # Returns
/// A task list item with an unchecked status
pub fn unchecked_task(content: Vec<Node>) -> ListItem {
    Node::task_list_item(TaskListStatus::Unchecked, content)
}

/// Creates a task list with multiple items
///
/// # Arguments
/// * `items` - A vector of tuples containing the status and content for each task
///
/// # Returns
/// An unordered list node containing task items
pub fn task_list(items: Vec<(TaskListStatus, Vec<Node>)>) -> Node {
    let list_items = items
        .into_iter()
        .map(|(status, content)| Node::task_list_item(status, content))
        .collect::<Vec<_>>();

    Node::UnorderedList(list_items)
}

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

    #[test]
    fn checked_task_returns_list_item() {
        let item = checked_task(vec![Node::Text("done".into())]);
        assert_eq!(
            item,
            ListItem::Task {
                status: TaskListStatus::Checked,
                content: vec![Node::Text("done".into())]
            }
        );
    }

    #[test]
    fn task_list_wraps_items_in_unordered_list() {
        let list = task_list(vec![
            (TaskListStatus::Checked, vec![Node::Text("a".into())]),
            (TaskListStatus::Unchecked, vec![Node::Text("b".into())]),
        ]);

        assert_eq!(
            list,
            Node::UnorderedList(vec![
                ListItem::Task {
                    status: TaskListStatus::Checked,
                    content: vec![Node::Text("a".into())]
                },
                ListItem::Task {
                    status: TaskListStatus::Unchecked,
                    content: vec![Node::Text("b".into())]
                }
            ])
        );
    }
}