hooksmith 1.0.1

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

<pre align="center">
                ,"(                             .
               ////\                           /
              (//////--,,,,,_____            ,"
            _;"""----/////_______;,,        //
__________;"o,-------------......"""""`'-._/(
      ""'==._.__,;;;;"""           ____,.-.==
             "-.:______,...;---""/"   "    \(
                 '-._      `-._("           \\
                     '-._                     '._
</pre>

<h2 align="center">
    Hooksmith, a trivial Git hooks management tool.
</h2>

<p align="center">
    <a href="https://crates.io/crates/hooksmith">
        <img alt="Crates.io" src="https://img.shields.io/crates/v/hooksmith.svg">
    </a>
</p>

## Features

- ⚙️ Automate the hooks installation process with `build.rs` files.
- 💻 Run hooks locally without triggering them via Git.

## Installation

### With Cargo
You can install it using `cargo`:

```sh
cargo install hooksmith
```

### Build Dependency

You can add it as a build dependency:

```sh
cargo add --build hooksmith
```

Then create a `build.rs` file:

```rust
use std::path::Path;

pub fn main() {
    let config_path = Path::new("hooksmith.yaml");

    hooksmith::init(&config_path);
}
```

## Usage

Create a configuration file named `monk.yaml` in your project root:

```yaml
pre-commit:
  commands:
    - cargo fmt --all -- --check
    - cargo clippy --workspace --release --all-targets --all-features -- --deny warnings

pre-push:
  commands:
    - cargo test

```