Awesome

• Rabbit.nvim
  • Why
  • Install
  • Usage
  • Configuration
  • Preview
• Plugins
  • 
  • 
  • 
  • 
• API
• Custom Plugin

This tool tracks the history of buffers opened in an individual window. With a quick motion, you can be in any one of your last twenty buffers without remembering any details.

Unlike other tools, this remembers history per window, so you can really jump quickly.

Why

Harpoon

• Harpoon requires explicit adding of files; too much effort
  • Rabbit:Oxide remembers your most frequently accessed files in your current directory

Telescope

• Telescope:Buffers doesn't order by last BufEnter
  • Rabbit:History lists in order of most recent BufEnter
  • Rabbit:History does NOT list the file you're currently in, meaning a lightning-quick motion, <leader>r <CR> returns you to whence you came.

:ls and :b

• Too much typing and looking and processing
  • That's what this plugin is designed to solve

And this too...

None of these solutions actually support split screen. You must remember all the details yourself.

• Did you use Lspsaga to open a type, func, or variable declaration?
  • One quick ‣r↵ later, you're back! Only three key presses!
• Are you referencing documentation but you don't like split screen?
  • Three key presses is still better than :b #
  • What happens when you frequently switch between more than two buffers? :b # doesn't cut it

Install

Lazy:

return {
    "voxelprismatic/rabbit.nvim",
    config = function()
        require("rabbit").setup({{opts}})     -- Detailed below
    end,
}

[!WARNING] Rabbit is only tested on Linux, although probably works as well on macOS. Please help with any compatibility issues by raising an issue

[!NOTE] Rabbit is only tested on the latest version of Neovim, which is detailed at the top of the ReadMe. If your version of Neovim is significantly older, bite the bullet and upgrade.

Usage

Just run your keybind! (or :Rabbit {{mode}})

With Rabbit open, you can hit a number 1-9 to jump to that buffer. You can also move your cursor down to a specific line and hit enter to jump to that buffer.

If you hit <CR> immediately after launching Rabbit, it'll open your previous buffer. You can hop back and forth between buffers very quickly, almost like a rabbit...

If you scroll down on the Rabbit window, you'll see all the keybinds available.

Preview

2024-05-30 15-36-13.webm

Configuration

[!NOTE] Be sure to use an LSP, like lua_ls. I have all the types created for your convenience.

<br><br>

note: default colors listed here are from my color theme. rabbit will automatically pull your color theme using several highlight groups, eg Normal or Comment

<br><br>

<br><br>

<br><br>

<br><br>

Note: The key should be the plugin name, with the value being the table described below

<br><br>

Please do not copy this config, it is the default.

-- Use all the below defaults, but set a custom keybind
require("rabbit").setup("any keybind")

-- Defaults
require("rabbit").setup({
    colors = {
        title = { fg = grab_color("Normal"), bold = true },
        index = { fg = grab_color("Comment"), italic = true },
        dir = { fg = grab_color("NonText") },
        file = { fg = grab_color("Normal") },
        term = { fg = grab_color("Constant"), italic = true },
        noname = { fg = grab_color("Function"), italic = true },
        message = { fg = grab_color("Identifier"), italic = true, bold = true },
    },
    window = {
        box = box.round,
        title = "Rabbit",
        plugin_name_position = "bottom",
        emphasis_width = 8,
        width = 64,
        height = 24,
        float = {
            "bottom",
            "right",
        },
        split = "right",
        overflow = ":::",
        path_len = 12,
    },
    default_keys = {
        close = { "<Esc>", "q", "<leader>" },
        select = { "<CR>" },
        open = { "<leader>r" },
        file_add = { "a" },
        file_del = { "<Del>" },
        group = { "A" },
        group_up = { "-" },
    },
    plugin_opts = {},
    enable = {
        "history",
        "reopen",
        "oxide",
        "harpoon",
    },
})