Introduction

December 2, 2024 ยท View on GitHub

dirvish-git.nvim is a plugin for Neovim that provides Gitsigns integration for the builtin vim-dirvish by Justin M. Keyes. Inspired by vim-dirvish-git by Kristijan Husak.

Installation

This plugin requires :

  • Editor: This plugin can be used in either Vim or Neovim.
    • Vim 9.0.0185+ with +lua and +textprop
    • Neovim 0.7.0+
  • vim-dirvish

Use your favorite plugin manager. Below are some examples :

Plug 'justinmk/vim-dirvish'
Plug 'brianhuster/dirvish-git.nvim'
{
    "brianhuster/dirvish-git.nvim",
}

mini.deps

MiniDeps.add({
    source = 'brianhuster/dirvish-git.nvim',
    depends = {
        'justinmk/vim-dirvish',
    },
})

Configuration

Note: you can remove any of the icons by setting them to a space.

Lua

vim.g.dirvish_git_icons = {
    modified = '๐Ÿ–‹๏ธ',
    staged = 'โœ…',
    renamed = 'โžœ',
    unmerged = 'โŒ',
    ignored = '๐Ÿ™ˆ',
    untracked = 'โ“',
    file = '๐Ÿ“„',
    directory = '๐Ÿ“',
}

Vim script

g:dirvish_git_icons = {
    \ 'modified': '๐Ÿ–‹๏ธ',
    \ 'staged': 'โœ…',
    \ 'renamed': 'โžœ',
    \ 'unmerged': 'โŒ',
    \ 'ignored': '๐Ÿ™ˆ',
    \ 'untracked': 'โ“',
    \ 'file': '๐Ÿ“„',
    \ 'directory': '๐Ÿ“',
    \ }

Contributing

If you have any suggestions, bug reports, or contributions, please feel free to open an issue or a pull request.