Lib.rs

Monk is a simple Git hooks manager

Monk's features:

• 🦀 Easily set up in your Rust project. No need to install additional package managers.
• ⚙️ Works with custom build.rs files. Automate the hooks installation process.
• 💻 Run your hooks via CLI. Test your hooks without triggering them via Git.

Keep calm, monk will protect your repo!

Installation

You can install it using cargo:

cargo install monk

Or

You can just add it as a build dependency:

cargo add --build monk

And create build.rs file:

pub fn main() {
    monk::init();
}

In this case monk will be automatically installed and will init all hooks from monk.yaml.

This way is the most convenient way for rust projects since it doesn't require installing monk manually from all contributors.

Usage

Create a configuration file monk.yaml in your project:

pre-commit:
  commands:
    - cargo fmt -- --check
    - cargo clippy -- -D warnings

pre-push:
  commands:
    - cargo test

Then, install the hooks manually:

monk install

Or

Install monk as a build dependency (this is the preferred way):

cargo add --build monk

and create a build script build.rs:

pub fn main() {
    monk::init();
}

This way, monk will automatically install hooks for every team member during the build process.

Running hooks hooks manually

If you want to run specific hooks, use the run command:

monk run pre-commit