weave

README

Weave

Write detailed commit messages without leaving the terminal

Why

• You need to write a description for your commit
• You want to do it from the terminal

Table of Contents

• Installation
• Usage
• Configuation

Installation

Go

go install github.com/joeldotdias/weave@latest

From Source

git clone https://github.com/joeldotdias/weave
cd weave
go install

Usage

weave

Flags

How your title is processed

fix (🛠️): Fixed bug
<type> (<symbol>)<separator>Title...

This can be changed in the configuration file or via flags -a, --add_all Adds all files that have not yet been staged to commit
-t, --title Lets you provide a title and directly skip to the description
-f, --format Format for the type and symbol in the prefix
-s, --separator The separator between the prefix and title. The separator is placed without any additional formatting so whitespace is significant

Configuration

Weave looks for the config in

$XDG_CONFIG_HOME/weave/config.toml
or
$HOME/.config/weave/config.toml

The prefixes along with the symbols are stored here. Only the prefixes provided by you will be used. Weave also supports per project configuration. For this a file called weave.toml must be placed in the root directory of the project

Example

config.toml

add_all = false
format = "<type> <symbol>"
separator = ": "

[symbols]
feat = "🚀"
fix = "🛠️"
chore = "📦"

[themes]
header_bg = "#8AF3FFEE" # Background color of the header
header_fg = "#1e1e1e" # Text color of the header
selected_opt = "#3F56EB" # highlighting the selected prefix from the list