Udir is a small (~400 sloc) directory viewer for neovim (>= 0.7). Similar to vim-dirvish, udir opens within the current window and is not meant to be used as a project drawer as found in IDEs.
However, udir differs from vim-dirvish in a few key ways.
-
Udir does not use modifiable buffers. I found myself seldom using this feature and I prefer the extra keymap availability from not having modifiable buffers.
-
Udir buffers don't populate the jumplist. Hitting
<C-o>will never take you to a udir buffer. This is partly a matter of personal preference, and dirvish opts against it. -
Udir ensures that each instance is isolated. This means that if you open udir to the same directory in two different windows, those buffers are distinct, and as such, opening a file or navigating in one won't affect the other.
To achieve isolation, udir must give each buffer a unique name. Usually, this is the directory path, such that commands like
:cd %work. However, if you have multiple loaded udir buffers on the same directory, the buffer names will be made unique by appending an id like "[2]" to the name (in which case:cd %won't work).Admittedly, this is a hack; vim buffers are intended to have a 1-to-1 mapping with files. When naming a buffer with something that looks like a path, vim internally canonicalizes the name in order to avoid having multiple buffers correspond to the same file. However, this approach avoids surprising and inconvenient behavior that occurs when windows share the same buffer.
You can use the :Udir [dir] command to open udir, or create your own mapping:
vim.api.nvim_set_keymap("n", "-", "<Cmd>Udir<CR>", {noremap = true})Udir does not require any configuration, but can be configured by mutating udir.config.
The defaults are listed below.
local udir = require'udir'
udir.config = {
-- Whether hidden files should be shown by default
show_hidden_files = false,
-- Function used to determine what files should be hidden
is_file_hidden = function (file, files, dir) return false end,
-- Function used to sort files
sort = function (files)
table.sort(files, function (a, b)
if (a.type == "directory") == (b.type == "directory") then
return a.name < b.name
else
return a.type == "directory"
end
end)
end,
keymaps = {
q = udir.quit,
h = udir.up_dir,
["-"] = udir.up_dir,
l = udir.open,
["<CR>"] = udir.open,
s = udir.open_split,
v = udir.open_vsplit,
t = udir.open_tab,
R = udir.reload,
d = udir.delete,
["+"] = udir.create,
m = udir.move,
c = udir.copy,
["."] = udir.toggle_hidden_files
}
}The is_file_hidden() function has the following API:
type file = {
name: string, // The file name
type: "file" | "directory" | "link" // The file type
}
// A sequential table containing all files in the current directory
type files = list<file>
// The absolute path of the current directory
type dir = string
type is_file_hidden = (file, files, dir) => booleanYou can also customize the colors in udir using the following highlight groups:
UdirDirectory
UdirSymlink
UdirExecutable
UdirVirtText
Udir is intended to be a small, simple plugin. Future changes are unlikely to include major feature additions and will probably be limited to bugfixes and small, quality of life improvements. However, if you have a suggestion for something, feel free to file an issue.
Some minor bits of code were adapted from vim-dirvish and nvim-tree.