https://github.com/purplebooth/fast-conventional

Make conventional commits, faster, and consistently name scopes
https://github.com/purplebooth/fast-conventional

Last synced: 4 months ago
JSON representation

Make conventional commits, faster, and consistently name scopes

• Host: GitHub
• URL: https://github.com/purplebooth/fast-conventional
• Owner: PurpleBooth
• License: cc0-1.0
• Created: 2021-11-09T13:23:50.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T12:00:16.000Z (about 2 years ago)
• Last Synced: 2024-04-22T13:25:40.381Z (about 2 years ago)
• Language: Rust
• Homepage:
• Size: 382 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
![Fast

Conventional](https://raw.githubusercontent.com/PurpleBooth/fast-conventional/main/logo/logo-light.svg#gh-light-mode-only)

![Fast

Conventional](https://raw.githubusercontent.com/PurpleBooth/fast-conventional/main/logo/logo-dark.svg#gh-dark-mode-only)

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`

``` yaml,file(path=".fastconventional.yaml")

use_angular: true

types: [ci]

scopes: ["mergify", "just", "github"]

```

When we commit, git has generated this stub configuration

``` text,file(path="commit.txt")

# 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](demo.gif "A demo of the app running")

## Installing

See the [releases

page](https://codeberg.org/PurpleBooth/fast-conventional/releases/latest)

for binaries, and see the [packages

page](https://codeberg.org/PurpleBooth/fast-conventional/packages) for

RPM, Arch, Alpine, Debian and Docker repositories.

``` shell,skip()

brew install PurpleBooth/repo/fast-conventional

```

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

``` shell,skip()

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

```

To trigger it when you commit run

``` shell,skip()

git fci

```

## Further Docs

- [Shell completion](./docs/completion.md)

- [Configuration](./docs/configuration.md)

- [Editor](./docs/editor.md)

- [Validate](./docs/validate.md)

- [Cli usage](./docs/cli-usage.md)