feat(fs): add vim.fs module #18583
Merged
feat(fs): add vim.fs module #18583
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lewis6991
reviewed
May 15, 2022
gpanders
changed the title
gpanders
force-pushed
the
path-root
branch
2 times, most recently
from
893377a
to
9cf27ea
Compare
clason
reviewed
May 16, 2022
|
related: #16800 |
gpanders
force-pushed
the
path-root
branch
4 times, most recently
from
c3cdd94
to
31e54d8
Compare
gpanders
force-pushed
the
path-root
branch
2 times, most recently
from
05ffd2b
to
e1a0f7e
Compare
if we start with plain strings, that should keep the door open on a |
justinmk
reviewed
May 17, 2022
muniter
reviewed
May 17, 2022
There was a problem hiding this comment.
I really like this functions. Have a few comments/questions, hope is not too spammy :)
I also see no mention of supporting ~ for user home dir, which is fine but perhaps it's worth mentioning.
What about windows paths is the separator normalized (I imagine not), maybe the examples should have a disclaimer.
runtime/doc/lua.txt
Outdated
|
|
||
| Return: ~ | ||
| Iterator over files and directories in {path}. Each | ||
| iteration yields two values: name and type. |
There was a problem hiding this comment.
Which are the types dir, directory, file ?
There was a problem hiding this comment.
"file" and "directory", I added this to the docs
| {file} (string) File or directory | ||
|
|
||
| Return: ~ | ||
| (string) Parent directory of {file} |
There was a problem hiding this comment.
Either, it depends on what it is passed. vim.fs.dirname("foo/bar") returns "foo", vim.fs.dirname("/foo/bar") returns "/foo".
| (string) Basename of {file} | ||
|
|
||
| dir({path}) *vim.path.dir()* | ||
| Return an iterator over the files and directories located in |
There was a problem hiding this comment.
The iterator provides the file or directory basename or full path?
There was a problem hiding this comment.
Each file/directory name returned from the iterator is relative to the provided {path} argument. I added a note about this to the docs.
I've added For now this just uses |
|
This is currently blocked by a memory leak in ASAN outputWe are using |
gpanders
force-pushed
the
path-root
branch
2 times, most recently
from
8926661
to
8db917b
Compare
|
More detailed backtrace: I can replicate this locally but only when running |
|
I was finally able to reproduce this fully and I think I've identified the root cause. I've opened an issue with luv. |
clason
added
the
status:blocked-external
clason
removed
the
status:blocked-external
|
Memory leak is gone, but |
kylo252
reviewed
May 31, 2022
runtime/lua/vim/fs.lua
Outdated
Comment on lines
200
to
203
| function M.normalize(path) | ||
| vim.validate({ path = { path, 's' } }) | ||
| return (path:gsub('\\', '/'):gsub('^~/', vim.env.HOME .. '/'):gsub('%$([%w_]+)', vim.env)) | ||
| end |
There was a problem hiding this comment.
I don't think this will work on Windows, unless you use PowerShell, or at least not reliably.
The environment variable expansion will give backslashes that you'd also need to sanitize before concatenating
$HOME
C:\Users\USERNAMEvim.fs.parents() is a Lua iterator that returns the next parent directory of the given file or directory on each iteration.
This function is modeled after the path.dir() function from Penlight and the luafilesystem module.
This is a pure Lua implementation of the Vim findfile() and finddir() functions without the special syntax.
gpanders
force-pushed
the
path-root
branch
2 times, most recently
from
11d6a05
to
99b3985
Compare
|
@gpanders: you seemed to have forgotten to address comments made by me and @mfussenegger about documenting that some functions implemented here cannot be run in Fortunately, since #18306 has been merged, we should be able to mark |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a minimal
vim.fsmodule. For now, only these six functions are included:vim.fs.parents: an iterator that iterates over all of the parent/ancestor directories of the given file or directoryUsage example:
vim.fs.dirname: Return the directory name of the given file or directoryUsage example:
vim.fs.basename: Return the base name of the given file or directoryUsage example:
vim.fs.dir: Iterator over all files and directories within a given directory. Adapted from Penlight'spath.dir()(which is itself adapted fromluafilesystem.dir()).Usage example:
vim.fs.find: Find files or directories upwards or downwards from a given pathUsage example 1:
Usage example 2:
vim.fs.normalize: Normalize a path to a standard format, expanding tildes and environment variablesUsage example: