birdview 0.4.1

Command line tools for project reviews
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use birdview::config::{Config, OutputFormat};
use birdview::run;
use clap::{Parser, Subcommand};
use git2::Repository;
use std::path::PathBuf;
use std::process;
use tempfile::tempdir;

#[derive(Parser)]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
#[command(arg_required_else_help(true))]
struct Cli {
    /// Sets a custom config file
    #[arg(short, long, value_name = "FILE")]
    config: Option<PathBuf>,

    #[command(subcommand)]
    command: Option<Commands>,
}

#[derive(Subcommand)]
enum Commands {
    /// Inspect the workspace
    Inspect {
        /// Workspace directory
        working_dir: String,

        /// Run all inspections
        #[arg(long)]
        all: bool,

        /// Inspect test files
        #[arg(short, long)]
        tests: bool,

        /// Inspect dependencies
        #[arg(short, long)]
        packages: bool,

        /// Inspect angular elements
        #[arg(short, long)]
        angular: bool,

        /// Inspect file types
        #[arg(long)]
        types: bool,

        /// Verbose output
        #[arg(long)]
        verbose: bool,

        /// Output dir to store reports.
        /// By default takes the workspace directory value.
        #[arg(short, long)]
        output_dir: Option<PathBuf>,

        /// Open report in browser where applicable.
        /// Supported for the output formats: html
        #[arg(long)]
        open: bool,

        /// The output format for the report
        #[arg(value_enum, long, default_value_t=OutputFormat::Html)]
        format: OutputFormat,
    },
}

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

    if let Some(config_path) = cli.config.as_deref() {
        println!("Value for config: {}", config_path.display());
    }

    match &cli.command {
        Some(Commands::Inspect {
            working_dir,
            tests,
            packages,
            angular,
            types,
            all,
            verbose,
            output_dir,
            open,
            format,
        }) => {
            if working_dir.starts_with("https://") {
                let repo_dir = tempdir().expect("Failed creating temporary dir");

                let url = match working_dir.strip_suffix(".git") {
                    Some(value) => value,
                    None => working_dir,
                };

                println!("Cloning {} => {}", url, repo_dir.path().display());
                let repo = match Repository::clone(url, &repo_dir) {
                    Ok(repo) => repo,
                    Err(e) => {
                        repo_dir.close().unwrap();
                        panic!("failed to clone: {}", e)
                    }
                };
                println!("Branch: {}", repo.head().unwrap().shorthand().unwrap());

                let config = Config {
                    working_dir: repo_dir.path().to_owned(),
                    output_dir: match output_dir {
                        Some(value) => value.to_owned(),
                        None => std::env::current_dir().unwrap(),
                    },
                    inspect_tests: *all | *tests,
                    inspect_packages: *all | *packages,
                    inspect_angular: *all | *angular,
                    inspect_types: *all | *types,
                    verbose: *verbose,
                    open: *open,
                    format: *format,
                };

                if let Err(e) = run(&config) {
                    eprintln!("Application error {e}");
                    repo_dir.close().unwrap();
                    process::exit(1);
                } else {
                    repo_dir.close().unwrap();
                }
            } else {
                let config = Config {
                    working_dir: PathBuf::from(working_dir),
                    output_dir: match output_dir {
                        Some(dir) => dir.to_owned(),
                        None => PathBuf::from(working_dir),
                    },
                    inspect_tests: *all | *tests,
                    inspect_packages: *all | *packages,
                    inspect_angular: *all | *angular,
                    inspect_types: *all | *types,
                    verbose: *verbose,
                    open: *open,
                    format: *format,
                };

                if let Err(e) = run(&config) {
                    eprintln!("Application error {e}");
                    process::exit(1);
                }
            }
        }
        None => {}
    }
}