Merge pull request #1654 from fang2hou/feature/snacks-integration

Author: CKolkey

README.md

@@ -38,6 +38,7 @@ Here's an example spec for [Lazy](https://github.com/folke/lazy.nvim), but you'r
     "nvim-telescope/telescope.nvim", -- optional
     "ibhagwan/fzf-lua",              -- optional
     "echasnovski/mini.pick",         -- optional
+    "folke/snacks.nvim",             -- optional
   },
 }
 ```
@@ -240,6 +241,11 @@ neogit.setup {
     -- is also selected then telescope is used instead
     -- Requires you to have `echasnovski/mini.pick` installed.
     mini_pick = nil,
+
+    -- If enabled, uses snacks.picker for menu selection. If the telescope integration
+    -- is also selected then telescope is used instead
+    -- Requires you to have `folke/snacks.nvim` installed.
+    snacks = nil,
   },
   sections = {
     -- Reverting/Cherry Picking

doc/neogit.txt

@@ -267,6 +267,11 @@ to Neovim users.
         -- is also selected then telescope is used instead
         -- Requires you to have `echasnovski/mini.pick` installed.
         mini_pick = nil,
+
+        -- If enabled, uses snacks.picker for menu selection. If the telescope integration
+        -- is also selected then telescope is used instead
+        -- Requires you to have `folke/snacks.nvim` installed.
+        snacks = nil,
     },
     sections = {
         -- Reverting/Cherry Picking

lua/neogit/config.lua

@@ -362,7 +362,7 @@ end
 ---@field preview_buffer? NeogitConfigPopup Preview options
 ---@field popup? NeogitConfigPopup Set the default way of opening popups
 ---@field signs? NeogitConfigSigns Signs used for toggled regions
----@field integrations? { diffview: boolean, telescope: boolean, fzf_lua: boolean, mini_pick: boolean } Which integrations to enable
+---@field integrations? { diffview: boolean, telescope: boolean, fzf_lua: boolean, mini_pick: boolean, snacks: boolean } Which integrations to enable
 ---@field sections? NeogitConfigSections
 ---@field ignored_settings? string[] Settings to never persist, format: "Filetype--cli-value", i.e. "NeogitCommitPopup--author"
 ---@field mappings? NeogitConfigMappings
@@ -500,6 +500,7 @@ function M.get_default_values()
       diffview = nil,
       fzf_lua = nil,
       mini_pick = nil,
+      snacks = nil,
     },
     sections = {
       sequencer = {
@@ -803,7 +804,7 @@ function M.validate_config()
   end
 
   local function validate_integrations()
-    local valid_integrations = { "diffview", "telescope", "fzf_lua", "mini_pick" }
+    local valid_integrations = { "diffview", "telescope", "fzf_lua", "mini_pick", "snacks" }
     if not validate_type(config.integrations, "integrations", "table") or #config.integrations == 0 then
       return
     end

lua/neogit/lib/finder.lua

@@ -145,6 +145,65 @@ local function fzf_actions(on_select, allow_multi, refocus_status)
   }
 end
 
+---Convert entries to snack picker items
+---@param entries any[]
+---@return any[]
+local function entries_to_snack_items(entries)
+  local items = {}
+  for idx, entry in ipairs(entries) do
+    table.insert(items, { idx = idx, score = 0, text = entry })
+  end
+  return items
+end
+
+--- Utility function to map actions
+---@param on_select fun(item: any|nil)
+---@param allow_multi boolean
+---@param refocus_status boolean
+local function snacks_actions(on_select, allow_multi, refocus_status)
+  local function refresh(picker)
+    picker:close()
+    if refocus_status then
+      refocus_status_buffer()
+    end
+  end
+
+  local function confirm(picker, item)
+    local selection = {}
+    local picker_selected = picker:selected { fallback = true }
+
+    if #picker_selected > 1 then
+      for _, item in ipairs(picker_selected) do
+        table.insert(selection, item.text)
+      end
+    else
+      local entry = item.text
+      local prompt = picker:filter().pattern
+
+      local navigate_up_level = entry == ".." and #prompt > 0
+      local input_git_refspec = prompt:match("%^")
+        or prompt:match("~")
+        or prompt:match("@")
+        or prompt:match(":")
+
+      table.insert(selection, (navigate_up_level or input_git_refspec) and prompt or entry)
+    end
+
+    if selection and selection[1] and selection[1] ~= "" then
+      on_select(allow_multi and selection or selection[1])
+    end
+
+    refresh(picker)
+  end
+
+  local function close(picker)
+    on_select(nil)
+    refresh(picker)
+  end
+
+  return { confirm = confirm, close = close }
+end
+
 --- Utility function to map finder opts to fzf
 ---@param opts FinderOpts
 ---@return table
@@ -274,6 +333,21 @@ function Finder:find(on_select)
   elseif config.check_integration("mini_pick") then
     local mini_pick = require("mini.pick")
     mini_pick.start { source = { items = self.entries, choose = on_select } }
+  elseif config.check_integration("snacks") then
+    local snacks_picker = require("snacks.picker")
+    snacks_picker.pick(nil, {
+      title = "Neogit",
+      prompt = string.format("%s > ", self.opts.prompt_prefix),
+      items = entries_to_snack_items(self.entries),
+      format = "text",
+      layout = {
+        preset = self.opts.theme,
+        preview = self.opts.previewer,
+        height = self.opts.layout_config.height,
+        border = self.opts.border and "rounded" or "none",
+      },
+      actions = snacks_actions(on_select, self.opts.allow_multi, self.opts.refocus_status),
+    })
   else
     vim.ui.select(self.entries, {
       prompt = string.format("%s: ", self.opts.prompt_prefix),