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

//! Command-line subcommands to handle reference definitions
use anyhow::Context;
use anyhow::Result;
use clap::Subcommand;
use console::style;

use super::args::*;
use super::config::Configuration;

/// Command-line subcommands to handle reference definitions
#[derive(Subcommand, Debug)]
pub(crate) enum RefDefsSubCommand {
    /// Write existing reference definitions to a file
    Write(MarkdownSrcDirAndDestFileArgs),

    // TODO merge with generation from dependencies?
    /// Generate badges (reference definitions) for e.g. Github links
    #[command(name = "badges")]
    GenerateBadges(MarkdownSrcDirAndDestFileArgs),

    /// Generate reference definitions
    /// from the dependencies of the code examples
    /// and merge them with those found in the Markdown source
    /// directory
    #[allow(dead_code)]
    #[command(skip)]
    #[command(name = "from-dependencies")]
    GenerateFromDependencies(DependenciesDirAndDestFileArgs),
}

/// "refdefs" subcommands of the command-line interface
pub(crate) fn run(subcmd: RefDefsSubCommand, config: Configuration) -> Result<()> {
    match subcmd {
        RefDefsSubCommand::Write(args) => {
            let markdown_src_dir_path = config.markdown_src_dir_path(args.src, "./src/")?;
            let refdef_dest_path = config.dest_file_path(args.dest, "existing_refs.md");
            println!(
                "Parsing markdown files in {} and writing existing reference definitions to {}...",
                style(markdown_src_dir_path.display()).cyan(),
                style(refdef_dest_path.display()).cyan()
            );
            mdbook_utils::write_refdefs_to(markdown_src_dir_path, refdef_dest_path)
                .context("[run] Failed to write reference definitions to a file.")?;
            println!("{}", style("Done.").green());
        }
        RefDefsSubCommand::GenerateBadges(args) => {
            let markdown_src_dir_path = config.markdown_src_dir_path(args.src, "./src/")?;
            let refdef_dest_path = config.dest_file_path(args.dest, "badge_refs.md");
            println!(
                "Parsing markdown files in {} and writing new (github badge) reference definitions to {}...",
                style(markdown_src_dir_path.display()).cyan(),
                style(refdef_dest_path.display()).cyan()
            );
            mdbook_utils::generate_badges(markdown_src_dir_path, refdef_dest_path)
                .context("[run] Failed to generate badges.")?;
            println!("{}", style("Done.").green());
        }
        RefDefsSubCommand::GenerateFromDependencies(args) => {
            let markdown_src_dir_path = config.markdown_src_dir_path(args.src, "./src/")?;
            let cargo_toml_dir_path = config.cargo_toml_dir_path(args.manifest)?;
            let refdef_dest_file_path = config.dest_file_path(args.dest, "dependencies_refs.md");
            println!(
                "Creating reference definitions in {} from the manifest in {} and Markdown sources in {}...",
                style(refdef_dest_file_path.display()).cyan(),
                style(cargo_toml_dir_path.display()).cyan(),
                style(markdown_src_dir_path.display()).cyan(),
            );
            mdbook_utils::generate_refdefs_to(
                cargo_toml_dir_path,
                markdown_src_dir_path,
                refdef_dest_file_path,
            )
            .context("[run] Failed to generate reference definitions from dependencies.")?;
            println!("{}", style("Done.").green());
        } /* _ => {
           *     println!("NOT IMPLEMENTED");
           * } */
    }
    Ok(())
}