diff options
Diffstat (limited to 'runtime/doc/lua.txt')
| -rw-r--r-- | runtime/doc/lua.txt | 61 |
1 files changed, 30 insertions, 31 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 0b894897d1..d6d0f1a9f8 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -2729,16 +2729,16 @@ vim.keymap.set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()* Lua module: vim.fs *vim.fs* vim.fs.basename({file}) *vim.fs.basename()* - Return the basename of the given file or directory + Return the basename of the given path Parameters: ~ - • {file} (string) File or directory + • {file} (string) Path Return: ~ (string|nil) Basename of {file} vim.fs.dir({path}, {opts}) *vim.fs.dir()* - Return an iterator over the files and directories located in {path} + Return an iterator over the items located in {path} Parameters: ~ • {path} (string) An absolute or relative path to the directory to @@ -2751,30 +2751,32 @@ vim.fs.dir({path}, {opts}) *vim.fs.dir()* current directory. Only useful when depth > 1 Return: ~ - Iterator over files and directories in {path}. Each iteration yields - two values: name and type. Each "name" is the basename of the file or - directory relative to {path}. Type is one of "file" or "directory". + Iterator over items in {path}. Each iteration yields two values: + "name" and "type". "name" is the basename of the item relative to + {path}. "type" is one of the following: "file", "directory", "link", + "fifo", "socket", "char", "block", "unknown". vim.fs.dirname({file}) *vim.fs.dirname()* - Return the parent directory of the given file or directory + Return the parent directory of the given path Parameters: ~ - • {file} (string) File or directory + • {file} (string) Path Return: ~ (string|nil) Parent directory of {file} vim.fs.find({names}, {opts}) *vim.fs.find()* - Find files or directories in the given path. - - Finds any files or directories given in {names} starting from {path}. If - {upward} is "true" then the search traverses upward through parent - directories; otherwise, the search traverses downward. Note that downward - searches are recursive and may search through many directories! If {stop} - is non-nil, then the search stops when the directory given in {stop} is - reached. The search terminates when {limit} (default 1) matches are found. - The search can be narrowed to find only files or only directories by - specifying {type} to be "file" or "directory", respectively. + Find files or directories (or other items as specified by `opts.type`) in + the given path. + + Finds items given in {names} starting from {path}. If {upward} is "true" + then the search traverses upward through parent directories; otherwise, + the search traverses downward. Note that downward searches are recursive + and may search through many directories! If {stop} is non-nil, then the + search stops when the directory given in {stop} is reached. The search + terminates when {limit} (default 1) matches are found. You can set {type} + to "file", "directory", "link", "socket", "char", "block", or "fifo" to + narrow the search to find only that type. Examples: >lua @@ -2799,14 +2801,13 @@ vim.fs.find({names}, {opts}) *vim.fs.find()* Parameters: ~ • {names} (string|table|fun(name: string, path: string): boolean) Names - of the files and directories to find. Must be base names, - paths and globs are not supported when {names} is a string or - a table. If {names} is a function, it is called for each - traversed file and directory with args: + of the items to find. Must be base names, paths and globs are + not supported when {names} is a string or a table. If {names} + is a function, it is called for each traversed item with + args: • name: base name of the current item • path: full path of the current item The function should - return `true` if the given file or directory is considered - a match. + return `true` if the given item is considered a match. • {opts} (table) Optional keyword arguments: • path (string): Path to begin searching from. If omitted, the |current-directory| is used. @@ -2815,16 +2816,14 @@ vim.fs.find({names}, {opts}) *vim.fs.find()* directories (recursively). • stop (string): Stop searching when this directory is reached. The directory itself is not searched. - • type (string): Find only files ("file") or directories - ("directory"). If omitted, both files and directories that - match {names} are included. + • type (string): Find only items of the given type. If + omitted, all items that match {names} are included. • limit (number, default 1): Stop the search after finding this many matches. Use `math.huge` to place no limit on the number of matches. Return: ~ - (table) Normalized paths |vim.fs.normalize()| of all matching files or - directories + (table) Normalized paths |vim.fs.normalize()| of all matching items vim.fs.joinpath({...}) *vim.fs.joinpath()* Concatenate directories and/or file paths into a single path with @@ -2864,7 +2863,7 @@ vim.fs.normalize({path}, {opts}) *vim.fs.normalize()* (string) Normalized path vim.fs.parents({start}) *vim.fs.parents()* - Iterate over all the parents of the given file or directory. + Iterate over all the parents of the given path. Example: >lua @@ -2882,7 +2881,7 @@ vim.fs.parents({start}) *vim.fs.parents()* < Parameters: ~ - • {start} (string) Initial file or directory. + • {start} (string) Initial path. Return: ~ (function) Iterator |