A tool to write a commit message based on Conventional Commits
inspired by git-cz
cargo install rcz# bash
function gitz() {
local output
if output=$(rcz); then
git commit -m "${output}"
else
echo "Err: failed to generate a commit message"
fi
}or
.gitconfig
[alias]
cz = "!gitz() { if local output= ...}; gitz"
gif
The configuration file will be automatically generated on:
- Linux:
~/.config/rcz - Windows:
{FOLDERID_RoamingAppData}\rcz - Mac OS:
~/Library/Preferences/rs.rcz
Default configuration
format = '''
{type}: {subject}'''
[[types]]
description = 'A bug fix'
value = 'fix'
emoji = '🐛'
[[types]]
description = 'A new feature'
value = 'feat'
emoji = '✨'
[[types]]
description = 'Changes that introduces a breaking API change'
value = 'BREAKING CHANGE'
emoji = '💥'
[[types]]
description = 'build system or external dependencies'
value = 'chore'
emoji = '🛠️'
[[types]]
description = 'CI related changes'
value = 'ci'
emoji = '💫'
[[types]]
description = 'Documentation only changes'
value = 'docs'
emoji = '✏️'
[[types]]
description = 'Changes that do not affect the meaning of the code'
value = 'style'
emoji = '💄'
[[types]]
description = 'A code change that neither fixes a bug nor adds a feature'
value = 'refactor'
emoji = '🧹'
[[types]]
description = ' A code change that improves performance'
value = 'perf'
emoji = '🚄'
[[types]]
description = 'Adding or correcting tests'
value = 'test'
emoji = '🧪'All section etc {scope} that you can add on the format are bellow.
{type}{emoji}{description}
{{echo 'foo'}}, {{date}} etc) is interpreted as shell script.
Other strings ({body}, {footer}, {header} etc) is interpreted as a custom input.
The string is used as a prompt message.
Sometimes you don't have a scope and have to delete the brackets. If a space is entered for scope, brackets are removed altogether. #6
A example for your customize is bellow.
format = '''
{type}{scope}: {emoji}{subject}
{body}
{footer}'''