feat(commands): add option to wrap when moving buffers at ends (#759)

doc/bufferline.txt

@@ -151,6 +151,7 @@ The available configuration are:
             show_tab_indicators = true | false,
             show_duplicate_prefix = true | false, -- whether to show duplicate buffer prefix
             persist_buffer_sort = true, -- whether or not custom sorted buffers should persist
+            move_wraps_at_ends = false, -- whether or not the move command "wraps" at the first or last position
             -- can also be a table containing 2 custom separators
             -- [focused and unfocused]. eg: { '|', '|' }
             separator_style = "slant" | "slope" | "thick" | "thin" | { 'any', 'any' },

lua/bufferline/commands.lua

@@ -147,6 +147,16 @@ function M.get_current_element_index(current_state, opts)
   end
 end
 
+---@param current_state bufferline.State
+---@return number
+local get_last_pinned_index = function(current_state)
+  for index, item in ipairs(current_state.components) do
+    local element = item:as_element()
+    if not groups.is_pinned(element) then return index - 1 end
+  end
+  return 0
+end
+
 --- Move the buffer at index `from_index` (or current index if not specified) to position `to_index`
 --- @param to_index number negative indices are accepted (counting from the right instead of the left, e.g. -1 for the last position, -2 for the second-last, etc.)
 --- @param from_index number?
@@ -169,8 +179,25 @@ end
 
 --- @param direction number
 function M.move(direction)
-  local index = M.get_current_element_index(state)
-  M.move_to(index + direction, index)
+  local index, element = M.get_current_element_index(state)
+  local next_index = index + direction
+  if not config.options.move_wraps_at_ends or not index then return M.move_to(next_index, index) end
+
+  local last_pinned_index = get_last_pinned_index(state)
+  if groups.is_pinned(element) then
+    if next_index <= 0 then
+      next_index = last_pinned_index
+    elseif next_index > last_pinned_index then
+      next_index = 1
+    end
+  else
+    if next_index <= last_pinned_index then
+      next_index = #state.components
+    elseif next_index > #state.components then
+      next_index = last_pinned_index + 1
+    end
+  end
+  M.move_to(next_index, index)
 end
 
 --- @param direction number

lua/bufferline/config.lua

@@ -642,6 +642,7 @@ local function get_defaults()
     enforce_regular_tabs = false,
     always_show_bufferline = true,
     persist_buffer_sort = true,
+    move_wraps_at_ends = false,
     max_prefix_length = 15,
     sort_by = "id",
     diagnostics = false,

lua/bufferline/groups.lua

@@ -309,7 +309,7 @@ local group_by_name = group_by("name")
 local group_by_priority = group_by("priority")
 
 ---@param element bufferline.TabElement
-local function is_pinned(element) return get_manual_group(element) == PINNED_ID end
+function M.is_pinned(element) return get_manual_group(element) == PINNED_ID end
 
 --- Add a buffer to a group manually
 ---@param group_name string
@@ -478,7 +478,7 @@ end
 function M.toggle_pin()
   local _, element = commands.get_current_element_index(state)
   if not element then return end
-  if is_pinned(element) then
+  if M.is_pinned(element) then
     M.remove_element("pinned", element)
   else
     M.add_element("pinned", element)

lua/bufferline/types.lua

@@ -54,6 +54,7 @@
 ---@field public enforce_regular_tabs boolean
 ---@field public always_show_bufferline boolean
 ---@field public persist_buffer_sort boolean
+---@field public move_wraps_at_ends boolean
 ---@field public max_prefix_length number
 ---@field public sort_by string
 ---@field public diagnostics boolean | 'nvim_lsp' | 'coc'