feat(dir): user can sort/filter listings, DirReadPost event #41138

Problem:
Directory listing entries cannot be customized (filtered, reordered).
Listings are read by a BufReadCmd, which suppresses BufReadPost, so they
are the only buffers with no post-read event to hook.

Solution:
Introduce a post-render User autocmd `DirReadPost`, marking the dir
buffer writable for the duration and before the cursor is placed, so
handlers can sort or filter it with ordinary commands. Document common
recipes
This commit is contained in:
Barrett Ruth
2026-08-14 11:25:31 -05:00
committed by GitHub
parent 64a301184e
commit 0af3b9827b
4 changed files with 143 additions and 2 deletions

View File

@@ -332,6 +332,83 @@ describe('nvim.dir', function()
eq({ 'file2.txt' }, lines())
end)
it('fires DirReadPost for every listing', function()
make_fixture()
n.clear({ args = { '--clean' } })
exec_lua(function()
vim.g.renders = 0
vim.api.nvim_create_autocmd('User', {
pattern = 'DirReadPost',
callback = function(args)
vim.g.renders = vim.g.renders + 1
vim.g.render_lines = vim.api.nvim_buf_get_lines(args.buf, 0, -1, true)
vim.g.render_writable = vim.bo[args.buf].modifiable and not vim.bo[args.buf].readonly
end,
})
end)
edit(root)
eq(1, exec_lua('return vim.g.renders'))
eq({ 'subdir/', '.hidden', 'alpha.txt' }, exec_lua('return vim.g.render_lines'))
-- Writable while handlers run, locked again afterwards.
eq(true, exec_lua('return vim.g.render_writable'))
eq(false, bufopt('modifiable'))
eq(true, bufopt('readonly'))
eq(false, bufopt('modified'))
feed('R')
poke_eventloop()
eq(2, exec_lua('return vim.g.renders'))
edit(root)
eq(3, exec_lua('return vim.g.renders'))
api.nvim_win_set_cursor(0, { line_of('subdir/'), 0 })
feed('<CR>')
poke_eventloop()
assert_directory(subdir)
eq(4, exec_lua('return vim.g.renders'))
end)
it('keeps the listing readonly when a handler errors', function()
make_fixture()
n.clear({ args = { '--clean' } })
exec_lua(function()
vim.api.nvim_create_autocmd('User', {
pattern = 'DirReadPost',
callback = function()
error('handler error')
end,
})
end)
edit(root)
eq({ 'subdir/', '.hidden', 'alpha.txt' }, lines())
eq(false, bufopt('modifiable'))
eq(true, bufopt('readonly'))
end)
it('selects the origin entry after a handler reorders', function()
make_fixture()
n.clear({ args = { '--clean' } })
exec_lua(function()
vim.api.nvim_create_autocmd('User', {
pattern = 'DirReadPost',
callback = function()
vim.cmd('silent keeppatterns sort!')
end,
})
end)
edit(subdir)
feed('-')
poke_eventloop()
eq({ 'subdir/', 'alpha.txt', '.hidden' }, lines())
eq('subdir/', api.nvim_get_current_line())
end)
it('ignores callbacks from replaced listings', function()
n.clear({ args = { '--clean' } })