vim.health

Methods7

function M.start(name: string) -> nil

Starts a new report. Most plugins should call this only once, but if you want different sections to appear in your report, call this once per section.

function M.info(msg: string) -> nil

Reports an informational message.

function M.ok(msg: string) -> nil

Reports a "success" message.

function M.warn(msg: string, ...: string | string[]) -> nil

Reports a warning.

Parameters

msgstring
...string | string[]: Optional advice

Returns

nil

function M.error(msg: string, ...: string | string[]) -> nil

Reports an error.

Parameters

msgstring
...string | string[]: Optional advice

Returns

nil

function M._complete() -> any[]

:checkhealth completion function used by cmdexpand.c gethealthchecknames()

function M._check(eap: vim._core.ExCmdArgs) -> nil

Runs the specified healthchecks, or all discovered healthchecks if eap.args is empty.

Specified healthchecks are given as plugin names, split on whitespace. For example using :checkhealth vim.* nvim will check vim.lsp, vim.treesitter and nvim modules.