1.0.10 • Published 2 years ago
git-kermit v1.0.10
Kermit
Quickly generate conventional commits using the command line.
Inspiration
Using conventional commits styling makes a git history much more organized and readable. However, creating conventional commit messages from scratch can be a nightmare. Luckily, the kermit CLI is here to save the day and make commit messages fun again!
Installation
Kermit is hosted as an npm package, so you will need to have Node.js installed beforehand.
sudo npm install -g git-kermit # Install git-kermit from npm
# Configure the git kermit alias
git config --global alias.kermit '!sh -c '\''kermit -g "$0" "$@"'\'''
Usage
There are two ways to generate commit messages:
git kermit
creates a git commit with the generated messagekermit
prints out the generated messsage
Kermit uses an inuitive form built with Inquirer.js to build commit messages in a user-friendly way.
Features
- Automatically caches the last used commit scope (can be ignored by entering a space " " for the commit scope)
- Breaking changes can be added with the
-b
flag - All fields are input validated
git kermit
supports argument passthrough so flags like--amend
and-a
still work- Supports prekermit (precommit) hooks. If a prekermit hook fails, then kermit will not start the form.
Contributing
This project is small, but plays an important role for teams that use conventional commits. Feel free to add issues or pull requests suggesting new functionality!