mdsplode 0.4.1

A CLI tool for exploding and serialising Markdown files (metadata, AST, rendered parts, and rendered whole)
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

use clap::{value_parser, Arg, ArgAction, Command};

pub fn opts() -> Command {
    // strip out usage
    const PARSER_TEMPLATE: &str = "\n\
        {all-args}
    ";
    // strip out name/version
    const USAGE_TEMPLATE: &str = "\
        {about-with-newline}\n\
        {usage-heading}\n    {usage}\n\
        \n\
        {all-args}{after-help}\n\
    ";

    Command::new("shell")
        .multicall(true)
        .arg_required_else_help(true)
        .subcommand_required(true)
        .subcommand_value_name("COMMAND")
        .subcommand_help_heading("COMMMANDS")
        .help_template(PARSER_TEMPLATE)
        .subcommand(
            Command::new("banner")
                .about("Show the mdsplode banner")
                .help_template(USAGE_TEMPLATE),
        )
        .subcommand(
            Command::new("echo")
                .about("Respond with the passed message")
                .help_template(USAGE_TEMPLATE)
                .arg(
                    Arg::new("args")
                        .num_args(0..)
                        .value_parser(value_parser!(String)),
                ),
        )
        .subcommand(
            Command::new("history")
                .alias("hist")
                .about("Show all commands entered so far")
                .help_template(USAGE_TEMPLATE),
        )
        .subcommand(
            Command::new("ping")
                .about("Check for liveliness")
                .help_template(USAGE_TEMPLATE),
        )
        .subcommand(
            Command::new("query")
                .alias("q")
                .alias("jq")
                .about("Perform a jq-style query on the most recently read data (aliases: q, jq)")
                .help_template(USAGE_TEMPLATE)
                .arg(
                    Arg::new("pretty-print")
                        .long("pretty")
                    .help(
                        "Pretty-print the JSON result; only usable on queries that produce valid JSON",)
                    .action(ArgAction::SetTrue))
                .arg(
                    Arg::new("query-string")
                        .num_args(0..)
                        .value_parser(value_parser!(String)),
                ),
        )
        .subcommand(
            Command::new("quit")
                .alias("exit")
                .about("Quit the shell (alias: exit)")
                .help_template(USAGE_TEMPLATE),
        )
        .subcommand(
            Command::new("read")
                .alias("r")
                .about("Read in a data source (alias: r)")
                .help_template(USAGE_TEMPLATE)
                .subcommand(
                    Command::new("md")
                        .about("Set the data source to be read as Markdown")
                        .help_template(USAGE_TEMPLATE)
                        .arg(Arg::new("filename").required(true)),
                )
                .subcommand(
                    Command::new("json")
                        .about("Set the data source to be read as JSON")
                        .help_template(USAGE_TEMPLATE)
                        .arg(Arg::new("filename").required(true)),
                ),
        )
        .subcommand(
            Command::new("show")
                .alias("sh")
                .about("Show various aspects of the mdsplode state (alias: sh)")
                .help_template(USAGE_TEMPLATE)
                .subcommand(
                    Command::new("frontmatter")
                        .alias("fm")
                        .about("Show the parsed front matter data")
                        .help_template(USAGE_TEMPLATE),
                )
                .subcommand(
                    Command::new("in-file")
                        .about("Show the input filename")
                        .help_template(USAGE_TEMPLATE),
                )
                .subcommand(
                    Command::new("parsed")
                        .about("Show the parsed Markdown data (JSON)")
                        .help_template(USAGE_TEMPLATE),
                )
                .subcommand(
                    Command::new("source")
                        .about("Show the Markdown source")
                        .help_template(USAGE_TEMPLATE),
                ),
        )
        .subcommand(
            Command::new("version")
                .alias("ver")
                .about("Display the current version")
                .help_template(USAGE_TEMPLATE),
        )
}