mandate 0.1.0

Convert Markdown or YAML manuals into roff manpages
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

use mandate::{ManpageOptions, convert_markdown_to_roff};

fn options() -> ManpageOptions {
    ManpageOptions::new("mandate", "1", "Test", None, None)
}

fn th_fields(roff: &str) -> Vec<String> {
    roff.lines()
        .find(|line| line.starts_with(".TH "))
        .map(|line| {
            line.split('"')
                .skip(1)
                .step_by(2)
                .map(str::to_string)
                .collect::<Vec<_>>()
        })
        .unwrap_or_default()
}

#[test]
fn renders_headings_and_inline_styles() {
    let markdown = r#"
# mandate(1) -- Example Tool

## Overview

Paragraph with *em* and **strong** and `code` and <arg>.
"#;
    let roff = convert_markdown_to_roff(markdown, &options()).expect("render roff");
    let fields = th_fields(&roff);
    assert!(fields.len() >= 5);
    assert_eq!(fields[0], "mandate");
    assert_eq!(fields[1], "1");
    assert!(!fields[2].is_empty());
    assert_eq!(fields[4], "Test");
    assert!(roff.contains(".SH \"NAME\""));
    assert!(roff.contains("\\fBmandate\\fR \\- Example Tool"));
    assert!(roff.contains("\\fIem\\fR"));
    assert!(roff.contains("\\fBstrong\\fR"));
    assert!(roff.contains("\\fBcode\\fR"));
    assert!(roff.contains("\\fIarg\\fR"));
}

#[test]
fn special_list_consumes_following_paragraphs() {
    let markdown = r#"
## OPTIONS

- Foo:

Paragraph after foo.
"#;
    let roff = convert_markdown_to_roff(markdown, &options()).expect("render roff");
    assert!(roff.contains(".TP"));
    assert!(roff.contains("Foo:"));
    assert!(roff.contains(".IP"));
    assert!(roff.contains("Paragraph after foo\\."));
    assert!(roff.contains("Foo:\n.IP"));
}