serde-doc 0.1.0

A tool to generate documentation for Serde serialization and deserialization.
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


use core::str;

use clap::{Parser, Subcommand};
use anyhow::Result;
use serde_doc::generators::get_generator;

#[derive(Parser)]
#[command(
    version = "0.1.0",
    about = "A cargo extension CLI for generating documentation for serde structs",
    override_usage = "cargo serde-doc [OPTIONS] <COMMAND> [ARGS]",
)]
struct Cli {
    #[command(subcommand)]
    command: Commands,

    /// Path to the Cargo.toml file or directory containing it
    #[arg(short, long, default_value = ".")]
    manifest_path: String,
}

#[derive(Subcommand)]
enum Commands {
    /// List available serde structs
    List,
    /// Generate files using a generator
    Gen {
        /// Name of the generator to use
        generator: String,
        /// Destination path for the generated files
        #[arg(short, long)]
        output: Option<String>,

        /// List of structs to generate
        /// If not provided, all structs will be generated
        #[arg(short, long)]
        structs: Option<Vec<String>>,

        /// List of files to be included
        /// If not provided, all files will be included
        #[arg(short, long)]
        files: Option<Vec<String>>,
    },

}


fn main() -> Result<()> {
    let mut args = std::env::args().collect::<Vec<_>>();

    // This handles running as `cargo serde-doc ...`
    if args.get(1).map(String::as_str) == Some("serde-doc") {
        args.remove(1); // Remove the subcommand part
    }

    let cli = Cli::parse_from(args);


    match &cli.command {
        Commands::List => {
            handle_list(cli)
        }
        Commands::Gen { generator: _, output: _, files:_, structs:_ } => {
            handle_gen(cli)
        }
    }

    
}

fn handle_list(args: Cli) -> Result<()> {
    let mut ctx = serde_doc::Context::new();
    serde_doc::extract::process_path(&mut ctx, args.manifest_path)?;
    let structs = ctx.files.iter()
        .flat_map(|file| file.structs.iter())
        .collect::<Vec<_>>();
    for unit in structs {
        println!("{}", unit.name);
    }
    Ok(())
}

fn handle_gen(args: Cli) -> Result<()> {
    let mut ctx = serde_doc::Context::new();
    serde_doc::extract::process_path(&mut ctx, args.manifest_path)?;
    match args.command {
        Commands::Gen { generator, output, files, structs } => {
            let generator = get_generator(&generator)?;

            let config = serde_doc::generators::GeneratorConfig {
                output,
                structs,
                files
            };

            generator.generate(&ctx, &config)?;
        }
        _ => {
            return Err(anyhow::anyhow!("Invalid command"));
        }
    };
    
    Ok(())
}