mirror of
https://github.com/folke/snacks.nvim
synced 2025-07-07 13:15:08 +00:00
69 lines
2.1 KiB
Text
69 lines
2.1 KiB
Text
*snacks-health* snacks_health
|
|
|
|
==============================================================================
|
|
Table of Contents *snacks-health-table-of-contents*
|
|
|
|
1. Types |snacks-health-types|
|
|
2. Module |snacks-health-module|
|
|
- Snacks.health.check() |snacks-health-module-snacks.health.check()|
|
|
- Snacks.health.has_lang() |snacks-health-module-snacks.health.has_lang()|
|
|
- Snacks.health.have_tool() |snacks-health-module-snacks.health.have_tool()|
|
|
|
|
==============================================================================
|
|
1. Types *snacks-health-types*
|
|
|
|
>lua
|
|
---@class snacks.health.Tool
|
|
---@field cmd string|string[]
|
|
---@field version? string|false
|
|
---@field enabled? boolean
|
|
<
|
|
|
|
>lua
|
|
---@alias snacks.health.Tool.spec (string|snacks.health.Tool)[]|snacks.health.Tool|string
|
|
<
|
|
|
|
|
|
==============================================================================
|
|
2. Module *snacks-health-module*
|
|
|
|
>lua
|
|
---@class snacks.health
|
|
---@field ok fun(msg: string)
|
|
---@field warn fun(msg: string)
|
|
---@field error fun(msg: string)
|
|
---@field info fun(msg: string)
|
|
---@field start fun(msg: string)
|
|
Snacks.health = {}
|
|
<
|
|
|
|
|
|
`Snacks.health.check()` *Snacks.health.check()*
|
|
|
|
>lua
|
|
Snacks.health.check()
|
|
<
|
|
|
|
|
|
`Snacks.health.has_lang()` *Snacks.health.has_lang()*
|
|
|
|
Check if the given languages are available in treesitter
|
|
|
|
>lua
|
|
---@param langs string[]|string
|
|
Snacks.health.has_lang(langs)
|
|
<
|
|
|
|
|
|
`Snacks.health.have_tool()` *Snacks.health.have_tool()*
|
|
|
|
Check if any of the tools are available, with an optional version check
|
|
|
|
>lua
|
|
---@param tools snacks.health.Tool.spec
|
|
Snacks.health.have_tool(tools)
|
|
<
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|