glint is a friendly tool for creating commits in the [commitlint] style.
This is an early release, so currently you must install the rust toolchain first. Then restart your shell and run the following:
sh
cargo install glint
Assuming ~/.cargo/bin is in your PATH (which the installer does by default), you should be able to run glint and get usage information.
The main command is glint commit which you can shorten to glint c.
If run with no other arguments, you'll receive each of the prompts in sequence.
The first prompt allows you to select files to add to the commit. It will only appear if no files are already staged (e.g. by using git add before running glint).
It's a simple checkbox list where you use the up/down arrow keys to navigate and the Space key to toggle.
You may also toggle all files (even if some are hidden) by toggling the list item named "
Press Enter when you're ready to move to the next prompt.
Each commit needs a type, which you can provide interactively or by using the -t/--type flag when running glint.
You may:
If you need to use a type that isn't in the list, please use the -t flag when running glint, such as glint c -t other-type.
After a type is selected, the optional scope may be provided. You may simply type out the scope you want, and press Enter when you're done.
It's valid to not provide a scope, in which case the commit message will not include the parenthesis (e.g. "fix: some bug" might be the final commit message).
Press Enter when you're done, or Escape to return to the Type prompt.
The final step is to write your commit message. A basic inline text editor is provided where you may enter input as usual.
There are a few extra features (and this will likely increase in the future):
When you're satisfied with your commit message, press Enter to submit it and finalize the commit. You may press Escape to return to the Scope prompt.