mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-05-04 04:55:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge #37096 from justinmk/doc2

Browse Source
This commit is contained in:
Justin M. Keyes
2026-02-12 08:15:21 -05:00
committed by GitHub
parent d0822bbd15 d995142dbd
commit e8ace82093
23 changed files with 187 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -94,7 +94,7 @@ function M.dirname(file)
return dir
end
--- Return the basename of the given path
--- Gets the basename of the given path (not expanded/resolved).
---
---@since 10
---@generic T : string|nil
@@ -116,7 +116,7 @@ end
--- Concatenates partial paths (one absolute or relative path followed by zero or more relative
--- paths). Slashes are normalized: redundant slashes are removed, and (on Windows) backslashes are
--- replaced with forward-slashes.
--- replaced with forward-slashes. Paths are not expanded/resolved.
---
--- Examples:
--- - "foo/", "/bar" => "foo/bar"
@@ -136,7 +136,7 @@ end
--- @class vim.fs.dir.Opts
--- @inlinedoc
---
--- How deep the traverse.
--- How deep to traverse.
--- (default: `1`)
--- @field depth? integer
---
@@ -152,11 +152,10 @@ end
---@alias Iterator fun(): string?, string?
--- Return an iterator over the items located in {path}
--- Gets an iterator over items found in `path` (normalized via |vim.fs.normalize()|).
---
---@since 10
---@param path (string) An absolute or relative path to the directory to iterate
--- over. The path is first normalized |vim.fs.normalize()|.
---@param path (string) Directory to iterate over, normalized via |vim.fs.normalize()|.
---@param opts? vim.fs.dir.Opts Optional keyword arguments:
---@return Iterator over items in {path}. Each iteration yields two values: "name" and "type".
--- "name" is the basename of the item relative to {path}.
@@ -214,25 +213,20 @@ end
--- @class vim.fs.find.Opts
--- @inlinedoc
---
--- Path to begin searching from. If
--- omitted, the |current-directory| is used.
--- Path to begin searching from, defaults to |current-directory|. Not expanded.
--- @field path? string
---
--- Search upward through parent directories.
--- Otherwise, search through child directories (recursively).
--- Search upward through parent directories. Otherwise, search child directories (recursively).
--- (default: `false`)
--- @field upward? boolean
---
--- Stop searching when this directory is reached.
--- The directory itself is not searched.
--- Stop searching when this directory is reached. The directory itself is not searched.
--- @field stop? string
---
--- Find only items of the given type.
--- If omitted, all items that match {names} are included.
--- Find only items of the given type. If omitted, all items that match {names} are included.
--- @field type? string
---
--- Stop the search after finding this many matches.
--- Use `math.huge` to place no limit on the number of matches.
--- Stop searching after this many matches. Use `math.huge` for "unlimited".
--- (default: `1`)
--- @field limit? number
---
@@ -416,7 +410,7 @@ end
---
--- @since 12
--- @param source integer|string Buffer number (0 for current buffer) or file path (absolute or
--- relative to the |current-directory|) to begin the search from.
--- relative, expanded via `abspath()`) to begin the search from.
--- @param marker (string|string[]|fun(name: string, path: string): boolean)[]|string|fun(name: string, path: string): boolean
--- Filename, function, or list thereof, that decides how to find the root. To
--- indicate "equal priority", specify items in a nested list `{ { 'a.txt', 'b.lua' }, … }`.
@@ -727,16 +721,22 @@ end
--- @class vim.fs.rm.Opts
--- @inlinedoc
---
--- Remove directories and their contents recursively
--- Remove directory contents recursively.
--- @field recursive? boolean
---
--- Ignore nonexistent files and arguments
--- Ignore nonexistent files and arguments.
--- @field force? boolean
--- Remove files or directories
--- Removes a file or directory.
---
--- Removes symlinks without touching the origin. To remove the origin, resolve it explicitly
--- with |uv.fs_realpath()|:
--- ```lua
--- vim.fs.rm(vim.uv.fs_realpath('symlink-dir'), { recursive = true })
--- ```
---
--- @since 13
--- @param path string Path to remove. Removes symlinks without touching the origin.
---To remove the origin, resolve explicitly with |uv.fs_realpath()|.
--- @param path string Path to remove (not expanded/resolved).
--- @param opts? vim.fs.rm.Opts
function M.rm(path, opts)
opts = opts or {}
@@ -749,11 +749,12 @@ function M.rm(path, opts)
end
end
--- Convert path to an absolute path. A tilde (~) character at the beginning of the path is expanded
--- Converts `path` to an absolute path. Expands tilde (~) at the beginning of the path
--- to the user's home directory. Does not check if the path exists, normalize the path, resolve
--- symlinks or hardlinks (including `.` and `..`), or expand environment variables. If the path is
--- already absolute, it is returned unchanged. Also converts `\` path separators to `/`.
---
--- @since 13
--- @param path string Path
--- @return string Absolute path
function M.abspath(path)
@@ -801,6 +802,7 @@ end
--- vim.fs.relpath('/var', '/usr/bin') -- nil
--- ```
---
--- @since 13
--- @param base string
--- @param target string
--- @param opts table? Reserved for future use

27
runtime/lua/vim/health/health.lua
View File

@@ -543,19 +543,13 @@ local function check_stable_version(nvim_version)
if result.code ~= 0 or not result.stdout or result.stdout == '' then
return
end
local stable_sha = result.stdout:match('(%x+)%s+refs/tags/stable%^{}')
or result.stdout:match('(%x+)%s+refs/tags/stable\n')
if not stable_sha then
return
end
local latest_version = result.stdout:match(stable_sha .. '%s+refs/tags/v?(%d+%.%d+%.%d+)%^{}')
if not latest_version then
return
end
local current_version = nvim_version:match('v?(%d+%.%d+%.%d+)')
if not current_version then
return
end
local stable_sha = assert(
result.stdout:match('(%x+)%s+refs/tags/stable%^{}')
or result.stdout:match('(%x+)%s+refs/tags/stable\n')
)
local latest_version =
assert(result.stdout:match(stable_sha .. '%s+refs/tags/v?(%d+%.%d+%.%d+)%^{}'))
local current_version = assert(nvim_version:match('v?(%d+%.%d+%.%d+)'))
local current = vim.version.parse(current_version)
local latest = vim.version.parse(latest_version)
if current and latest and vim.version.lt(current, latest) then
@@ -576,10 +570,7 @@ local function check_head_hash(commit)
if result.code ~= 0 or not result.stdout or result.stdout == '' then
return
end
local upstream = result.stdout:match('^(%x+)')
if not upstream then
return
end
local upstream = assert(result.stdout:match('^(%x+)'))
if not vim.startswith(upstream, commit) then
vim.health.warn(
('Build is outdated. Local: %s, Latest: %s'):format(commit, upstream:sub(1, 12))
@@ -621,6 +612,8 @@ local function check_sysinfo()
[[
## Problem
Describe the problem (concisely).
## Steps to reproduce
```

2
runtime/lua/vim/lsp.lua
View File

@@ -198,7 +198,7 @@ end
--- provide the root dir, or LSP will not be activated for the buffer. Thus a `root_dir()` function
--- can dynamically decide per-buffer whether to activate (or skip) LSP.
--- See example at |vim.lsp.enable()|.
--- @field root_dir? string|fun(bufnr: integer, on_dir:fun(root_dir?:string))
--- @field root_dir? string|fun(bufnr: integer, on_dir:fun(root_dir?:string)) #
---
--- [lsp-root_markers]()
--- Filename(s) (".git/", "package.json", …) used to decide the workspace root. Unused if `root_dir`