fast-conventional

Crates.iofast-conventional
lib.rsfast-conventional
version2.3.5
sourcesrc
created_at2022-02-18 17:38:42.711039
updated_at2024-02-15 09:16:44.598895
descriptionMake conventional commits, faster, and consistently name scopes
homepage
repositoryhttps://github.com/PurpleBooth/fast-conventional
max_upload_size
id534811
size293,885
Billie Thompson (PurpleBooth)

documentation

README

Fast
Conventional Fast
Conventional

Make conventional commits, faster, and consistently name scopes

Usage

Given we have configured the tool, it looks for this in the root of the git repository.

.fastconventional.yaml

use_angular: true
types: [ci]
scopes: ["mergify", "just", "github"]

When we commit, git has generated this stub configuration

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch master
# Your branch is up to date with 'origin/master'.
#
# Changes to be committed:
#       new file:   README.md

We can add our conventional message using this neat UI

A terminal running the command
blow

Installing

See the releases page we build for linux and mac (all x86_64), alternatively use brew

brew install PurpleBooth/repo/fast-conventional

This binary is designed to be run as a editor in git. To install it run

git config --global alias.fci '-c "core.editor=fast-conventional editor" commit'

To trigger it when you commit run

git fci

Further Docs

Commit count: 222

cargo fmt