kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 12:45:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge d952c976ba into 3db3947b0e

Browse Source
This commit is contained in:
Mike 2024-12-18 18:53:06 +01:00 committed by GitHub
commit 1e3b657924
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
runtime/doc/lua.txt
View File

@ -3042,6 +3042,9 @@ vim.fs.find({names}, {opts}) *vim.fs.find()*
• {limit}? (`number`, default: `1`) Stop the search after • {limit}? (`number`, default: `1`) Stop the search after
finding this many matches. Use `math.huge` to place no finding this many matches. Use `math.huge` to place no
limit on the number of matches. limit on the number of matches.
• {skip}? (`fun(dir: string): boolean`) Do not traverse
matching directories. If omitted, all directories are
searched recursively.
Return: ~ Return: ~
(`string[]`) Normalized paths |vim.fs.normalize()| of all matching (`string[]`) Normalized paths |vim.fs.normalize()| of all matching

7
runtime/lua/vim/fs.lua
View File

@ -202,6 +202,10 @@ end
--- Use `math.huge` to place no limit on the number of matches. --- Use `math.huge` to place no limit on the number of matches.
--- (default: `1`) --- (default: `1`)
--- @field limit? number --- @field limit? number
---
--- Do not traverse matching directories.
--- If omitted, all directories are searched recursively.
--- @field skip? (fun(dir: string): boolean)
--- Find files or directories (or other items as specified by `opts.type`) in the given path. --- Find files or directories (or other items as specified by `opts.type`) in the given path.
--- ---
@ -247,6 +251,7 @@ function M.find(names, opts)
vim.validate('stop', opts.stop, 'string', true) vim.validate('stop', opts.stop, 'string', true)
vim.validate('type', opts.type, 'string', true) vim.validate('type', opts.type, 'string', true)
vim.validate('limit', opts.limit, 'number', true) vim.validate('limit', opts.limit, 'number', true)
vim.validate('skip', opts.skip, 'function', true)
if type(names) == 'string' then if type(names) == 'string' then
names = { names } names = { names }
@ -336,7 +341,7 @@ function M.find(names, opts)
end end
end end
if type_ == 'directory' then if (type_ == 'directory') and (not opts.skip or opts.skip(f) ~= false) then
dirs[#dirs + 1] = f dirs[#dirs + 1] = f
end end
end end

11
test/functional/lua/fs_spec.lua
View File

@ -224,6 +224,17 @@ describe('vim.fs', function()
) )
eq({ nvim_prog }, vim.fs.find(nvim_prog_basename, { path = test_build_dir, type = 'file' })) eq({ nvim_prog }, vim.fs.find(nvim_prog_basename, { path = test_build_dir, type = 'file' }))
eq(
{},
vim.fs.find(nvim_prog_basename, {
path = vim.fs.dirname(test_build_dir),
type = 'file',
skip = function(dir)
return not (vim.fs.basename(dir):match('^build'))
end,
})
)
local parent, name = nvim_dir:match('^(.*/)([^/]+)$') local parent, name = nvim_dir:match('^(.*/)([^/]+)$')
eq({ nvim_dir }, vim.fs.find(name, { path = parent, upward = true, type = 'directory' })) eq({ nvim_dir }, vim.fs.find(name, { path = parent, upward = true, type = 'directory' }))
end) end)