pacidic / bufjump.nvim

A neovim plugin that jump to previous and next buffer of the jumplist.

bufjump.nvim

bufjump.mov

Have you ever had to temporarily go to another file, perhaps previewing some changes with lsp go to refrenece, fiddle a bit, and have to jump back to the main file that you were working with? Instead of aimlessly smashing CTRL-o and CTRL-i, bufjump.nvim allows you to jump to previous or next buffer in the vim native jumplist with one single command.

Or, have you ever wanted to browse your jumplist within the current buffer, not jumping outside that buffer? Read on.

Prerequistes

• Neovim 0.7 or higher

Installing

with vim-plug

Plug 'kwkarlwang/bufjump.nvim'

with packer.nvim

use {
    "kwkarlwang/bufjump.nvim",
    config = function()
        require("bufjump").setup()
    end
}

Configuration

bufjump.nvim provides the following configuration options:

• forward_key, backward_key the keymappings to jump to the next and previous buffer in the jumplist respectively. The default keymappings for forward_key and backward_key are CTRL-n and CTRL-p respectively. You can deactivate these keybindings by passing false.

• forward_same_buf_key, backward_same_buf_key provide keymappings to jump the the next and previous jumplist positions within the same buffer. These have no default keybindings. Suggestion: <M-i> and <M-o>.

Default configuration:

use({
    "kwkarlwang/bufjump.nvim",
    config = function()
        require("bufjump").setup({
            forward_key = "<C-n>",
            backward_key = "<C-p>",
            on_success = nil
        })
    end,
})

You can also bind the function forward, backward forward_same_buf, backward_same_buf as followed

local opts = { silent=true, noremap=true }
vim.api.nvim_set_keymap("n", "<M-o>", ":lua require('bufjump').backward()<cr>", opts)
vim.api.nvim_set_keymap("n", "<M-i>", ":lua require('bufjump').forward()<cr>", opts)
vim.api.nvim_set_keymap("n", "<M-o>", ":lua require('bufjump').backward_same_buf()<cr>", opts)
vim.api.nvim_set_keymap("n", "<M-i>", ":lua require('bufjump').forward_same_buf()<cr>", opts)

on_success

on_success is a callback function that only executes after a successful backward or forward jump, which means that if there are no previous buffers in the jumplist, then on_success will not be executed.

Suppose that you want to jump to the last cursor position after exiting the buffer instead of the last cursor position in the jumplist stack, you can set the on_success function as followed:

use({
    "kwkarlwang/bufjump.nvim",
    config = function()
        require("bufjump").setup({
            forward_key = "<C-n>",
            backward_key = "<C-p>",
            on_success = function()
                vim.cmd([[execute "normal! g`\"zz"]])
            end,
        })
    end,
})

This will jump to the last cursor position before you left the buffer while also center the cursor to the middle of the screen. You can check :h last-position-jump for more information.

How it works

Under the hood, this plugin uses native CTRL-o and CTRL-i to jump until the buffer is different from the current buffer. If there are no previous or next buffer, then the command does not jump at all.

backward

When jumping to the previous buffer, it will jump to the last occurance in the jumplist that is different from the current buffer. Below is a simple illustration of the before and after position in the jumplist stack.

Before

Buffer 1    line 1
Buffer 1    line 2
Buffer 1    line 3
Buffer 2    line 10
Buffer 2    line 20     <--
Buffer 2    line 30

After

Buffer 1    line 1
Buffer 1    line 2
Buffer 1    line 3      <--
Buffer 2    line 10
Buffer 2    line 20
Buffer 2    line 30

forward

When jumping to the next buffer, it will jump to the last occurance in the jumplist that is different from the current buffer. Below is a simple illustration of the before and after position in the jumplist stack.

Before

Buffer 1    line 1      <--
Buffer 1    line 2
Buffer 1    line 3
Buffer 2    line 10
Buffer 2    line 20
Buffer 2    line 30

After

Buffer 1    line 1
Buffer 1    line 2
Buffer 1    line 3
Buffer 2    line 10
Buffer 2    line 20
Buffer 2    line 30     <--