README.md

gitmoji.nvim

Gitmojis for Neovim using nvim-cmp

Installation

You can install the plugin via Lazy like this:

{
    "Dynge/gitmoji.nvim",
    dependencies = {
        "hrsh7th/nvim-cmp",
    },
    opts = {},
    ft = "gitcommit",
},

Configuration

Configuration and setup is done by calling the .setup() method like so:

-- directly calling setup
require("gitmoji").setup({})

-- or using ´opts´ table in lazy table
{
    "Dynge/gitmoji.nvim",
    dependencies = {
        "hrsh7th/nvim-cmp",
    },
    opts = { -- the values below are the defaults
        filetypes = { "gitcommit" },
        completion = {
            append_space = false,
            complete_as = "emoji",
        },
    },
    ft = "gitcommit",
},

Note: For more details on the config options read the help file.

Be sure to set the source into your nvim-cmp opts:

require("cmp").setup({
  sources = {
    { name = 'gitmoji' }
  })
})

Usage

Gitmoji completion simply adds a gitmoji source to nvim-cmp setup.

The completion is triggered on the : character.