lex-babel 0.8.2

Format conversion library for the lex 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

use serde::{Deserialize, Serialize};

/// Configuration for the Lex formatter
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FormattingRules {
    /// Number of blank lines before a session title
    pub session_blank_lines_before: usize,

    /// Number of blank lines after a session title
    pub session_blank_lines_after: usize,

    /// Whether to normalize list markers (e.g. all bullets to '-')
    pub normalize_seq_markers: bool,

    /// The character to use for unordered list markers
    pub unordered_seq_marker: char,

    /// Maximum number of consecutive blank lines allowed
    pub max_blank_lines: usize,

    /// String to use for indentation (usually 4 spaces)
    pub indent_string: String,

    /// Whether to preserve trailing blank lines at the end of the document
    pub preserve_trailing_blanks: bool,

    /// Whether to normalize verbatim markers to `::`
    pub normalize_verbatim_markers: bool,
}

impl Default for FormattingRules {
    fn default() -> Self {
        Self {
            session_blank_lines_before: 1,
            session_blank_lines_after: 1,
            normalize_seq_markers: true,
            unordered_seq_marker: '-',
            max_blank_lines: 2,
            indent_string: "    ".to_string(),
            preserve_trailing_blanks: false,
            normalize_verbatim_markers: true,
        }
    }
}

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

    #[test]
    fn test_default_rules() {
        let rules = FormattingRules::default();
        assert_eq!(rules.session_blank_lines_before, 1);
        assert_eq!(rules.indent_string, "    ");
    }
}