rcz

A tool to write a commit message based on Conventional Commits
inspired by git-cz

Installation

sh cargo install rcz

Example

```zsh

bash

function gitz() { if local output=$(rcz); then git commit -m "${output}" else echo "Err: failed to generate a commit message" fi } ```

Configuration

The configuration file will be automatically generated on:

Default configuration

```toml 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 = '๐Ÿงช' ```

Format

All section etc {scope} that you can add on the format are bellow.

:warning: The string that enclosed in double brackets ({{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.

A example for your customize is bellow.

toml format = ''' {type}{scope}: {emoji}{subject} {body} {footer}'''