snipdoc 0.1.12

Code Documentation Made Simple
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

use std::path::PathBuf;
mod cmd;
use clap::{ArgAction, Parser, Subcommand};
use snipdoc::{config::Config, parser::SnippetKind, reporters};
use tracing::level_filters::LevelFilter;
mod logger;
#[derive(clap::ValueEnum, Default, Clone)]
pub enum Format {
    Table,
    #[default]
    Console,
}

impl Format {
    #[must_use]
    pub fn reporter(&self) -> Box<dyn reporters::ReporterOutput> {
        match self {
            Self::Table => {
                Box::new(reporters::table::Output {}) as Box<dyn reporters::ReporterOutput>
            }
            Self::Console => {
                Box::new(reporters::console::Output {}) as Box<dyn reporters::ReporterOutput>
            }
        }
    }
}

#[derive(Parser)]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
struct Cli {
    #[arg(global = true, short, long, value_enum, default_value = "INFO")]
    /// Log level
    log: LevelFilter,

    /// Source code directory for collecting documentation
    #[clap(global = true, index = 1, default_value = ".")]
    path: PathBuf,

    /// Application config. by default will search `./snipdoc-config.yml`
    #[arg(global = true, short, long, value_enum)]
    config: Option<PathBuf>,

    #[command(subcommand)]
    command: Commands,
}
#[derive(Subcommand)]
enum Commands {
    /// Create a local DB file
    CreateDb {
        /// Show the injection operation without changes
        #[clap(long, action=ArgAction::SetTrue)]
        empty: bool,
    },
    /// Validate if snippets are equal, errors or missing configuration
    Check {
        #[arg(long, default_value = None)]
        db_file: Option<PathBuf>,
    },
    /// Inject snippet into placeholders
    Run {
        #[arg(long, default_value = None)]
        db_file: Option<PathBuf>,

        /// Show the injection operation without changes
        #[clap(long, action=ArgAction::SetTrue)]
        dry_run: bool,

        /// Format of the results
        #[arg(long, value_enum, default_value_t = Format::default())]
        format: Format,
    },
    /// Show snippets
    Show {
        #[arg(long,value_enum, default_value_t = SnippetKind::default())]
        from: SnippetKind,

        #[arg(long, default_value = None)]
        db_file: Option<PathBuf>,

        /// Format of the results
        #[arg(long, value_enum, default_value_t = Format::default())]
        format: Format,
    },
}

fn main() {
    let app: Cli = Cli::parse();

    logger::init(app.log);

    let span = tracing::span!(tracing::Level::INFO, "cli");
    let _guard = span.enter();

    let config = if let Some(config) = app.config {
        match Config::from_file(&config) {
            Ok(config) => config,
            Err(err) => {
                tracing::error!(err = %err, "could not load configuration file");
                std::process::exit(1);
            }
        }
    } else {
        Config::try_from_default_file(app.path.as_path())
    };

    match app.command {
        Commands::CreateDb { empty } => cmd::create_db::exec(&config, app.path.as_path(), empty),
        Commands::Check { db_file } => cmd::check::exec(&config, app.path.as_path(), db_file),
        Commands::Run {
            db_file,
            dry_run,
            format,
        } => cmd::run::exec(&config, app.path.as_path(), db_file, dry_run, &format),
        Commands::Show {
            from,
            db_file,
            format,
        } => cmd::show::exec(&config, app.path.as_path(), &from, db_file, &format),
    }
    .exit();
}