ヘルス

Nvim の:help ページ。生成されたソースはこちらで、tree-sitter-vimdoc パーサーを使用しています。

Checkhealth health

vim.health は、ユーザーが設定やプラグインが関係する可能性のあるその他の環境条件のトラブルシューティングを支援するための最小限のフレームワークです。Nvim には、設定、パフォーマンス、Python サポート、Ruby サポート、クリップボードサポートなどに関するヘルスチェックが付属しています。

すべてのヘルスチェックを実行するには、以下のコマンドを使用します。

:checkhealth

プラグイン作成者は、新しいヘルスチェックを作成することが推奨されます。 health-dev

コマンド health-commands

:che :checkhealth :che[ckhealth] すべてのヘルスチェックを実行します。 E5009
Nvim は、構文の強調表示、ファイルタイプ固有の動作、標準プラグイン（:checkhealth を含む）のための標準的な「ランタイムファイル」を見つけるために、$VIMRUNTIME、'runtimepath'、および'packpath' に依存しています。ランタイムファイルが見つからない場合、これらの機能は動作しません。

:che[ckhealth] {plugins} 1つ以上のプラグインのヘルスチェックを実行します。例：標準の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[]) オプションのアドバイス