- Manage buffers (list, switch, save, close, multi-(save,close))
- Super lightweight (all the code is in a single file)
- Super fast, (since the code base is very small)
- Super easy to use, (you can list, switch and manage buffers with as few key strokes as possible)
- Highlights the buffer lines as you write them in the prompt
- Save all unsaved
- Close all saved
- Buffer unsaved icon
- Support for diagnostics
- Responsive height
- Not gluted with unnecessary features. (bufferlist comes only with features that you would use)
Install the plugin with your preferred package manager:
{
"EL-MASTOR/bufferlist.nvim",
lazy = true,
keys = { { "<Leader>b", ':BufferList<CR>', desc = "Open bufferlist" } },
dependencies = "nvim-tree/nvim-web-devicons",
cmd = "BufferList",
opts = {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
},
}
-- Lua
use {
"EL-MASTOR/bufferlist.nvim",
-- add a line for dependencies for devicons
requires = {"nvim-tree/nvim-web-devicons"}
config = function()
require("bufferlist").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
end
}
Bufferlist comes with the following defaults:
{
keymap = {
close_buf_prefix = "c",
force_close_buf_prefix = "f",
save_buf = "s",
multi_close_buf = "m",
multi_save_buf = "w",
save_all_unsaved="a",
close_all_saved="d0",
close_bufferlist = "q"
},
width = 40,
prompt = "ο", -- for multi_{close,save}_buf prompt
save_prompt = "σ° ",
top_prompt = true, -- set this to false if you want the prompt to be at the bottom of the window instead of on top of it.
}
The following key maps are buffer local key maps, they work only inside the bufferlist floating window
βοΈππ Note:
<line_number>
and<prefix>
represent the line number of the buffer name, and the first key in the keymap respectively
press the <line_number>
of the buffer name you want to switch to (very simple, isn't this the easiest)
when the loaded buffers are 10 or more, you have to press the numbers quickly to get to the buffer who has 2 digits in
<line_number>
. For example, if you have 15 loaded buffers that are displayed in the bufferlist window, and you want to get to the buffer whose<line_number>
is 12, you need to press 1 and quickly press 2, if you're wait after pressing 1 you will go to the buffer in<line_number>
1 instead
If the buffer is not saved, a circle icon is shown before the buffer name, to save it press s<line_number>
Press c<line_number>
. (doesn't work when the buffer has unsaved changes)
Pressing f<line_number>
will close the buffer even if it contains unsaved changes
Press keymap.save_all_unsaved
Press keymap.close_all_saved
Press keymap.multi_close_buf
to show a prompt, and then enter the <line_number>
s of all the buffers you want to close, seperated by a seperator. The seperator should be any non-digit character, and there is no limit to the length or the kind of characters used in the seperator as long as they are not digits.
βοΈMake sure that the first character isn't
!
.
βοΈIf you specified an unsaved buffer, it is ignored.
If a
<line_number>
you specified doesn't exist in the bufferlist window line numbers, it is ignored.
Press keymap.multi_close_buf
and then enter !
at the very beginning of the prompt, and then carry on with the rest of the steps already described in Closing multiple buffers
βοΈMake sure that
!
is the very first character in the prompt, it shouldn't be preceded by anything, otherwise it would behave just like Closing multiple buffers
Press keymap.multi_save_buf
and then enter all the <line_number>
s of the buffers you want to save seperated by a seperator. The seperator has the same characteristics described in Closing multiple buffers
Press keymap.close_bufferlist
or just leave the bufferlist window
βοΈππ Note: _timeout between
<perfix>
and<line_number>
is controlled by the vim global option timeoutlen (which by default is set to 1000ms).
βοΈYou have to quickly press
<line_number>
before timeoutlen. Otherwise vim will enter operator pending mode and these keymaps will not work. This happens because there are global defined key maps starting one of with the keyss
,c
orf
. If you wait until timeoutlen has passed, vim will execute the global mapping instead. Therefore you have to press Esc and try again quicker. However it is still recommended to not remap them usingctrl
,alt
,shift
and<leader>
keys since that will add more key strokes for you._
βοΈππ Note: _Terminal buffers are ignored in closing or multi-closing. To close them, you have to force-close them, or force-multi-close them.
π‘ Tip: _Does not provide keymappings for commands, or maps already builtin in nvim, (such as
:bnext
,:bufdo
,<Ctrl_6>
, ...). If you want additional mappings for buffer management and navigations, you can check out:h buffer-list
,:h editing
,:h windows
, etc... .
βοΈππ Note: _The buffers are listed in the same order as the buffer-list (
:buffers
).
βοΈππ Note: _Empty buffers are ignored while saving. (empty buffers usually occur when they are in the
argument-list
but not yet loaded).
ππ Note: _Bufferlist will show icons in the virt text. If you have diagnostic icons defined (for example with
sign_defign
), bufferlist will show the latter instead.
BufferList
BufferListCurrentBuffer
BufferListModifiedIcon
BufferListCloseIcon
BufferListLine
BufferListPromptSeperator
BufferListPromptForce
BufferListPromptMultiSelected
- If you've got an issue or come up with an awesome idea, don't hesitate to open an issue in github.
- If you think this plugin is useful or cool, consider rewarding it with a star.