monk

Crates.iomonk
lib.rsmonk
version0.1.10
sourcesrc
created_at2024-09-19 16:41:20.737282
updated_at2024-09-23 15:01:14.351312
descriptionMonk is a simple Git hooks manager written in Rust. It allows you to manage and automate Git hooks easily using a YAML configuration file.
homepagehttps://github.com/daynin/monk
repositoryhttps://github.com/daynin/monk
max_upload_size
id1380481
size171,001
Sergey Golovin (daynin)

documentation

README

Monk is a simple Git hooks manager

License GitHub Issues Crates.io

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

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
Commit count: 19

cargo fmt