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
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

#![forbid(unsafe_code)]

use clap::Parser;
use std::fs;
use std::io::{self, Read};
use std::path::PathBuf;

#[derive(Debug, Parser)]
#[command(name = "mandate", version)]
struct Cli {
    #[arg(short = 'i', long = "input", value_name = "PATH", default_value = "-")]
    input: String,

    #[arg(short = 'p', long = "program", value_name = "NAME")]
    program: String,

    #[arg(
        short = 's',
        long = "section",
        value_name = "SECTION",
        default_value = "1"
    )]
    section: String,

    #[arg(short = 't', long = "title", value_name = "TITLE")]
    title: String,

    #[arg(short = 'm', long = "manual-section", value_name = "MANUAL")]
    manual_section: Option<String>,

    #[arg(long = "source", value_name = "SOURCE")]
    source: Option<String>,

    #[arg(short = 'o', long = "output", value_name = "PATH")]
    output: Option<PathBuf>,

    #[arg(long = "validate")]
    validate: bool,

    #[arg(long = "schema", value_name = "PATH")]
    schema: Option<PathBuf>,
}

fn read_input(path: &str) -> io::Result<String> {
    if path == "-" {
        let mut buf = String::new();
        io::stdin().read_to_string(&mut buf)?;
        Ok(buf)
    } else {
        fs::read_to_string(path)
    }
}

fn write_output(path: Option<PathBuf>, contents: &str) -> io::Result<()> {
    match path {
        Some(path) => fs::write(path, contents),
        None => {
            print!("{contents}");
            Ok(())
        }
    }
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cli = Cli::parse();
    let input = read_input(&cli.input)?;

    let options = mandate::ManpageOptions::new(
        cli.program,
        cli.section,
        cli.title,
        cli.manual_section,
        cli.source,
    );

    let output = match input_kind(&cli.input) {
        InputKind::Yaml => {
            if cli.validate {
                validate_yaml(&input, cli.schema.as_ref())?;
            }
            mandate::convert_yaml_to_roff(&input, &options)?
        }
        InputKind::Markdown => mandate::convert_markdown_to_roff(&input, &options)?,
        InputKind::Auto => {
            if cli.validate {
                match validate_yaml(&input, cli.schema.as_ref()) {
                    Ok(()) => mandate::convert_yaml_to_roff(&input, &options)?,
                    Err(mandate::MandateError::Yaml(_)) => {
                        mandate::convert_markdown_to_roff(&input, &options)?
                    }
                    Err(err) => return Err(Box::new(err)),
                }
            } else {
                mandate::convert_yaml_to_roff(&input, &options)
                    .or_else(|_| mandate::convert_markdown_to_roff(&input, &options))?
            }
        }
    };
    write_output(cli.output, &output)?;
    Ok(())
}

#[derive(Debug, Clone, Copy)]
enum InputKind {
    Yaml,
    Markdown,
    Auto,
}

fn input_kind(path: &str) -> InputKind {
    let lower = path.to_ascii_lowercase();
    if lower == "-" {
        return InputKind::Auto;
    }
    if lower.ends_with(".yaml") || lower.ends_with(".yml") {
        return InputKind::Yaml;
    }
    if lower.ends_with(".md") || lower.ends_with(".markdown") {
        return InputKind::Markdown;
    }
    InputKind::Markdown
}

fn validate_yaml(input: &str, schema: Option<&PathBuf>) -> Result<(), mandate::MandateError> {
    match schema {
        Some(path) => mandate::validate_yaml_with_schema(input, path),
        None => mandate::validate_yaml_with_schema_str(input, mandate::BUILTIN_SCHEMA),
    }
}

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

    #[test]
    fn input_kind_detects_extensions() {
        assert!(matches!(input_kind("-"), InputKind::Auto));
        assert!(matches!(input_kind("manual.yaml"), InputKind::Yaml));
        assert!(matches!(input_kind("manual.yml"), InputKind::Yaml));
        assert!(matches!(input_kind("manual.md"), InputKind::Markdown));
        assert!(matches!(input_kind("manual.markdown"), InputKind::Markdown));
        assert!(matches!(input_kind("manual.txt"), InputKind::Markdown));
    }
}