https://github.com/ChuufMaster/buffer-vacuum

A neovim plugin to vacuum up unused file buffers
https://github.com/ChuufMaster/buffer-vacuum

neovim neovim-plugin nvim plugin

Last synced: 7 days ago
JSON representation

A neovim plugin to vacuum up unused file buffers

• Host: GitHub
• URL: https://github.com/ChuufMaster/buffer-vacuum
• Owner: ChuufMaster
• License: mit
• Created: 2024-06-12T11:31:05.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-17T21:05:04.000Z (5 months ago)
• Last Synced: 2024-08-02T06:23:31.422Z (3 months ago)
• Topics: neovim, neovim-plugin, nvim, plugin
• Language: Lua
• Homepage:
• Size: 11.7 KB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - ChuufMaster/buffer-vacuum - Set a maximum number of buffers to keep open and intelligently delete the oldest buffers over the maximum. (Utility / Cursorline)

README

        
# 🧹 buffer-vacuum

A neovim plugin to vacuum up unused file buffers

## ✨ Features

- Delete your oldest unsaved/unpinned buffer

- pin buffers to ignore them from the buffer count

## ⚡️ Requirements

- Neovim >=0.10

## TOC

- [🧹 buffer-vacuum](<#-buffer-vacuum>)

  - [✨ Features](<#-features>)

  - [⚡️ Requirements](<#%EF%B8%8F-requirements>)

  - [TOC](<#toc>)

  - [📦 Installation](<#-installation>)

  - [⚙️ Configuration](<#%EF%B8%8F-configuration>)

  - [🚀 Usage](<#-usage>)

  - [Plugins that work well with Buffer Vacuum](<#plugins-that-work-well-with-buffer-vacuum>)

## 📦 Installation

Install the plugin with your preferred package manager:

### 💤 [Lazy.nvim](https://github/folke/lazy.nvim)

```lua

return {

  {

    'ChuufMaster/buffer-vacuum',

    opts = {}

  },

}

```

## ⚙️ Configuration

Buffer-Vacuum comes with the following defaults:

```lua

{

    -- The maximum number of buffers to keep (excluding modified buffer)

    max_buffers = 6,

    -- Change to True if you want pinned buffers to count to the

    -- maximum number buffers

    count_pinned_buffers = false,

    -- Enable notifications every time a buffer is pinned or deleted

    -- Default FALSE

    enable_messages = false,

}

```

## 🚀 Usage

**BufferVacuum** exposes 4 commands to the user:

- **BufferVacuumPinBuffer**: pin the current buffer so that it doesn't get

  deleted

- **BufferVacuumToggle**: Toggle buffer-vacuum

- **BufferVacuumEnable**: Enable buffer-vacuum

- **BufferVacuumDisable**: Disable buffer-vacuum

## Plugins that work well with Buffer Vacuum

- [Bufferline](https://github.com/akinsho/bufferline.nvim)