confmark 0.3.0

Bidirectional CLI tool for converting Markdown to Confluence markup and Confluence markup back to Markdown.
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

#![forbid(unsafe_code)]

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

use anyhow::{Context, Result, bail};
use clap::{Parser, ValueEnum};
use confmark::Document;

/// Bidirectional Markdown ⇄ Confluence Storage Format converter.
#[derive(Parser)]
#[command(version, about)]
struct Args {
    /// Source format to convert from.
    #[arg(short, long, value_enum)]
    from: Format,

    /// Target format to convert to.
    #[arg(short, long, value_enum)]
    to: Format,

    /// Input file; reads standard input when omitted.
    input: Option<PathBuf>,

    /// Output file; writes standard output when omitted.
    #[arg(short, long)]
    output: Option<PathBuf>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
enum Format {
    #[value(alias = "md")]
    Markdown,
    #[value(alias = "cf")]
    Confluence,
}

impl Format {
    fn parse(self, src: &str) -> Document {
        match self {
            Format::Markdown => Document::from_markdown(src),
            Format::Confluence => Document::from_confluence(src),
        }
    }

    fn render(self, doc: &Document) -> String {
        match self {
            Format::Markdown => doc.to_markdown(),
            Format::Confluence => doc.to_confluence(),
        }
    }
}

fn run() -> Result<()> {
    let args = Args::parse();
    if args.from == args.to {
        bail!("source and target formats must differ");
    }

    let input = match &args.input {
        Some(path) => fs::read_to_string(path).with_context(|| format!("failed to read {}", path.display()))?,
        None => {
            let mut buf = String::new();
            io::stdin()
                .read_to_string(&mut buf)
                .context("failed to read stdin")?;
            buf
        },
    };

    let output = args.to.render(&args.from.parse(&input));

    match &args.output {
        Some(path) => {
            if let Some(parent) = path.parent() {
                fs::create_dir_all(parent).with_context(|| format!("failed to create {}", parent.display()))?;
            }
            fs::write(path, output).with_context(|| format!("failed to write {}", path.display()))?;
            eprintln!("Saved {}", path.display());
            Ok(())
        },
        None => io::stdout()
            .write_all(output.as_bytes())
            .context("failed to write stdout"),
    }
}

fn main() {
    if let Err(error) = run() {
        eprintln!("Error: {error:?}");
        std::process::exit(1);
    }
}

#[cfg(test)]
mod tests {
    use clap::ValueEnum;
    use rstest::rstest;

    use super::Format;

    #[rstest]
    #[case("md", Format::Markdown)]
    #[case("markdown", Format::Markdown)]
    #[case("cf", Format::Confluence)]
    #[case("confluence", Format::Confluence)]
    fn parses_format_aliases(#[case] input: &str, #[case] expected: Format) {
        assert_eq!(Format::from_str(input, true).unwrap(), expected);
    }
}