This project was originally written for using gitmoji from your command line, but has since evolved into a helper for conventional commits. Instead of using text though, emojis are used as the commit type.
git clone [email protected]:MordragT/comoji.git
cd comoji
$ cargo install --path . --locked
Add comoji as nix input and simply use the overlay.
{
inputs.comoji.url = "github:MordragT/comoji";
outputs = { self, nixpkgs, comoji, ... }@inputs:
let
pkgs = import nixpkgs {
inherit system;
overlays = [ comoji.overlays.default ];
};
in {
...
home.packages = with pkgs; [ comoji ];
}
}
$ comoji --help
CLI for conventional emoji commits
Usage: comoji [OPTIONS] <COMMAND>
Commands:
list List all available comojis
commit Interactively commit using the prompts
config Setup preferences
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose
-h, --help Print help
You can use the commit functionality in two ways, directly or via a commit-hook.
Start the interactive commit client, to auto generate your commit based on your prompts.
$ comoji commit
Set config as shown below.
$ git add .
$ git commit
comoji commit
command.
Pretty print all the available comojis.
$ comoji list
Run comoji config
to setup some preferences, such as the auto git add .
feature.
- GitMoji - the project comoji is built upon