otavioschwanck/arrow.nvim
github
245
4
4
15
arrow.nvim
Arrow.nvim is a plugin made to bookmarks files (like harpoon) using a single UI (and single keymap).
Arrow can be customized for everyone needs.
Arrow also provides per buffer bookmarks that will can quickly jump to them. (And their position is automatically updated / persisted while you modify the file)
Per Project / Global bookmarksL:
Installation
Lazy
return {
"otavioschwanck/arrow.nvim",
opts = {
show_icons = true,
leader_key = ';', -- Recommended to be a single key
buffer_leader_key = 'm', -- Per Buffer Mappings
}
}
Packer
use { 'otavioschwanck/arrow.nvim', config = function()
require('arrow').setup({
show_icons = true,
leader_key = ';' -- Recommended to be a single key
buffer_leader_key = 'm', -- Per Buffer Mappings
})
end }
Usage
Just press the leader_key set on setup and follow you heart. (Is that easy)
Differences from harpoon:
- Single keymap needed
- Different UI to manage the bookmarks
- Statusline helpers
- Show only the filename (show path only when needed: same filename twice or too generic filename, like create, index, etc)
- Has colors and icons <3
- Has the delete mode to quickly delete items
- Files can be opened vertically or horizontally
- Still has the option to edit file
Advanced Setup
{
show_icons = true,
always_show_path = false,
separate_by_branch = false, -- Bookmarks will be separated by git branch
hide_handbook = false, -- set to true to hide the shortcuts on menu.
save_path = function()
return vim.fn.stdpath("cache") .. "/arrow"
end,
mappings = {
edit = "e",
delete_mode = "d",
clear_all_items = "C",
toggle = "s", -- used as save if separate_save_and_remove is true
open_vertical = "v",
open_horizontal = "-",
quit = "q",
remove = "x", -- only used if separate_save_and_remove is true
next_item = "]",
prev_item = "["
},
custom_actions = {
open = function(target_file_name, current_file_name) end, -- target_file_name = file selected to be open, current_file_name = filename from where this was called
split_vertical = function(target_file_name, current_file_name) end,
split_horizontal = function(target_file_name, current_file_name) end,
},
window = { -- controls the appearance and position of an arrow window (see nvim_open_win() for all options)
width = "auto",
height = "auto",
row = "auto",
col = "auto",
border = "double",
},
per_buffer_config = {
lines = 4, -- Number of lines showed on preview.
sort_automatically = true, -- Auto sort buffer marks.
satellite = { -- defualt to nil, display arrow index in scrollbar at every update
enable = false,
overlap = true,
priority = 1000,
},
zindex = 10, --default 50
treesitter_context = nil, -- it can be { line_shift_down = 2 }, currently not usable, for detail see https://github.com/otavioschwanck/arrow.nvim/pull/43#issue-2236320268
},
separate_save_and_remove = false, -- if true, will remove the toggle and create the save/remove keymaps.
leader_key = ";",
save_key = "cwd", -- what will be used as root to save the bookmarks. Can be also `git_root`.
global_bookmarks = false, -- if true, arrow will save files globally (ignores separate_by_branch)
index_keys = "123456789zxcbnmZXVBNM,afghjklAFGHJKLwrtyuiopWRTYUIOP", -- keys mapped to bookmark index, i.e. 1st bookmark will be accessible by 1, and 12th - by c
full_path_list = { "update_stuff" } -- filenames on this list will ALWAYS show the file path too.
}
You can also map previous and next key:
vim.keymap.set("n", "H", require("arrow.persist").previous)
vim.keymap.set("n", "L", require("arrow.persist").next)
vim.keymap.set("n", "<C-s>", require("arrow.persist").toggle)
Statusline
You can use require('arrow.statusline') to access the statusline helpers:
local statusline = require('arrow.statusline')
statusline.is_on_arrow_file() -- return nil if current file is not on arrow. Return the index if it is.
statusline.text_for_statusline() -- return the text to be shown in the statusline (the index if is on arrow or "" if not)
statusline.text_for_statusline_with_icons() -- Same, but with an bow and arrow icon ;D
NvimTree
Show arrow marks in front of filename
A small patch is needed.
In nvim-tree.lua/lua/nvim-tree/renderer/builder.lua
change function formate_line to
function Builder:format_line(indent_markers, arrows, icon, name, node)
local added_len = 0
local function add_to_end(t1, t2)
if not t2 then
return
end
for _, v in ipairs(t2) do
if added_len > 0 then
table.insert(t1, { str = M.opts.renderer.icons.padding })
end
table.insert(t1, v)
end
-- first add_to_end don't need padding
-- hence added_len is calculated at the end to be used next time
added_len = 0
for _, v in ipairs(t2) do
added_len = added_len + #v.str
end
end
local line = { indent_markers, arrows }
local arrow_index = 1
local arrow_filenames = vim.g.arrow_filenames
if arrow_filenames then
for i, filename in ipairs(arrow_filenames) do
if string.sub(node.absolute_path, -#filename) == filename then
local statusline = require "arrow.statusline"
arrow_index = statusline.text_for_statusline(_, i)
line[1].str = string.sub(line[1].str, 1, -3)
line[2].str = "(" .. arrow_index .. ") "
line[2].hl = { "ArrowFileIndex" }
break
end
end
end
add_to_end(line, { icon })
for i = #M.decorators, 1, -1 do
add_to_end(line, M.decorators[i]:icons_before(node))
end
add_to_end(line, { name })
for i = #M.decorators, 1, -1 do
add_to_end(line, M.decorators[i]:icons_after(node))
end
return line
end
Highlights
- ArrowFileIndex
- ArrowCurrentFile
- ArrowAction
- ArrowDeleteMode
Working with sessions plugins
If you have any error using arrow with a session plugin, like on mini.sessions, add this to the post load session hook:
require("arrow.git").refresh_git_branch() -- only if separated_by_branch is true
require("arrow.persist").load_cache_file()
Obs: persistence.nvim works fine with arrow.
Special Contributors
- Had the idea of per buffer bookmarks and helped me to implement it.