mdbook-utils 0.1.3

Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
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

//! Command-line interface.
use std::env;

use anyhow::Context;
use anyhow::Result;
use console::style;
use tracing::debug;

use crate::cli::Cli;
use crate::cli::Command;
mod cli;

/// Entrypoint of the command-line interface.
fn main() -> Result<()> {
    // Load environment variables from a `.env` file (in the current directory or
    // parents), if it exists. If variables with the same names already exist in
    // the environment, their values are preserved.
    let dotenv = dotenvy::dotenv();

    // Set RUST_LOG, if not present, and initialize logging
    let key = "RUST_LOG";
    if env::var(key).is_err() {
        env::set_var(key, "info"); // TODO
    }
    tracing_subscriber::fmt::init();

    match dotenv {
        Ok(pb) => {
            debug!("`.env` file loaded: {:?}", pb);
        }
        Err(e) => {
            debug!("`.env` file not found or not readable: {}", e);
        }
    }

    let Cli {
        command: cmd,
        global_opts,
    } = cli::parse_arguments();

    // Retrieves default configuration (from `book.toml``, env. vars,
    // or hard-coded defaults); also stores global_opts.
    let config = cli::config::init(global_opts)?;
    debug!("{:?}", config);

    match cmd {
        Command::RefDefs(subcmd) => {
            cli::refdefs_commands::run(subcmd, config)?;
        }
        Command::Links(subcmd) => {
            cli::links_commands::run(subcmd, config)?;
        }
        Command::Markdown(subcmd) => {
            cli::markdown_commands::run(subcmd, config)?;
        }
        Command::SiteMap(args) => {
            let markdown_src_dir_path = config.markdown_src_dir_path(args.src, "./src/")?;
            let base_url = config.base_url(args.base)?;
            let sitemap_dest_file_path = config.sitemap_file_path(args.dest);

            println!(
                "Generating {} from the list of Markdown files in {}...",
                style(sitemap_dest_file_path.display()).cyan(),
                style(markdown_src_dir_path.display()).cyan(),
            );
            mdbook_utils::generate_sitemap(markdown_src_dir_path, base_url, sitemap_dest_file_path)
                .context("[main] Failed to generate the sitemap.")?;
            println!("{}", style("Done.").green());
        }
        Command::Debug(args) => {
            let markdown_src_dir_path = config.markdown_src_dir_path(args.src, "./src/")?;
            let log_dest_path = config.dest_file_path(args.dest, "debug.log");
            println!(
                "Parsing Markdown files in {} and writing raw events to {}...",
                style(markdown_src_dir_path.display()).cyan(),
                style(log_dest_path.display()).cyan()
            );
            mdbook_utils::debug_parse_to(markdown_src_dir_path, log_dest_path)
                .context("[main] Failed to generate the debug log.")?;
            println!("{}", style("Done.").green());
        }
        Command::Test => {
            mdbook_utils::test().context("[main] Failed to generate the test file.")?;
            println!("{}", style("Done.").green());
        } /* Add more subcommands here: Some(args::Commands::...) => { ... }
           * _ => {
           *     println!("NOT IMPLEMENTED");
           * } */
    }
    Ok(())
}