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

pub mod error;
pub(crate) mod git_related;
mod hooksmith;
pub(crate) mod my_clap_theme;
pub(crate) mod utils;

pub use error::{HooksmithError, Result};
pub use hooksmith::Hooksmith;

/// Initialize Hooksmith by reading the configuration file and installing hooks.
/// This is meant to be called from a `build.rs` script.
/// To see the CLI usage, run `hooksmith --help` or go to the project's GitHub [repository](https://github.com/TomPlanche/hooksmith).
///
/// # Arguments
/// * `config_path` - Path to the configuration file
///
/// # Errors
/// * If the configuration file cannot be read or parsed
pub fn init(config_path: &std::path::Path) -> Result<()> {
    let hs = Hooksmith::new_from_config(config_path, false, false)?;

    hs.install_hooks()?;

    Ok(())
}