https://github.com/pplmx/husky-rs
A husky-like hook for Rust.
https://github.com/pplmx/husky-rs
git-hook git-hooks hooks husky husky-rs
Last synced: about 1 month ago
JSON representation
A husky-like hook for Rust.
- Host: GitHub
- URL: https://github.com/pplmx/husky-rs
- Owner: pplmx
- License: apache-2.0
- Created: 2024-09-21T15:23:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-12T07:59:29.000Z (2 months ago)
- Last Synced: 2026-01-12T16:35:30.825Z (2 months ago)
- Topics: git-hook, git-hooks, hooks, husky, husky-rs
- Language: Rust
- Homepage: https://crates.io/crates/husky-rs
- Size: 144 KB
- Stars: 31
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# husky-rs
[](https://github.com/pplmx/husky-rs/actions)
[](https://codecov.io/gh/pplmx/husky-rs)
[](https://crates.io/crates/husky-rs)
[](https://docs.rs/husky-rs)
[](#license)
`husky-rs` is a Git hooks management tool for Rust projects, inspired by Husky.
## Features
- 🚀 **Zero-configuration** - Just add the dependency and create hooks
- ⚡ **Automatic installation** - Hooks configure on `cargo build` or `cargo test`
- 🔄 **Smart rerun detection** - No need for `cargo clean` when updating hooks
- 🎯 **All 27 Git hooks supported** - Client-side and server-side hooks
- 🌍 **Cross-platform** - Works on Unix-like systems and Windows
- 🛠️ **Optional CLI tool** - `husky init`, `husky add`, `husky list` commands
- 📚 **Optional library API** - Helper functions for advanced use cases
## Quick Start
1. Adding `husky-rs` to your project:
You have several options:
```sh
# Option 1: Add as a Regular Dependency
cargo add husky-rs
# Option 2: Add as a Dev Dependency
cargo add --dev husky-rs
# Option 3: Use the Main Branch
cargo add --git https://github.com/pplmx/husky-rs --branch main
cargo add --dev --git https://github.com/pplmx/husky-rs --branch main
```
2. Create hooks directory:
```sh
mkdir -p .husky
```
3. Add a hook (e.g., `pre-commit`):
```sh
echo '#!/bin/sh\necho "Running pre-commit hook"' > .husky/pre-commit
```
4. Install hooks:
```sh
cargo build
```
Or if you're using as a dev-dependency:
```sh
cargo test
```
**Tip:** If you add this library to the `[dependencies]` section, both `cargo build` and `cargo test` will work. However, if it's added under `[dev-dependencies]`, only `cargo test` will function as expected.
## Usage
### Supported Git Hooks
`husky-rs` supports all standard Git hooks by setting `core.hooksPath` to `.husky`. This means you can also place helper scripts (e.g., `.husky/_helpers.sh`) in the same directory and source them from your hooks.
For a complete list, refer to the [Git documentation](https://git-scm.com/docs/githooks).
If you encounter any unsupported hooks, please [open an issue](https://github.com/pplmx/husky-rs/issues).
### Configuration
To skip hook installation (useful in CI environments):
```sh
NO_HUSKY_HOOKS=1 cargo build
```
You can also set this in your environment or CI configuration.
## Optional Tools
### CLI Tool
For added convenience, install the `husky` command-line tool:
```sh
cargo install husky-rs
```
The CLI provides helpful commands:
```sh
husky init # Create .husky directory
husky add pre-commit # Add hook from smart template
husky list # List all installed hooks
husky help # Show help
```
*Note*: The CLI is completely optional - the core functionality works without it!
### Library API
For advanced use cases, husky-rs exposes utility functions:
```rust
use husky_rs::{hooks_dir, should_skip_installation, is_valid_hook_name};
// Check if hook installation should be skipped
if !should_skip_installation() {
let hooks_path = hooks_dir(".");
println!("Hooks directory: {}", hooks_path.display());
}
// Validate a hook name
if is_valid_hook_name("pre-commit") {
println!("Valid hook!");
}
```
See [API documentation](https://docs.rs/husky-rs) for more details.
*Note*: You don't need to call any functions for basic usage - just add the dependency!
## Best Practices
- Keep hooks lightweight to avoid slowing down Git operations
- Use hooks for tasks like running tests, linting code, and validating commit messages
- Non-zero exit status in a hook script will abort the Git operation
## Documentation
📖 **Complete guides for all users:**
- [Usage Guide](docs/usage.md) - Installation, configuration, and advanced usage
- [Examples](docs/examples.md) - 13 ready-to-use hook examples
- [Troubleshooting](docs/troubleshooting.md) - Solutions to common issues
- [Development](docs/development.md) - Contributing guide
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to submit pull requests, report issues, or suggest improvements.
## License
This project is licensed under either of:
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
## Changelog
For a detailed history of changes to this project, please refer to our [CHANGELOG.md](CHANGELOG.md).
## Acknowledgments
- Inspired by [cargo-husky](https://github.com/rhysd/cargo-husky)
- Thanks to the Rust community for their amazing tools and libraries