Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nyngwang/NeoNoName.lua
Layout preserving buffer deletion.
https://github.com/nyngwang/NeoNoName.lua
lua neovim neovim-plugin
Last synced: 14 days ago
JSON representation
Layout preserving buffer deletion.
- Host: GitHub
- URL: https://github.com/nyngwang/NeoNoName.lua
- Owner: nyngwang
- License: mit
- Created: 2022-01-10T17:09:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T12:46:20.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:51:53.357Z (3 months ago)
- Topics: lua, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 35.2 KB
- Stars: 29
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - nyngwang/NeoNoName.lua - Layout preserving buffer deletion. (Split and Window / Indent)
README
NeoNoName.lua
===
Layout preserving buffer deletion in Lua.
## DEMO
https://user-images.githubusercontent.com/24765272/174682735-6112d411-c2bc-4fdb-86ba-b41e67ea198b.mov
## TL;DR
This plugin manages the only `[No Name]` buffer as a replacement to achieve layout-preserving buffer-deletion.
## Intro.
The main function of this plugin is `lua require('neo-no-name').neo_no_name(go_next)`,
where an optional function `go_next` can be provided to "go next" buffer in your way on deletion.
Two facts:
- call `neo_no_name(go_next)` at any buffer that is not `[No Name]`...
- will remove duplicate `[No Name]` buffers if there are many. (This clean-up your buffer list)
- will swap your current buffer with the `[No Name]` buffer. (will create one if it doesn't exist)
- call `neo_no_name(go_next)` again at the `[No Name]` buffer...
- will jump to the buffer arrived by `go_next()` before that buffer got swapped out.
- will delete the buffer that is swapped out.
- by providing `go_next`, you can decide what's the next buffer on deletion.
## Docs
### `neo_no_name(go_next)`
#### `go_next`, type `function`
*default: `function () vim.cmd('bn') end`*
So, for example, if you're a user of [akinsho/bufferline.nvim](https://github.com/akinsho/bufferline.nvim) then you can pass something like this:
```lua
function()
vim.cmd('BufferLineCycleNext')
end
```
### `setup`
#### `go_next_on_delete`, type `boolean`
*default: `true`*
whether or not to `go_next()` after you call `neo_no_name(go_next)` twice on the same window.
#### `should_skip`, type `function`
*default: `function return false end`*
For example, you can skip all terminal buffers on `go_next()`:
```lua
should_skip = function ()
return vim.bo.buftype == 'terminal'
end,
```
#### `before_hooks`, type `{ function, ... }`
*default: `{}`*
You might want to avoid calling `go_next` on some situation.
In this case, you can call `abort()` in any function you provided by `before_hooks`:
```lua
before_hooks = {
-- this abort `NeoNoName` when calling on terminal buffer created by ibhagwan/fzf-lua.
function (u)
if vim.bo.filetype == 'fzf' then
vim.api.nvim_input('a')
u.abort()
end
end,
}
```
where `u` provides some APIs to change the behavior of this plugin:
```
utils.abort: abort the current execution of `NeoNoName`.
```
Feel free to create an issue/PR telling about what you need.
## Example Config
This is an example for [wbthomason/packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
-- remove `use` if you're using folke/lazy.nvim
use {
'nyngwang/NeoNoName.lua',
config = function ()
require('neo-no-name').setup {
before_hooks = {
function (u)
if vim.bo.filetype == 'fzf' then
vim.api.nvim_input('a')
u.abort()
end
end,
},
should_skip = function ()
-- never go next to a terminal buffer.
return vim.bo.buftype == 'terminal'
end,
go_next_on_delete = false, -- layout-preserving buffer deletion.
}
-- replace the current buffer with the `[No Name]`.
vim.keymap.set('n', '', function () vim.cmd('NeoNoName') end)
-- the plain old buffer delete.
vim.keymap.set('n', 'bd', function ()
vim.cmd('NeoNoName')
vim.cmd('NeoNoName')
end)
end
}
```