local a = vim.api local M = {} function M.nvim_tree_callback(callback_name) return string.format(":lua require'nvim-tree'.on_keypress('%s')", callback_name) end M.View = { bufnr = nil, tabpages = {}, width = 30, side = 'left', winopts = { relativenumber = false, number = false, list = false, winfixwidth = true, winfixheight = true, foldenable = false, spell = false, signcolumn = 'yes', foldmethod = 'manual', foldcolumn = '0', cursorcolumn = false, colorcolumn = '0', winhl = table.concat({ 'EndOfBuffer:NvimTreeEndOfBuffer', 'Normal:NvimTreeNormal', 'CursorLine:NvimTreeCursorLine', 'VertSplit:NvimTreeVertSplit', 'SignColumn:NvimTreeNormal', 'StatusLine:NvimTreeStatusLine', 'StatusLineNC:NvimTreeStatuslineNC' }, ',') }, bufopts = { swapfile = false, buftype = 'nofile'; modifiable = false; filetype = 'NvimTree'; bufhidden = 'hide'; }, bindings = { { key = {"", "o", "<2-LeftMouse>"}, cb = M.nvim_tree_callback("edit") }, { key = {"<2-RightMouse>", ""}, cb = M.nvim_tree_callback("cd") }, { key = "", cb = M.nvim_tree_callback("vsplit") }, { key = "", cb = M.nvim_tree_callback("split") }, { key = "", cb = M.nvim_tree_callback("tabnew") }, { key = "<", cb = M.nvim_tree_callback("prev_sibling") }, { key = ">", cb = M.nvim_tree_callback("next_sibling") }, { key = "P", cb = M.nvim_tree_callback("parent_node") }, { key = "", cb = M.nvim_tree_callback("close_node") }, { key = "", cb = M.nvim_tree_callback("close_node") }, { key = "", cb = M.nvim_tree_callback("preview") }, { key = "K", cb = M.nvim_tree_callback("first_sibling") }, { key = "J", cb = M.nvim_tree_callback("last_sibling") }, { key = "I", cb = M.nvim_tree_callback("toggle_ignored") }, { key = "H", cb = M.nvim_tree_callback("toggle_dotfiles") }, { key = "R", cb = M.nvim_tree_callback("refresh") }, { key = "a", cb = M.nvim_tree_callback("create") }, { key = "d", cb = M.nvim_tree_callback("remove") }, { key = "r", cb = M.nvim_tree_callback("rename") }, { key = "", cb = M.nvim_tree_callback("full_rename") }, { key = "x", cb = M.nvim_tree_callback("cut") }, { key = "c", cb = M.nvim_tree_callback("copy") }, { key = "p", cb = M.nvim_tree_callback("paste") }, { key = "y", cb = M.nvim_tree_callback("copy_name") }, { key = "Y", cb = M.nvim_tree_callback("copy_path") }, { key = "gy", cb = M.nvim_tree_callback("copy_absolute_path") }, { key = "[c", cb = M.nvim_tree_callback("prev_git_item") }, { key = "}c", cb = M.nvim_tree_callback("next_git_item") }, { key = "-", cb = M.nvim_tree_callback("dir_up") }, { key = "q", cb = M.nvim_tree_callback("close") }, { key = "g?", cb = M.nvim_tree_callback("toggle_help") } } } ---Find a rogue NvimTree buffer that might have been spawned by i.e. a session. ---@return integer|nil local function find_rogue_buffer() for _, v in ipairs(a.nvim_list_bufs()) do if vim.fn.bufname(v) == "NvimTree" then return v end end return nil end ---Check if the tree buffer is valid and loaded. ---@return boolean local function is_buf_valid() return a.nvim_buf_is_valid(M.View.bufnr) and a.nvim_buf_is_loaded(M.View.bufnr) end ---Find pre-existing NvimTree buffer, delete its windows then wipe it. ---@private function M._wipe_rogue_buffer() local bn = find_rogue_buffer() if bn then local win_ids = vim.fn.win_findbuf(bn) for _, id in ipairs(win_ids) do if vim.fn.win_gettype(id) ~= "autocmd" then a.nvim_win_close(id, true) end end a.nvim_buf_set_name(bn, "") vim.schedule(function () pcall(a.nvim_buf_delete, bn, {}) end) end end -- set user options and create tree buffer (should never be wiped) function M.setup() M.View.side = vim.g.nvim_tree_side or M.View.side M.View.width = vim.g.nvim_tree_width or M.View.width M.View.bufnr = a.nvim_create_buf(false, false) if not pcall(a.nvim_buf_set_name, M.View.bufnr, 'NvimTree') then M._wipe_rogue_buffer() a.nvim_buf_set_name(M.View.bufnr, 'NvimTree') end for k, v in pairs(M.View.bufopts) do vim.bo[M.View.bufnr][k] = v end vim.cmd "au! BufWinEnter * lua require'nvim-tree.view'._prevent_buffer_override()" if vim.g.nvim_tree_disable_keybindings == 1 then return end local user_mappings = vim.g.nvim_tree_bindings or {} if vim.g.nvim_tree_disable_default_keybindings == 1 then M.View.bindings = user_mappings else M.View.bindings = vim.tbl_extend('force', M.View.bindings, user_mappings) end for _, b in pairs(M.View.bindings) do -- TODO: remove this in a few weeks if type(b) == "string" then local warn_str = "Wrong configuration for keymaps, refer to the new documentation. User keymaps setup aborted" require'nvim-tree.utils'.echo_warning(warn_str) break end if type(b.key) == "table" then for _, key in pairs(b.key) do a.nvim_buf_set_keymap(M.View.bufnr, b.mode or 'n', key, b.cb, { noremap = true, silent = true, nowait = true }) end else a.nvim_buf_set_keymap(M.View.bufnr, b.mode or 'n', b.key, b.cb, { noremap = true, silent = true, nowait = true }) end end end local goto_tbl = { right = 'h', left = 'l', top = 'j', bottom = 'k', } function M._prevent_buffer_override() vim.schedule(function() local curwin = a.nvim_get_current_win() local curbuf = a.nvim_win_get_buf(curwin) if curwin ~= M.get_winnr() or curbuf == M.View.bufnr then return end vim.cmd("buffer "..M.View.bufnr) if #vim.api.nvim_list_wins() < 2 then vim.cmd("vsplit") else vim.cmd("wincmd "..goto_tbl[M.View.side]) end vim.cmd("buffer "..curbuf) end) end function M.win_open(opts) if opts and opts.any_tabpage then for _, v in pairs(M.View.tabpages) do if a.nvim_win_is_valid(v.winnr) then return true end end return false else return M.get_winnr() ~= nil and a.nvim_win_is_valid(M.get_winnr()) end end function M.set_cursor(opts) if M.win_open() then pcall(a.nvim_win_set_cursor, M.get_winnr(), opts) end end function M.focus(winnr, open_if_closed) local wnr = winnr or M.get_winnr() if a.nvim_win_get_tabpage(wnr) ~= a.nvim_win_get_tabpage(0) then M.close() M.open() wnr = M.get_winnr() elseif open_if_closed and not M.win_open() then M.open() end a.nvim_set_current_win(wnr) end local function get_width() if type(M.View.width) == "number" then return M.View.width end local width_as_number = tonumber(M.View.width:sub(0, -2)) local percent_as_decimal = width_as_number / 100 return math.floor(vim.o.columns * percent_as_decimal) end function M.resize() if vim.g.nvim_tree_auto_resize == 0 or not a.nvim_win_is_valid(M.get_winnr()) then return end a.nvim_win_set_width(M.get_winnr(), get_width()) end local move_tbl = { left = 'H', right = 'L', bottom = 'J', top = 'K', } function M.open() if not is_buf_valid() then M.setup() end a.nvim_command("vsp") local move_to = move_tbl[M.View.side] a.nvim_command("wincmd "..move_to) a.nvim_command("vertical resize "..get_width()) local winnr = a.nvim_get_current_win() local tabpage = a.nvim_get_current_tabpage() M.View.tabpages[tabpage] = vim.tbl_extend("force", M.View.tabpages[tabpage] or {help = false}, {winnr = winnr}) for k, v in pairs(M.View.winopts) do vim.wo[winnr][k] = v end vim.cmd("buffer "..M.View.bufnr) vim.cmd ":wincmd =" end function M.close() if not M.win_open() then return end if #a.nvim_list_wins() == 1 then local ans = vim.fn.input( '[NvimTree] this is the last open window, are you sure you want to quit nvim ? y/n: ' ) if ans == 'y' then vim.cmd "q!" end return end a.nvim_win_hide(M.get_winnr()) end --- Returns the window number for nvim-tree within the tabpage specified ---@param tabpage number: (optional) the number of the chosen tabpage. Defaults to current tabpage. ---@return number function M.get_winnr(tabpage) tabpage = tabpage or a.nvim_get_current_tabpage() local tabinfo = M.View.tabpages[tabpage] if tabinfo ~= nil then return tabinfo.winnr end end --- Checks if nvim-tree is displaying the help ui within the tabpage specified ---@param tabpage number: (optional) the number of the chosen tabpage. Defaults to current tabpage. ---@return number function M.is_help_ui(tabpage) tabpage = tabpage or a.nvim_get_current_tabpage() local tabinfo = M.View.tabpages[tabpage] if tabinfo ~= nil then return tabinfo.help end end function M.toggle_help(tabpage) tabpage = tabpage or a.nvim_get_current_tabpage() M.View.tabpages[tabpage].help = not M.View.tabpages[tabpage].help end return M