mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(vim.fs): default to follow=false #32859

Browse Source 
Problem:
Following symlinks can have surprising behavior and slow performance.

Solution:
Do not set it by default.
This commit is contained in:
Mike
2025-03-14 09:36:39 +01:00
committed by GitHub
parent 2db1ae37f1
commit 6401b433f7
3 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/lua.txt
View File

@@ -2985,7 +2985,7 @@ vim.fs.dir({path}, {opts}) *vim.fs.dir()*
• skip: (fun(dir_name: string): boolean)|nil Predicate to • skip: (fun(dir_name: string): boolean)|nil Predicate to
control traversal. Return false to stop searching the control traversal. Return false to stop searching the
current directory. Only useful when depth > 1 current directory. Only useful when depth > 1
• follow: boolean|nil Follow symbolic links. (default: true) • follow: boolean|nil Follow symbolic links. (default: false)
Return: ~ Return: ~
(`Iterator`) over items in {path}. Each iteration yields two values: (`Iterator`) over items in {path}. Each iteration yields two values:
@@ -3058,7 +3058,7 @@ 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.
• {follow}? (`boolean`, default: `true`) Follow symbolic • {follow}? (`boolean`, default: `false`) Follow symbolic
links. links.
Return: ~ Return: ~

4
runtime/doc/news.txt
View File

@@ -330,8 +330,8 @@ LUA
• |vim.json.encode()| has an option to enable forward slash escaping • |vim.json.encode()| has an option to enable forward slash escaping
• |vim.fs.abspath()| converts paths to absolute paths. • |vim.fs.abspath()| converts paths to absolute paths.
• |vim.fs.relpath()| gets relative path compared to base path. • |vim.fs.relpath()| gets relative path compared to base path.
• |vim.fs.dir()| and |vim.fs.find()| now follow symbolic links by default, • |vim.fs.dir()| and |vim.fs.find()| can now follow symbolic links,
the behavior can be turn off using the new `follow` option. the behavior can be turn on using the new `follow` option.
• |vim.text.indent()| indents/dedents text. • |vim.text.indent()| indents/dedents text.
OPTIONS OPTIONS

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

@@ -136,7 +136,7 @@ end
--- - skip: (fun(dir_name: string): boolean)|nil Predicate --- - skip: (fun(dir_name: string): boolean)|nil Predicate
--- to control traversal. Return false to stop searching the current directory. --- to control traversal. Return false to stop searching the current directory.
--- Only useful when depth > 1 --- Only useful when depth > 1
--- - follow: boolean|nil Follow symbolic links. (default: true) --- - follow: boolean|nil Follow symbolic links. (default: false)
--- ---
---@return Iterator over items in {path}. Each iteration yields two values: "name" and "type". ---@return Iterator over items in {path}. Each iteration yields two values: "name" and "type".
--- "name" is the basename of the item relative to {path}. --- "name" is the basename of the item relative to {path}.
@@ -179,7 +179,7 @@ function M.dir(path, opts)
if if
opts.depth opts.depth
and level < opts.depth and level < opts.depth
and (t == 'directory' or (t == 'link' and opts.follow ~= false and (vim.uv.fs_stat( and (t == 'directory' or (t == 'link' and opts.follow and (vim.uv.fs_stat(
M.joinpath(path, f) M.joinpath(path, f)
) or {}).type == 'directory')) ) or {}).type == 'directory'))
and (not opts.skip or opts.skip(f) ~= false) and (not opts.skip or opts.skip(f) ~= false)
@@ -217,7 +217,7 @@ end
--- @field limit? number --- @field limit? number
--- ---
--- Follow symbolic links. --- Follow symbolic links.
--- (default: `true`) --- (default: `false`)
--- @field follow? boolean --- @field follow? 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.
@@ -357,11 +357,7 @@ function M.find(names, opts)
if if
type_ == 'directory' type_ == 'directory'
or ( or (type_ == 'link' and opts.follow and (vim.uv.fs_stat(f) or {}).type == 'directory')
type_ == 'link'
and opts.follow ~= false
and (vim.uv.fs_stat(f) or {}).type == 'directory'
)
then then
dirs[#dirs + 1] = f dirs[#dirs + 1] = f
end end