https://github.com/gremble0/bufferstack.nvim

Neovim plugin that fixes unintuitive :bprevious and :bnext behavior
https://github.com/gremble0/bufferstack.nvim

lua nvim nvim-plugin

Last synced: 2 months ago
JSON representation

Neovim plugin that fixes unintuitive :bprevious and :bnext behavior

• Host: GitHub
• URL: https://github.com/gremble0/bufferstack.nvim
• Owner: gremble0
• License: mit
• Created: 2023-12-17T21:45:23.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-03T18:53:04.000Z (10 months ago)
• Last Synced: 2024-04-03T20:06:39.146Z (10 months ago)
• Topics: lua, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 19.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bufferstack.nvim

A plugin that fixes the unintuitive behavior of the `:bprevious` and `:bnext` commands in vim by providing two patched commands `require("bufferstack").bprevious` and `require("bufferstack").bnext`, alternatively you can use the user commands `:Bprevious` and `:Bnext`. The plugin maintains an internal stack (hence the name) that is rotated left or right whenever the `bprevious` or `bnext` commands are invoked.

## Differences from default behavior

In default vim when you do `:bprevious` or `bnext` it will simply look at the list of open buffers and select the buffer with the closest buffer id to the one that is active. This means that if you for example have three open buffers - 1, 2, 3 - and you do `:bprevious` while in buffer 2 it will take you to buffer 1. If you then open buffer 3 and do `:bprevious` again it will take you to buffer 2, which is probably not what you wanted to do.

With this plugin if you were in this same scenario, and you invoked `require("bufferstack").bprevious()` it would take you from buffer 3 to buffer 1, which i find more useful.

The plugin also allows for keeping track of more buffers than the normal buffer list in vim through the `filter_buffers_func` option. If you set this to `vim.api.nvim_buffer_is_valid` it will keep unloaded buffers in the bufferstack allowing you to reopen them with the bprevious command. If you don't set this option it will use `vim.api.nvim_buf_is_loaded` which will only select from the loaded buffers visible when you do `:buffers`

## Setup

Use your favourite package manager to import the plugin **Important: Do not lazy load this plugin**, it needs to call setup() immediately to keep track of what order buffers have been opened in. Following is how to do it with lazy.nvim

```lua

{

  "gremble0/bufferstack.nvim",

  opts = {

    -- This is usually either vim.api.nvim_buffer_is_loaded or vim.api.nvim_buffer_is_valid,

    -- alternatively you could make your own variant. It decides what classifies an open buffer

    filter_buffers_func = vim.api.nvim_buf_is_loaded,

    -- Set keybinds in normal mode for the two functions

    bprevious = "",

    bnext = "",

  },

}

-- If you want to assign the keybinds manually (or want them in more modes

-- than just normal) you can omit them from `opts` and require them manually

local bufferstack = require("bufferstack")

vim.keymap.set({ "n", "v" }, "", bufferstack.bprevious, { desc = "Changes to the previous buffer" })

vim.keymap.set({ "n", "v" }, "", bufferstack.bnext, { desc = "Changes to the next buffer" })

```