Fast CLI for conventional commits
resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the conventional commit format. Here is a little demo:
This demo will create the following commit message:
feat[config]: add crates.io fieldsYou can install resin using cargo:
cargo install resinresin has three flags:
- --help (-h) -> display a help message to the terminal
- --all (-a) -> run
git add .before committing the changes - --push (-p) -> run
git pushafter committing the changes
Super simple and easy to use!
Configuration is stored in ~/.config/resin/config.toml or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this for this project
You can configure resin to have your custom scopes. Below is an example config:
scopes = ['docker', 'github actions']You can also have a sign-off message that is based off the contents of your ~/.gitconfig file:
sign = trueThis will create a message that will automatically be added to the bottom of your commit message:
Signed-off-by: Matt Gleich <[email protected]>To have the scope of the commit message be in parentheses instead of square brackets:
parentheses = true