commitguard
| Crates.io | commitguard |
| lib.rs | commitguard |
| version | 0.2.0 |
| created_at | 2024-02-14 19:30:45.243456+00 |
| updated_at | 2024-03-06 20:58:08.116041+00 |
| description | A commitlint implementation in Rust |
| homepage | https://github.com/zauni/commitguard |
| repository | https://github.com/zauni/commitguard |
| max_upload_size | |
| id | 1140155 |
| size | 59,973 |
Matthias Zaunseder (zauni)
documentation
README
commitguard
A commitlint implementation in Rust.
It's a project to learn Rust, so don't expect production ready code. If anybody has suggestions to make it better, please feel free to open an issue or a PR!
Features:
- 🎚️ Configurable
- 🚀 Blazing fast because
- 🦀 Written in Rust
Installation
cargo install commitguard
Usage
echo "feat(myscope): add new feature" | commitguard
Todos/Ideas:
- Configuration system
- Implement more rules (see commitlint rules or gitlint)
- Implement unit tests for rules
- Allow multiple lines in footer and parse references (like original commitlint)
- Use and parse CLI args (probably with Clap)
- Publish on npm and publish binaries for different platforms (maybe also in package managers like Homebrew)
- Dogfood it to lint our own commit messages
- Add website (probably Github pages) and add links to rule details
- Add devcontainer for easier getting started in VSCode
- Benchmark against original commitlint
- Migration docs from original commitlint to commitguard
- Allow 3rd party rules? Maybe WASM?
- Allow custom parsing?