Merge pull request #71 from francescarpi/develop

release: v2025-02-27

Author: francescarpi

README.md

@@ -65,6 +65,7 @@ Based on this, I created *Buffon* with the best of both plugins, perfectly adapt
 return {
   {
     "francescarpi/buffon.nvim",
+    ---@type BuffonConfig
     opts = {
       --- Add your config here
     },
@@ -84,6 +85,7 @@ Below you can see the default configuration, which you can adjust to your liking
 return {
   {
     "francescarpi/buffon.nvim",
+    ---@type BuffonConfig
     opts = {
       cyclic_navigation = true,
     },
@@ -148,6 +150,41 @@ Take a look at the default shortcuts for navigating between buffers, changing th
 > vim.keymap.set("n", "c-l", vim.lsp.buf.hover)
 > ````
 
+### Disable keybindings
+
+The keybindings shown in the following list can be deactivated. The reason for this is that some people may not be interested in using the functionality to close buffers, move them, etc.
+
+```lua
+{
+  move_buffer_up,
+  move_buffer_down,
+  move_buffer_top,
+  move_buffer_bottom,
+  switch_previous_used_buffer,
+  close_buffer,
+  close_buffers_above,
+  close_buffers_below,
+  close_all_buffers,
+  close_others,
+  reopen_recent_closed_buffer,
+}
+```
+
+To do this, you only have to assign the string "false" in the configuration. For example:
+
+
+```lua
+{
+  opts = {
+    keybindings = {
+      close_buffer = "false"
+      close_others = "false"
+    },
+  },
+}
+```
+
+
 ## Screenshots
 
 Buffon window, showing the buffer list:

lua/buffon/config.lua

@@ -47,17 +47,18 @@ local default = {
 ---@class BuffonConfigKeyBinding
 ---@field goto_next_buffer string
 ---@field goto_previous_buffer string
----@field move_buffer_up string
----@field move_buffer_down string
----@field move_buffer_top string
+---@field move_buffer_up string|false
+---@field move_buffer_down string|false
+---@field move_buffer_top string|false
+---@field move_buffer_bottom string|false
 ---@field toggle_buffon_window string
----@field switch_previous_used_buffer string
----@field close_buffer string
----@field close_buffers_above string
----@field close_buffers_below string
----@field close_all_buffers string
----@field close_others string
----@field restore_last_closed_buffer string
+---@field switch_previous_used_buffer string|false
+---@field close_buffer string|false
+---@field close_buffers_above string|false
+---@field close_buffers_below string|false
+---@field close_all_buffers string|false
+---@field close_others string|false
+---@field reopen_recent_closed_buffer string|false
 ---@field show_help string
 ---@field next_page string
 ---@field previous_page string
@@ -76,10 +77,13 @@ local Config = {}
 
 ---@param opts any
 function Config:new(opts)
-  local o = vim.tbl_deep_extend("force", default, opts or {})
-  setmetatable(o, self)
+  local cfg = vim.tbl_deep_extend("force", default, opts or {})
+  if cfg.num_pages < 1 or cfg.num_pages > 4 then
+    cfg.num_pages = 1
+  end
+  setmetatable(cfg, self)
   self.__index = self
-  return o
+  return cfg
 end
 
 M.Config = Config

lua/buffon/maincontroller.lua

@@ -8,6 +8,29 @@ local utils = require("buffon.utils")
 
 local M = {}
 
+---@type table<string, boolean>
+local configurable_disabled_actions = {
+  move_buffer_up = true,
+  move_buffer_down = true,
+  move_buffer_top = true,
+  move_buffer_bottom = true,
+  switch_previous_used_buffer = true,
+  close_buffer = true,
+  close_buffers_above = true,
+  close_buffers_below = true,
+  close_all_buffers = true,
+  close_others = true,
+  reopen_recent_closed_buffer = true,
+}
+
+---@type table<string, boolean>
+local pagination_actions = {
+  next_page = true,
+  previous_page = true,
+  move_to_next_page = true,
+  move_to_previous_page = true,
+}
+
 --- Sets a keymap with the given parameters.
 ---@param lhs string The left-hand side of the keymap.
 ---@param rhs function | string The right-hand side of the keymap.
@@ -63,100 +86,118 @@ end
 
 ---@return table<BuffonAction>
 function MainController:get_shortcuts()
-  return {
+  ---@type table<BuffonAction>
+  local shortcuts = {
     {
-      shortcut = self.config.keybindings.toggle_buffon_window,
+      shortcut = "toggle_buffon_window",
       help = "Show/hide buffer list",
       method = self.action_show_hide_buffon_window,
     },
     {
-      shortcut = self.config.keybindings.goto_next_buffer,
+      shortcut = "goto_next_buffer",
       help = "Next buffer",
       method = self.action_goto_next,
     },
     {
-      shortcut = self.config.keybindings.goto_previous_buffer,
+      shortcut = "goto_previous_buffer",
       help = "Previous buffer",
       method = self.action_goto_previous,
     },
     {
-      shortcut = self.config.keybindings.next_page,
+      shortcut = "next_page",
       help = "Next page",
       method = self.action_next_page,
       method_post_refresh = self.action_select_buffer,
     },
     {
-      shortcut = self.config.keybindings.previous_page,
+      shortcut = "previous_page",
       help = "Previous page",
       method = self.action_previous_page,
       method_post_refresh = self.action_select_buffer,
     },
     {
-      shortcut = self.config.keybindings.move_to_next_page,
+      shortcut = "move_to_next_page",
       help = "Buffer to next page",
       method = self.action_buffer_to_next_page,
     },
     {
-      shortcut = self.config.keybindings.move_to_previous_page,
+      shortcut = "move_to_previous_page",
       help = "Buffer to previous page",
       method = self.action_buffer_to_previous_page,
     },
     {
-      shortcut = self.config.keybindings.move_buffer_up,
+      shortcut = "move_buffer_up",
       help = "Move buffer up",
       method = self.action_move_buffer_up,
     },
     {
-      shortcut = self.config.keybindings.move_buffer_down,
+      shortcut = "move_buffer_down",
       help = "Move buffer down",
       method = self.action_move_buffer_down,
     },
     {
-      shortcut = self.config.keybindings.move_buffer_top,
+      shortcut = "move_buffer_top",
       help = "Move buffer to top",
       method = self.action_move_buffer_top,
     },
     {
-      shortcut = self.config.keybindings.move_buffer_bottom,
+      shortcut = "move_buffer_bottom",
       help = "Move buffer to bottom",
       method = self.action_move_buffer_bottom,
     },
     {
-      shortcut = self.config.keybindings.close_buffer,
+      shortcut = "close_buffer",
       help = "Close buffer",
       method = self.action_close_buffer,
     },
     {
-      shortcut = self.config.keybindings.close_buffers_above,
+      shortcut = "close_buffers_above",
       help = "Close buffers above",
       method = self.action_close_buffers_above,
     },
     {
-      shortcut = self.config.keybindings.close_buffers_below,
+      shortcut = "close_buffers_below",
       help = "Close buffers below",
       method = self.action_close_buffers_below,
     },
     {
-      shortcut = self.config.keybindings.close_all_buffers,
+      shortcut = "close_all_buffers",
       help = "Close all",
       method = self.action_close_buffers_all,
     },
     {
-      shortcut = self.config.keybindings.close_others,
+      shortcut = "close_others",
       help = "Close others",
       method = self.action_close_buffers_other,
     },
     {
-      shortcut = self.config.keybindings.switch_previous_used_buffer,
+      shortcut = "switch_previous_used_buffer",
       help = "Last used buffer",
       method = self.action_switch_previous_used,
     },
     {
-      shortcut = self.config.keybindings.reopen_recent_closed_buffer,
+      shortcut = "reopen_recent_closed_buffer",
       help = "Restore closed buffer",
       method = self.action_reopen_recent_closed,
     },
   }
+
+  ---@type table<BuffonAction>
+  local valid_shortcuts = {}
+  for _, action in ipairs(shortcuts) do
+    local action_can_be_disabled = configurable_disabled_actions[action.shortcut]
+    local action_is_disabled = self.config.keybindings[action.shortcut] == "false"
+    local is_pagination_action = pagination_actions[action.shortcut]
+    local one_page = self.config.num_pages == 1
+
+    if (action_can_be_disabled and action_is_disabled) or (one_page and is_pagination_action) then
+      -- continue
+      log.debug("action ignored", action.shortcut)
+    else
+      table.insert(valid_shortcuts, action)
+    end
+  end
+  return valid_shortcuts
 end
 
 ---@return table<BuffonAction>
@@ -208,7 +249,7 @@ end
 
 function MainController:register_shortcuts()
   for _, action in ipairs(self:get_shortcuts()) do
-    set_keymap(utils.replace_leader(self.config, action.shortcut), function()
+    set_keymap(utils.replace_leader(self.config, self.config.keybindings[action.shortcut]), function()
       self:dispatch(action)
     end, action.help)
   end

lua/buffon/pagecontroller.lua

@@ -83,6 +83,9 @@ end
 
 ---@param pages table<table<BuffonBuffer>>
 local validate_data = function(config, pages)
+  if config.num_pages ~= #pages then
+    error("number of pages doesn't match")
+  end
   for idx = 1, config.num_pages do
     local buffers = pages[idx]
     for _, buffer in ipairs(buffers) do

lua/buffon/ui/help.lua

@@ -32,15 +32,15 @@ function HelpWindow:toggle(actions)
     local highlight = { Constant = {} }
 
     for _, action in ipairs(actions) do
-      local action_len = #utils.replace_leader(self.config, action.shortcut)
+      local action_len = #utils.replace_leader(self.config, self.config.keybindings[action.shortcut])
       if action_len > max_length then
         max_length = action_len
       end
     end
 
     local content = {}
     for idx, action in ipairs(actions) do
-      local shortcut = utils.replace_leader(self.config, action.shortcut)
+      local shortcut = utils.replace_leader(self.config, self.config.keybindings[action.shortcut])
       local shortcut_padded = shortcut .. string.rep(" ", max_length - #shortcut)
       local line = string.format("%s %s", shortcut_padded, action.help)
       table.insert(content, line)

lua/buffon/ui/mainwindow.lua

@@ -53,7 +53,9 @@ function MainWindow:refresh()
   local render = self.page_controller:get_active_page():render()
   self.window:set_content(render.content)
   self.window:set_highlight(render.highlights)
-  self.window:set_footer(self:footer())
+  if self.config.num_pages > 1 then
+    self.window:set_footer(self:footer())
+  end
   self.window:refresh_dimensions()
 end
 

tests/config_spec.lua

@@ -40,4 +40,13 @@ describe("config", function()
       },
     })
   end)
+
+  it("if num_pages is invalid, set default to 1", function()
+    local cfg = config.Config:new({ num_pages = 0 })
+    eq(cfg.num_pages, 1)
+
+    -- limot of num_pages is 4
+    local cfg2 = config.Config:new({ num_pages = 5 })
+    eq(cfg2.num_pages, 1)
+  end)
 end)