clap_doc_generator 0.1.0

Automatically generate CLI documentation from clap definitions and update readme files
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

use clap::Parser;

#[derive(Parser, Debug)]
#[command(
    name = "clap_doc_generator",
    version,
    about = "Extract clap CLI definitions from Rust source code and write them as a markdown table into readme files"
)]
pub struct Args {
    /// The directory to scan for Rust projects with clap
    #[arg(short, long, default_value = ".")]
    pub directory: String,

    /// Recursively scan subdirectories for projects
    #[arg(short, long)]
    pub recursive: bool,

    /// The name of the readme file to update
    #[arg(long, default_value = "readme.md")]
    pub name: String,

    /// Marker for the start of the generated section
    #[arg(long, default_value = "<!-- CLAP_DOC_GEN_START -->")]
    pub start_marker: String,

    /// Marker for the end of the generated section
    #[arg(long, default_value = "<!-- CLAP_DOC_GEN_END -->")]
    pub end_marker: String,
}