mirrors/snacks.nvim
1
0
Fork 0
mirror of https://github.com/folke/snacks.nvim synced 2025-08-04 18:58:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

chore(build): auto-generate docs

Browse source
This commit is contained in:
folke 2025-02-01 12:47:53 +00:00 • committed by github-actions[bot]
parent d2459258f1
commit 50834bbf43
1 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/health.md
View file

@ -2,6 +2,19 @@
<!-- docgen -->
## 📚 Types
```lua
---@class snacks.health.Tool
---@field cmd string|string[]
---@field version? string
---@field enabled? boolean
```
```lua
---@alias snacks.health.Tool.spec (string|snacks.health.Tool)[]|snacks.health.Tool|string
```
## 📦 Module
```lua
@ -19,3 +32,21 @@ Snacks.health = {}
```lua
Snacks.health.check()
```
### `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()`
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)
```