Health (健康檢查)

Nvim 的 :help 頁面，由產生，來源為原始碼，使用 tree-sitter-vimdoc 解析器。

Checkhealth health

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' 上建立一個 "health.lua" 模組，該模組會回傳一個包含 "check()" 函式的表格。然後，: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[]) 選項建議