repolens 1.4.0

A CLI tool to audit and prepare repositories for open source or enterprise standards
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

//! # CLI Module
//!
//! This module defines the command-line interface for RepoLens using `clap`.
//!
//! ## Commands
//!
//! | Command | Description |
//! |---------|-------------|
//! | `init` | Initialize a new configuration file |
//! | `plan` | Analyze repository and show planned actions |
//! | `apply` | Apply planned changes to the repository |
//! | `report` | Generate an audit report |
//! | `compare` | Compare two audit reports |
//! | `schema` | Display JSON Schema for report output |
//! | `install-hooks` | Install or remove Git hooks |
//!
//! ## Submodules
//!
//! - [`commands`] - Command implementations
//! - [`exit_codes`] - Standardized exit codes
//! - [`output`] - Report output formatters (JSON, Markdown, SARIF, Terminal)
//!
//! ## Global Options
//!
//! All commands support these global options:
//!
//! - `-v, --verbose` - Increase verbosity level (use multiple times: -v, -vv, -vvv)
//! - `-c, --config <FILE>` - Path to configuration file
//! - `-C, --directory <DIR>` - Working directory (defaults to current directory)
//!
//! ## Examples
//!
//! ```bash
//! # Initialize configuration
//! repolens init --preset opensource
//!
//! # Run audit and show plan
//! repolens plan
//!
//! # Generate JSON report
//! repolens report --format json -o report.json
//!
//! # Apply fixes
//! repolens apply --yes
//! ```

pub mod commands;
pub mod exit_codes;
pub mod output;

use clap::{Parser, Subcommand, ValueHint};
use std::path::PathBuf;

use commands::{
    ApplyArgs, CompareArgs, CompletionsArgs, GenerateManArgs, InitArgs, InstallHooksArgs, PlanArgs,
    ReportArgs, SchemaArgs,
};

/// RepoLens - Audit and prepare repositories for open source or enterprise standards
#[derive(Parser, Debug)]
#[command(name = "repolens")]
#[command(author, version, about, long_about = None)]
#[command(propagate_version = true)]
pub struct Cli {
    /// Increase verbosity level (-v, -vv, -vvv)
    #[arg(short, long, action = clap::ArgAction::Count, global = true)]
    pub verbose: u8,

    /// Path to configuration file
    #[arg(short, long, global = true, value_name = "FILE", value_hint = ValueHint::FilePath)]
    pub config: Option<PathBuf>,

    /// Working directory (defaults to current directory)
    #[arg(short = 'C', long, global = true, value_name = "DIR", value_hint = ValueHint::DirPath)]
    pub directory: Option<PathBuf>,

    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    /// Initialize a new configuration file
    Init(InitArgs),

    /// Analyze repository and show planned actions
    Plan(PlanArgs),

    /// Apply planned changes to the repository
    Apply(ApplyArgs),

    /// Generate an audit report
    Report(ReportArgs),

    /// Display the JSON Schema for audit report output
    Schema(SchemaArgs),

    /// Compare two audit reports
    Compare(CompareArgs),

    /// Install or remove Git hooks (pre-commit, pre-push)
    InstallHooks(InstallHooksArgs),

    /// Generate man page (hidden, for packaging)
    #[command(hide = true)]
    GenerateMan(GenerateManArgs),

    /// Generate shell completion scripts (hidden, for packaging)
    #[command(hide = true)]
    Completions(CompletionsArgs),
}