go-gitmoji-cli

<!-- ALL-CONTRIBUTORS-BADGE:END -->

```bash

---

| __ | | __ | __ | | |\/| | | | | __ | | | |] || |] | | | | || | | |__ |___ | ```

Abstract

Gitmoji is an emoji guide for GitHub commit messages. Aims to be a standardization cheatsheet - guide for using emojis on GitHub's commit messages. is a nice way to standardize commit messages with emojis.

There is already a nice gitmoji-cli command line interface available. Nevertheless, I was searching a nice project to get a bit more into golang so this cli was born. There are some feature differences between both projects.

Per default the format is conventional-commits with emoji <type>[optional scope]: :smile: <description>

Installation

:warning: Currently the package is in state alpha please be aware that some functionality may change and some bugs may happen.

brew

bash brew tap AndreasAugustin/go-gitmoji-cli https://github.com/AndreasAugustin/go-gitmoji-cli brew install AndreasAugustin/go-gitmoji-cli/go-gitmoji-cli

Remark :warning:

When you receive an error like This repository is configured for Git LFS but 'git-lfs' was not found on your path you most likely have git-lfs installed globally. Do the following

```bash git lfs uninstall

git lfs install --local ```

github issue

Aur

The package is located here

bash pamac update -a pamac install go-gitmoji-cli-bin

Docker

The image is available within 2 docker registries available. Just pull the image to have a local test setup available. To use it, mount the current dir into the working dir.

• dockerhub
• ghcr

```bash

available are the git tags

docker hub

pull the image

docker pull andyaugustin/go-gitmoji-cli:

run the container -> will open a zsh session

note: the local volume mount is missing in the sample command

docker run -it andyaugustin/go-gitmoji-cli:

if you prefer ghcr instead of docker hub

docker pull ghcr.io/andreasaugustin/go-gitmoji-cli:

docker run -it ghcr.io/andreasaugustin/go-gitmoji-cli:

```

Go

bash go install github.com/AndreasAugustin/go-gitmoji-cli@latest

Manual

Download the related release here and unpack the related binary into your path

Configuration

It is possible to configure the cli either with a .go-gitmoji-cli.json file within the repo directory or with command line flags. Environment variables are supported (case insensitive). The key is the same like the parameter with a prefix GOGITMOJICLI_. All parameters are able to be modified with flags.

| parameter | description | default | |--------------------------|----------------------------------------------------------------------------------------------|------------------------------------| | autoadd | perform automatically a git add . | false | | autosign | automatically sign commits (can also be configured with git git config -g commit.gpgsign=true | false | | autosignature | automatically add signature to commits | true | | emojiformat | format of emojis code/emoji | code | | scopeprompt | Prompt for adding the commit scope | false | | bodyprompt | Prompt for adding the commit message body | false | | capitalizetitle | If set to true the commit title description will be capitalized | false | | gitmojisurl | The URL of the gitmojis database | https://gitmoji.dev/api/gitmojis | | usedefaultgit_messages | Use the default git messages (merge, squash, ammend,..) | true | | debug | enable debug mode | false |

The configuration values can be changed with

bash go-gitmoji-cli config [-g]

This will create a file within the local directory or within the OS related config directory (when -g flag is enabled). Reading will follow the following order:

• default values
• global config if exists
• local config if exists
• environment variables
• command flags

Usage

Proxy

The cli is firing at first usage or with the update gitmojis command a http query to the configured gitmoji api url to receive a list of available gitmojis. The cli is using net/http package which is per default respecting the standard system proxy settings done with environment variables.

• HTTP_PROXY
• HTTPS_PROXY
• NO_PROXY

basic commands

```bash

show available commands

go-gitmoji-cli --help ```

```bash

show the version

go-gitmoji-cli --version ```

```bash

list the available gitmojis

go-gitmoji-cli list gitmojis ```

```bash

list the available commit types

go-gitmoji-cli list commit-types ```

Commit

There are 2 ways making commits with the tool

• hooks go-gitmoji-cli hooks --help. With that command it is possible to install a commit hook. To use the hook, just do a git commit <options>. This will trigger the cli.
• commit go-gitmoji-cli commit --help. It is not possible to use this command when you have installed a hook.

```bash

doing a commit with dry-run

go-gitmoji-cli commit --dry-run ```

Some arguments and flags you know from git will be reused. The first message will be parsed and the single parts will be reused. E.g. git commit -S -m "feat(api)!: :smile: also just parts of the message will be reused" -m "this is a message body" This is also true when the go-gitmoji-cli commit -S -m "..." -m "..." is used.

Debugging

There is a flag --debug enabling verbose logging

DEV

The development environment targets are located in the Makefile

bash make help

Deployments

A push/merge to main branch is triggering the deployment. The release action can be found here

Used libraries and tools

Special thanks to gitmoji and gitmoji-cli

• cobra
• viper
• logrus
• bubbletea
• bubbles
• lipgloss
• go-figure
• vhs
• goreleaser

Contributors ✨

Thanks goes to these wonderful people (emoji key):

andy Augustin 📖 💻 👀 🛡️ 🤔 💡 🖋

Benedikt Volkmer 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!