SuperBo/fugit2.nvim

github github
git
stars 310
issues 5
subscribers 6
forks 6
CREATED

2023-10-13

UPDATED

7 days ago


Fugit2 logo

Neovim git GUI powered by libgit2

Neovim Lua GitHub Workflow Status

Git plugin for Neovim (based on libgit2).

Fugit2 Main View Fugit2 Graph View

✨ Features

  • ✔ Floating git source window.
  • ✔ Magit style menu.
  • ✔ Patch View.
  • ✔ Stage/Unstage hunkes in patch view.
  • ✔ Nice git graph.
  • ✔ Native branch picker.
  • ✔ Diff view.
  • ✔ Git blame.
  • ☐ TODO: In-memory rebase.
  • ☐ TODO: Remap default key binding.
  • ☐ TODO: Proper help menu.

📦 Installation

Third party libraries:

Please refer to Installation Guide.

Neovim

LuaRocks

Rocks.nvim

:Rocks install fugit2.nvim

Lazy

If you are using lazy, you can use this config

{
  'SuperBo/fugit2.nvim',
  opts = {
    width = 70,
  },
  dependencies = {
    'MunifTanjim/nui.nvim',
    'nvim-tree/nvim-web-devicons',
    'nvim-lua/plenary.nvim',
    {
      'chrisgrieser/nvim-tinygit', -- optional: for Github PR view
      dependencies = { 'stevearc/dressing.nvim' }
    },
  },
  cmd = { 'Fugit2', 'Fugit2Diff', 'Fugit2Graph' },
  keys = {
    { '<leader>F', mode = 'n', '<cmd>Fugit2<cr>' }
  }
},

In case you want to use more stable diffview.nvim for diff split view.

{
  'SuperBo/fugit2.nvim',
  opts = {
    width = 70,
    external_diffview = true, -- tell fugit2 to use diffview.nvim instead of builtin implementation.
  },
  dependencies = {
    'MunifTanjim/nui.nvim',
    'nvim-tree/nvim-web-devicons',
    'nvim-lua/plenary.nvim',
    {
      'chrisgrieser/nvim-tinygit', -- optional: for Github PR view
      dependencies = { 'stevearc/dressing.nvim' }
    },
  },
  cmd = { 'Fugit2', 'Fugit2Blame', 'Fugit2Diff', 'Fugit2Graph' },
  keys = {
    { '<leader>F', mode = 'n', '<cmd>Fugit2<cr>' }
  }
},
{
  'sindrets/diffview.nvim',
  dependencies = { 'nvim-tree/nvim-web-devicons' },
  -- lazy, only load diffview by these commands
  cmd = {
    'DiffviewFileHistory', 'DiffviewOpen', 'DiffviewToggleFiles', 'DiffviewFocusFiles', 'DiffviewRefresh'
  }
}

pckr.nvim

TODO: add later

Default options dictionary

---@class Fugit2Config
---@field width integer|string Main popup width
---@field max_width integer|string Main popup popup width when expand patch view
---@field min_width integer File view width when expand patch view
---@field content_width File view content width
---@field height integer|string Main popup height
---@field libgit2_path string? path to libgit2 lib, default: "libgit2"
---@field gpgme_path string? path to gpgme lib, default: "gpgme"
---@field external_diffview boolean whether to use external diffview.nvim or Fugit2 implementation
---@field blame_priority integer priority of blame virtual text
---@field blame_info_width integer width of blame hunk detail popup
---@field blame_info_height integer height of blame hunk detail popup
---@field colorscheme string? custom color scheme override
local opts = {
  width = 100,
  min_width = 50,
  content_width = 60,
  max_width = "80%",
  height = "60%",
  external_diffview = false,
  blame_priority = 1,
  blame_info_height = 10,
  blame_info_width = 60,
}

Tested colorschemes

Usage and Keymap

Please refer to Usage Guide.

Credits

Very special thanks to these plugins and their authors.