hooksmith 1.16.0

Trivial git hook management tool
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

use clap::{Parser, Subcommand};

/// Commands enum for hooksmith CLI.
#[derive(Subcommand, PartialEq)]
pub(crate) enum Command {
    /// Compare installed hooks with the configuration file
    #[command(about = "Compare installed hooks with configuration file")]
    Compare,

    /// Initialize hooksmith configuration interactively
    #[command(
        about = "Initialize hooksmith configuration interactively",
        alias = "i"
    )]
    Init,

    /// Install all hooks listed in the config file
    #[command(about = "Install all hooks listed in the config file")]
    Install,

    /// Run a specific hook
    #[command(about = "Run a specific hook")]
    Run {
        /// Names of the hooks to run
        #[arg(default_value = None)]
        hook_names: Option<Vec<String>>,

        /// Whether to use interactive selection
        #[arg(short, long, default_value_t = false)]
        interactive: bool,

        /// Show performance timing for hook execution
        #[arg(short, long, default_value_t = false)]
        profile: bool,
    },

    /// Uninstall hooks
    #[command(about = "Uninstall hooks")]
    Uninstall {
        /// Optional name of the hook to uninstall. If not provided, all hooks will be uninstalled.
        #[arg(default_value = None)]
        hook_name: Option<String>,
    },

    /// Validate hooks configuration
    #[command(about = "Validate hooks in configuration file against standard Git hooks")]
    Validate,
}

/// Command line interface structure for hooksmith.
#[derive(Parser)]
#[command(about = "A trivial Git hooks utility.")]
#[command(author = "Tom Planche <tomplanche@proton.me>")]
#[command(name = "hooksmith")]
#[command(version)]
pub(crate) struct Cli {
    /// Command to execute
    #[command(subcommand)]
    pub(crate) command: Command,

    /// Path to the hooksmith.yaml file
    #[arg(short, long, default_value_t = String::from("hooksmith.yaml"))]
    pub(crate) config_path: String,

    /// Whether to print verbose output
    #[arg(short, long, default_value_t = false)]
    pub(crate) verbose: bool,

    /// Whether to perform a dry run
    #[arg(long, default_value_t = false)]
    pub(crate) dry_run: bool,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_cli_parsing() {
        // Test basic command parsing
        let args = vec!["hooksmith", "install"];
        let cli = Cli::parse_from(args);

        match cli.command {
            Command::Install => {}
            _ => panic!("Expected Install command"),
        }

        // Test with arguments
        let args = vec!["hooksmith", "run", "pre-commit", "pre-push"];
        let cli = Cli::parse_from(args);

        match cli.command {
            Command::Run {
                hook_names,
                interactive,
                profile,
            } => {
                assert_eq!(
                    hook_names,
                    Some(vec!["pre-commit".to_string(), "pre-push".to_string()])
                );
                assert!(!interactive);
                assert!(!profile);
            }
            _ => panic!("Expected Run command with hook_names=[pre-commit, pre-push]"),
        }
    }
}