hooked/hooked-cli/source/cli/mod.rs

//! [`clap`] Derive structs.

use std::path::PathBuf;

use {
  clap::{Args as Arguments, Parser, Subcommand},
  hooked_config::NoiseLevel,
};

#[cfg(debug_assertions)]
mod cli_reference;
mod install;
mod run;
mod uninstall;

#[cfg(debug_assertions)]
pub use cli_reference::hooked_cli_reference;
pub use install::hooked_install;
pub use run::hooked_run;
pub use uninstall::hooked_uninstall;

/// CLI arguments struct using [`clap::Parser`].
#[derive(Debug, Parser)]
#[clap(about, author, version)]
#[clap(propagate_version = true)]
pub struct Args {
  /// The CLI subcommand.
  #[clap(subcommand)]
  pub command: MainSubcommands,

  /// Path to a Hooked configuration.
  #[clap(short, long, global = true, default_value = "Hooked.toml")]
  pub config: PathBuf,
}

/// Main CLI subcommands.
#[derive(Debug, Subcommand)]
pub enum MainSubcommands {
  /// Install Hooked into ".git/hooks".
  Install(InstallArgs),

  /// Remove installed hooks.
  Uninstall(UninstallArgs),

  /// Manually run hooks.
  Run(RunArgs),

  #[cfg(debug_assertions)]
  /// Generate the CLI reference file for the mdBook.
  CliReference(CliReferenceArgs),
}

/// The `install` subcommand arguments.
#[derive(Debug, Arguments)]
pub struct InstallArgs {
  /// Overwrite existing files.
  #[clap(long)]
  pub overwrite: bool,

  /// Don't output any information.
  #[clap(long)]
  pub silent: bool,
}

/// The `uninstall` subcommand arguments.
#[derive(Debug, Arguments)]
pub struct UninstallArgs {
  /// Remove hooks not installed by Hooked.
  #[clap(long)]
  pub all: bool,
}

/// The `run` subcommand arguments.
#[derive(Debug, Arguments)]
pub struct RunArgs {
  /// The hook type to run.
  #[clap(value_parser = crate::HOOK_TYPES)]
  pub hook_type: String,

  /// The noise level to override for all hooks.
  #[clap(long)]
  pub noise_level: Option<NoiseLevel>,
}

/// The `cli-reference` subcommand arguments.
#[derive(Debug, Arguments)]
pub struct CliReferenceArgs {
  /// Path where the CLI reference file should be generated.
  #[clap(short, long, default_value = "hooked-book/source/")]
  pub output: PathBuf,
}