commit-formatter is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the `git-cf` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install commit-formatter

It will make the git-cf command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall commit-formatter uninstalls.

Adding `commit_formatter` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add commit-formatter

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

commit-formatter = "0.3.0"

The commit_formatter library will be automatically available globally. Read the commit_formatter library documentation.

Back to the crate overview.

Readme

commit-formatter

A Rust version commitizen.

Download

cargo install commit-formatter

If you get a error: 'command not found: commit-formatter', maybe you need to add cargo installation directory to PATH.

Usage

Recommend to use alias like cf.

git add <files>
cf

Updated: after version 0.2.1, this crate's binary target name specified to git-cf, so you can use it with git cf as a git subcommand.

Custom

Put a commit-format.json in your project directory.

Example

[
	{
		"text": "特性",
		"description": "新功能"
	},
	{
		"text": "",
		"description": "修復bug"
	}
]

Installing the git-cf executable

Adding commit_formatter library as a dependency

Installing the `git-cf` executable

Adding `commit_formatter` library as a dependency