健康

Nvim :help 页面，从生成自源使用 tree-sitter-vimdoc 解析器。

健康检查健康

vim.health 是一个最小化的框架，帮助用户排查配置问题以及插件可能关心的任何其他环境状况。Nvim 附带针对配置、性能、Python 支持、Ruby 支持、剪贴板支持等的健康检查。

要运行所有健康检查，请使用

:checkhealth

鼓励插件作者编写新的健康检查。 health-dev

命令 health-commands

:che :checkhealth :che[ckhealth] 运行所有健康检查。 E5009
Nvim 依赖于 $VIMRUNTIME、'runtimepath' 和 'packpath' 来查找用于语法高亮、特定于文件类型的行为以及标准插件（包括：checkhealth）的标准“运行时文件”。如果找不到运行时文件，这些功能将无法正常工作。

:che[ckhealth] {plugins} 运行一个或多个插件的健康检查。例如，仅运行标准 Nvim 健康检查

:checkhealth vim.health

要运行“foo”和“bar”插件的健康检查（假设它们在 'runtimepath' 上，并且它们已实现 Lua require("foo.health").check() 接口）

:checkhealth foo bar

要运行 Lua 子模块的健康检查，请使用点符号或 "*" 来引用所有子模块。例如，Nvim 提供了 vim.lsp 和 vim.treesitter

:checkhealth vim.lsp vim.treesitter
:checkhealth vim*

创建健康检查 health-dev

健康检查是检查用户环境、配置或插件关心的任何其他先决条件的函数。Nvim 在以下位置提供健康检查

$VIMRUNTIME/autoload/health/

$VIMRUNTIME/lua/vim/lsp/health.lua

$VIMRUNTIME/lua/vim/treesitter/health.lua

等等...

要为自己的插件添加新的健康检查，只需在 'runtimepath' 上创建一个返回包含“check()”函数的表的“health.lua”模块。然后 :checkhealth 将自动找到并调用该函数。

例如，如果您的插件名为“foo”，请在以下位置之一（在 'runtimepath' 上）定义您的健康检查模块

lua/foo/health/init.lua

lua/foo/health.lua

如果您的插件还提供了一个名为“bar”的子模块，您希望为其进行单独的健康检查，请在以下位置之一定义健康检查

lua/foo/bar/health/init.lua

lua/foo/bar/health.lua

所有此类健康模块都必须返回包含 check() 函数的 Lua 表。

将此示例代码复制到 lua/foo/health.lua 中，将路径中的“foo”替换为您的插件名称

local M = {}
M.check = function()
  vim.health.start("foo report")
  -- make sure setup function parameters are ok
  if check_setup() then
    vim.health.ok("Setup is correct")
  else
    vim.health.error("Setup is incorrect")
  end
  -- do some more checking
  -- ...
end
return M

error({msg}, {...}) vim.health.error()
报告错误。

参数

{msg} (string)

{...} (string|string[]) 可选建议

info({msg}) vim.health.info()
报告信息消息。

参数

{msg} (string)

ok({msg}) vim.health.ok()
报告“成功”消息。

参数

{msg} (string)

start({name}) vim.health.start()
开始新的报告。大多数插件应该只调用一次，但如果您希望报告中出现不同的部分，请对每个部分调用一次。

参数

{name} (string)

warn({msg}, {...}) vim.health.warn()
报告警告。

参数

{msg} (string)

{...} (string|string[]) 可选建议

健康

健康检查 健康

健康检查健康