mirror of
https://github.com/neovim/neovim.git
synced 2026-07-21 00:21:38 +00:00
feat(runtime): replace netrw with a very small script #39723
Problem: `:edit <dir>` and `nvim <dir>` currently rely on netrw to show local directory contents. Solution: - Provide `filetype=directory`. - Introduce dir.lua, a small plugin that provides directory listing, opening items, parent navigation, and refresh. - `netrw` remains available for `:Explore`, remote paths, archives, and file operations. To continue Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
This commit is contained in:
Barrett Ruth
328
test/functional/plugin/dir_spec.lua
Normal file
328
test/functional/plugin/dir_spec.lua
Normal file
@@ -0,0 +1,328 @@
|
||||
local n = require('test.functional.testnvim')()
|
||||
local t = require('test.testutil')
|
||||
|
||||
local api = n.api
|
||||
local command = n.command
|
||||
local eq = t.eq
|
||||
local exec_capture = n.exec_capture
|
||||
local exec_lua = n.exec_lua
|
||||
local feed = n.feed
|
||||
local fn = n.fn
|
||||
local ok = t.ok
|
||||
local poke_eventloop = n.poke_eventloop
|
||||
|
||||
local function lines()
|
||||
return api.nvim_buf_get_lines(0, 0, -1, true)
|
||||
end
|
||||
|
||||
local function edit(path)
|
||||
api.nvim_cmd({ cmd = 'edit', args = { path }, magic = { file = false, bar = false } }, {})
|
||||
end
|
||||
|
||||
local function cd(path)
|
||||
api.nvim_cmd({ cmd = 'cd', args = { path }, magic = { file = false, bar = false } }, {})
|
||||
end
|
||||
|
||||
local function line_of(text)
|
||||
for i, line in ipairs(lines()) do
|
||||
if line == text then
|
||||
return i
|
||||
end
|
||||
end
|
||||
error(('missing line %q in %s'):format(text, vim.inspect(lines())))
|
||||
end
|
||||
|
||||
local function bufopt(name)
|
||||
return api.nvim_get_option_value(name, { buf = 0 })
|
||||
end
|
||||
|
||||
local function assert_directory(path)
|
||||
eq(path, api.nvim_buf_get_name(0))
|
||||
eq(path, fn.bufname('%'))
|
||||
eq('directory', bufopt('filetype'))
|
||||
eq(true, bufopt('buflisted'))
|
||||
end
|
||||
|
||||
local function filesystem_root(path)
|
||||
local root = vim.fs.normalize(vim.fs.abspath(path))
|
||||
for parent in vim.fs.parents(root) do
|
||||
root = parent
|
||||
end
|
||||
return root
|
||||
end
|
||||
|
||||
---@param args? string[]
|
||||
---@return string[]
|
||||
local function with_buftype_optionset(args)
|
||||
return vim.list_extend({
|
||||
'--cmd',
|
||||
'let g:nvim_dir_events = []',
|
||||
'--cmd',
|
||||
[[autocmd OptionSet buftype call add(g:nvim_dir_events, v:option_new)]],
|
||||
}, args or {})
|
||||
end
|
||||
|
||||
local function expect_buftype_optionset(path)
|
||||
assert_directory(path)
|
||||
eq({ 'nowrite' }, exec_lua('return vim.g.nvim_dir_events'))
|
||||
end
|
||||
|
||||
describe('nvim.dir', function()
|
||||
local root
|
||||
local subdir
|
||||
local file
|
||||
|
||||
local function make_fixture()
|
||||
root = vim.fs.normalize(t.tmpname(false) .. ' space%#')
|
||||
subdir = root .. '/subdir'
|
||||
file = root .. '/alpha.txt'
|
||||
t.mkdir(root)
|
||||
t.mkdir(subdir)
|
||||
t.write_file(file, 'alpha', true)
|
||||
t.write_file(root .. '/.hidden', 'hidden', true)
|
||||
end
|
||||
|
||||
after_each(function()
|
||||
if root then
|
||||
n.rmdir(root)
|
||||
end
|
||||
root = nil
|
||||
end)
|
||||
|
||||
it('opens a startup directory argument', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' }, args = { root } })
|
||||
|
||||
assert_directory(root)
|
||||
eq(false, vim.tbl_contains(lines(), '../'))
|
||||
eq('subdir/', lines()[1])
|
||||
line_of('.hidden')
|
||||
line_of('alpha.txt')
|
||||
end)
|
||||
|
||||
it('triggers nested autocmds when opening directory buffers', function()
|
||||
make_fixture()
|
||||
|
||||
n.clear({
|
||||
args_rm = { '-u' },
|
||||
args = with_buftype_optionset({ root }),
|
||||
})
|
||||
expect_buftype_optionset(root)
|
||||
|
||||
n.clear({
|
||||
args_rm = { '-u' },
|
||||
args = with_buftype_optionset(),
|
||||
})
|
||||
edit(root)
|
||||
expect_buftype_optionset(root)
|
||||
end)
|
||||
|
||||
it('handles nested autocmds deleting the directory buffer', function()
|
||||
make_fixture()
|
||||
n.clear({
|
||||
args_rm = { '-u' },
|
||||
args = {
|
||||
'--cmd',
|
||||
'let g:nvim_dir_wiped = 0',
|
||||
'--cmd',
|
||||
[[autocmd OptionSet buftype let g:nvim_dir_wiped = 1 | bwipeout!]],
|
||||
root,
|
||||
},
|
||||
})
|
||||
|
||||
eq(1, exec_lua('return vim.g.nvim_dir_wiped'))
|
||||
eq('', exec_capture('messages'))
|
||||
end)
|
||||
|
||||
it('does not load the module until opening a directory', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
eq(false, exec_lua([[return package.loaded['nvim.dir'] ~= nil]]))
|
||||
edit(root)
|
||||
eq(true, exec_lua([[return package.loaded['nvim.dir'] ~= nil]]))
|
||||
assert_directory(root)
|
||||
end)
|
||||
|
||||
it('uses an absolute buffer name for a relative startup directory argument', function()
|
||||
if t.is_zig_build() then
|
||||
return pending('broken with build.zig relative runtime paths after chdir')
|
||||
end
|
||||
make_fixture()
|
||||
local cwd = assert(vim.uv.cwd())
|
||||
assert(vim.uv.chdir(root))
|
||||
n.clear({ args_rm = { '-u' }, args = { '.' } })
|
||||
assert(vim.uv.chdir(cwd))
|
||||
|
||||
assert_directory(root)
|
||||
end)
|
||||
|
||||
it('normalizes edited directory names', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
edit(root .. '///')
|
||||
|
||||
assert_directory(root)
|
||||
end)
|
||||
|
||||
it('does not show a parent entry at the filesystem root', function()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
local root_dir = filesystem_root(fn.getcwd())
|
||||
|
||||
edit(root_dir)
|
||||
|
||||
assert_directory(root_dir)
|
||||
eq(false, vim.tbl_contains(lines(), '../'))
|
||||
end)
|
||||
|
||||
it('navigates entries and refreshes the listing', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
edit(root)
|
||||
assert_directory(root)
|
||||
|
||||
api.nvim_win_set_cursor(0, { line_of('alpha.txt'), 0 })
|
||||
feed('<CR>')
|
||||
poke_eventloop()
|
||||
eq(file, api.nvim_buf_get_name(0))
|
||||
eq({ 'alpha' }, lines())
|
||||
|
||||
edit(subdir)
|
||||
assert_directory(subdir)
|
||||
eq({ '' }, lines())
|
||||
|
||||
feed('-')
|
||||
poke_eventloop()
|
||||
assert_directory(root)
|
||||
|
||||
t.write_file(root .. '/beta.txt', 'beta', true)
|
||||
feed('R')
|
||||
poke_eventloop()
|
||||
line_of('beta.txt')
|
||||
end)
|
||||
|
||||
it('reports an error and keeps the buffer when reloading a removed directory', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
edit(subdir)
|
||||
assert_directory(subdir)
|
||||
|
||||
n.rmdir(subdir)
|
||||
feed('R')
|
||||
poke_eventloop()
|
||||
|
||||
ok(exec_capture('messages'):find('ENOENT', 1, true) ~= nil)
|
||||
assert_directory(subdir)
|
||||
end)
|
||||
|
||||
it('refreshes a directory when navigated into again', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
edit(root)
|
||||
api.nvim_win_set_cursor(0, { line_of('subdir/'), 0 })
|
||||
feed('<CR>')
|
||||
poke_eventloop()
|
||||
assert_directory(subdir)
|
||||
eq({ '' }, lines())
|
||||
|
||||
t.write_file(subdir .. '/new.txt', 'new', true)
|
||||
feed('-')
|
||||
poke_eventloop()
|
||||
assert_directory(root)
|
||||
|
||||
api.nvim_win_set_cursor(0, { line_of('subdir/'), 0 })
|
||||
feed('<CR>')
|
||||
poke_eventloop()
|
||||
assert_directory(subdir)
|
||||
line_of('new.txt')
|
||||
end)
|
||||
|
||||
it('encodes special filename characters in directory buffers', function()
|
||||
-- Windows reserves backslash as a separator and disallows control characters in filenames.
|
||||
-- https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file
|
||||
t.skip(t.is_os('win'), 'N/A: Windows filenames cannot contain these characters')
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
local name = 'line\nbreak.txt'
|
||||
local raw_names = {
|
||||
'back\\slash.txt',
|
||||
'tab\tname.txt',
|
||||
'carriage\rreturn.txt',
|
||||
'ctrl\1name.txt',
|
||||
'del\127name.txt',
|
||||
}
|
||||
for _, raw_name in ipairs(raw_names) do
|
||||
t.write_file(root .. '/' .. raw_name, 'raw', true)
|
||||
end
|
||||
t.write_file(root .. '/' .. name, 'newline', true)
|
||||
|
||||
edit(root)
|
||||
for _, raw_name in ipairs(raw_names) do
|
||||
line_of(raw_name)
|
||||
end
|
||||
api.nvim_win_set_cursor(0, { line_of('line\0break.txt'), 0 })
|
||||
feed('<CR>')
|
||||
poke_eventloop()
|
||||
|
||||
eq(root .. '/' .. name, api.nvim_buf_get_name(0))
|
||||
eq({ 'newline' }, lines())
|
||||
end)
|
||||
|
||||
it('leaves existing special buffers alone', function()
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
|
||||
api.nvim_set_option_value('buftype', 'nofile', { buf = 0 })
|
||||
api.nvim_buf_set_name(0, root)
|
||||
command('doautocmd BufEnter')
|
||||
|
||||
eq('nofile', api.nvim_get_option_value('buftype', { buf = 0 }))
|
||||
eq('', api.nvim_get_option_value('filetype', { buf = 0 }))
|
||||
end)
|
||||
|
||||
it('coexists with netrw and can be disabled', function()
|
||||
if t.is_zig_build() then
|
||||
return pending('broken with build.zig relative runtime paths after chdir')
|
||||
end
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
local cwd = fn.getcwd()
|
||||
|
||||
ok(fn.exists(':Explore') > 0)
|
||||
edit(root)
|
||||
eq('directory', api.nvim_get_option_value('filetype', { buf = 0 }))
|
||||
|
||||
cd(root)
|
||||
command('Explore .')
|
||||
cd(cwd)
|
||||
eq('netrw', api.nvim_get_option_value('filetype', { buf = 0 }))
|
||||
|
||||
n.clear({
|
||||
args_rm = { '-u' },
|
||||
args = { '--cmd', 'let g:loaded_nvim_dir_plugin = 1' },
|
||||
})
|
||||
edit(root)
|
||||
eq('netrw', api.nvim_get_option_value('filetype', { buf = 0 }))
|
||||
end)
|
||||
|
||||
it('supports the FileExplorer browse contract', function()
|
||||
if t.is_zig_build() then
|
||||
return pending('broken with build.zig relative runtime paths after chdir')
|
||||
end
|
||||
make_fixture()
|
||||
n.clear({ args_rm = { '-u' } })
|
||||
local cwd = fn.getcwd()
|
||||
|
||||
cd(root)
|
||||
command('browse edit .')
|
||||
cd(cwd)
|
||||
|
||||
assert_directory(root)
|
||||
line_of('alpha.txt')
|
||||
end)
|
||||
end)
|
||||
Reference in New Issue
Block a user