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

//! Command arguments / options

use std::path::PathBuf;

use anyhow::anyhow;
use clap::Args;

/// Destination file
#[derive(Args, Debug)]
pub(crate) struct DestFileArgs {
    /// Path of the file to create
    #[arg(short = 'o', long = "output", value_name = "FILE", value_hint = clap::ValueHint::FilePath)]
    pub(crate) file_path: Option<PathBuf>,
}

/// Destination directory
#[derive(Args, Debug)]
pub(crate) struct DestDirArgs {
    /// Destination directory
    #[arg(short = 't', long = "target-dir", value_name = "DIR", value_hint = clap::ValueHint::DirPath)]
    pub(crate) dir_path: Option<PathBuf>,
}

/// Markdown source directory
#[derive(Args, Debug)]
pub(crate) struct MarkdownDirArgs {
    /// Source directory containing the source Markdown files
    #[arg(short = 'm', long = "markdown-dir", value_name = "DIR", value_hint = clap::ValueHint::DirPath)]
    pub(crate) markdown_dir_path: Option<PathBuf>,
}

/// Directory containing Cargo.toml
#[derive(Args, Debug)]
pub(crate) struct CargoTomlDirArgs {
    /// Path to the directory containing Cargo.toml
    #[arg(short = 'c', long = "cargo-toml-dir", value_name = "DIR", value_hint = clap::ValueHint::DirPath)]
    pub(crate) cargo_toml_dir_path: Option<PathBuf>,
}

/// URL
#[derive(Args, Debug)]
pub(crate) struct UrlArgs {
    /// Base URL
    #[arg(short='b', long="base-url", value_name = "URL", value_parser = parse_url)]
    pub(crate) url: Option<url::Url>,
}

/// Parse a URL
fn parse_url(s: &str) -> Result<url::Url, Box<dyn std::error::Error + Send + Sync + 'static>> {
    // Parse an absolute URL from a string.
    let url = url::Url::parse(s).map_err(|_| anyhow!("Invalid URL: {s}"))?;
    Ok(url)
}

// COMPOSITE ARGS --------------------------------

/// Markdown source directory and destination file
#[derive(Debug, Args)]
#[command(flatten_help = true)]
pub(crate) struct MarkdownSrcDirAndDestFileArgs {
    /// Source directory containing the Markdown files
    #[command(flatten)]
    pub(crate) src: MarkdownDirArgs,

    /// Path to the file to create
    #[command(flatten)]
    pub(crate) dest: DestFileArgs,
}

/// Cargo.toml-containing directory and destination file
#[derive(Debug, Args)]
#[command(flatten_help = true)]
pub(crate) struct DependenciesDirAndDestFileArgs {
    /// Source directory containing the Markdown files
    #[command(flatten)]
    pub(crate) src: MarkdownDirArgs,

    /// Source directory containing Cargo.toml
    #[command(flatten)]
    pub(crate) manifest: CargoTomlDirArgs,

    /// Path to the file to create
    #[command(flatten)]
    pub(crate) dest: DestFileArgs,
}

/// Markdown source directory and destination directory
#[derive(Args, Debug)]
pub(crate) struct MarkdownSrcDirAndDestDirArgs {
    /// Source directory containing the Markdown files
    #[command(flatten)]
    pub(crate) src: MarkdownDirArgs,

    /// Destination directory
    #[command(flatten)]
    pub(crate) dest: DestDirArgs,
}

#[derive(Debug, Args)]
#[command(flatten_help = true)]
pub(crate) struct MarkdownSrcDirUrlAndDestFileArgs {
    /// Source directory containing the source Markdown files
    #[command(flatten)]
    pub(crate) src: MarkdownDirArgs,

    /// Base URL
    #[command(flatten)]
    pub(crate) base: UrlArgs,

    /// Path to the file to create
    #[command(flatten)]
    pub(crate) dest: DestFileArgs,
}

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

    // #[test]
    // fn test() {
    // }
}