mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-31 12:49:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: misc #41063

Browse Source
This commit is contained in:
Justin M. Keyes
2026-07-30 15:09:19 -04:00
committed by GitHub
parent a7f422fa48
commit 6cdab150bc
5 changed files with 54 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -191,8 +191,7 @@ end
--- (default: `false`)
--- @field follow? boolean
---
--- Normalize {path} via |vim.fs.normalize()|. Set `false` to use {path} literally, e.g. to list a
--- directory whose name contains `~` or `$`.
--- Expand "~" and "$" in {path} before scanning the directory.
--- (default: `true`)
--- @field normalize? boolean
@@ -678,10 +677,10 @@ end
--- (default: `true` in Windows, `false` otherwise)
--- @field win? boolean
--- Normalize a path to a standard format. A tilde (~) character at the beginning of the path is
--- expanded to the user's home directory and environment variables are also expanded. "." and ".."
--- components are also resolved, except when the path is relative and trying to resolve it would
--- result in an absolute path.
--- Normalize a path to a standard format. Expands environment variables, and tilde "~" at the
--- beginning of the path. Resolves "." and ".." components, except when the path is relative and
--- resolving it would produce an absolute path.
---
--- - "." as the only part in a relative path:
--- - "." => "."
--- - "././" => "."
@@ -691,20 +690,20 @@ end
--- - ".." in the root directory returns the root directory.
--- - "/../../" => "/"
---
--- On Windows, backslash (\) characters are converted to forward slashes (/).
--- On Windows, backslashes (`\`) are converted to forward slashes (`/`).
---
--- Examples:
--- ```
--- [[C:\Users\jdoe]] => "C:/Users/jdoe"
--- "~/src/neovim" => "/home/jdoe/src/neovim"
--- "$XDG_CONFIG_HOME/nvim/init.vim" => "/Users/jdoe/.config/nvim/init.vim"
--- "~/src/nvim/api/../tui/./tui.c" => "/home/jdoe/src/nvim/tui/tui.c"
--- "./foo/bar" => "foo/bar"
--- "foo/../../../bar" => "../../bar"
--- "/home/jdoe/../../../bar" => "/bar"
--- "C:foo/../../baz" => "C:../baz"
--- "C:/foo/../../baz" => "C:/baz"
--- [[\\?\UNC\server\share\foo\..\..\..\bar]] => "//?/UNC/server/share/bar"
--- ```lua
--- [[C:\Users\jdoe]] --> "C:/Users/jdoe"
--- "~/src/neovim" --> "/home/jdoe/src/neovim"
--- "$XDG_CONFIG_HOME/nvim/init.vim" --> "/Users/jdoe/.config/nvim/init.vim"
--- "~/src/nvim/api/../tui/./tui.c" --> "/home/jdoe/src/nvim/tui/tui.c"
--- "./foo/bar" --> "foo/bar"
--- "foo/../../../bar" --> "../../bar"
--- "/home/jdoe/../../../bar" --> "/bar"
--- "C:foo/../../baz" --> "C:../baz"
--- "C:/foo/../../baz" --> "C:/baz"
--- [[\\?\UNC\server\share\foo\..\..\..\bar]] --> "//?/UNC/server/share/bar"
--- ```
---
---@since 10