Skip to content

gleich/resin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

resin

crates.io lint build test

Fast CLI for conventional commits

What is resin?

resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the conventional commit format. Here is a little demo:

demo

This demo will create the following commit message:

feat[config]: add crates.io fields

Install

You can install resin using cargo:

cargo install resin

Features

Flags

resin has three flags:

  1. --help (-h) -> display a help message to the terminal
  2. --all (-a) -> run git add . before committing the changes
  3. --push (-p) -> run git push after committing the changes

Super simple and easy to use!

Configuration

Configuration is stored in ~/.config/resin/config.toml or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this for this project

Scopes

You can configure resin to have your custom scopes. Below is an example config:

scopes = ['docker', 'github actions']

Sign-off message

You can also have a sign-off message that is based off the contents of your ~/.gitconfig file:

sign = true

This will create a message that will automatically be added to the bottom of your commit message:

Signed-off-by: Matt Gleich <[email protected]>

Parentheses

To have the scope of the commit message be in parentheses instead of square brackets:

parentheses = true

About

Fast CLI for conventional commits

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages