mirror of
https://github.com/folke/snacks.nvim
synced 2025-12-23 08:47:57 +00:00
559d6c6bf2
## Description More info coming tomorrow. In short: - very fast. pretty much realtime filtering/sorting in huge repos (like 1.7 million files) - extensible - easy to customize the layout (and lots of presets) with `snacks.layout` - simple to create custom pickers - `vim.ui.select` - lots of builtin pickers - uses treesitter highlighting wherever it makes sense - fast lua fuzzy matcher which supports the [fzf syntax](https://junegunn.github.io/fzf/search-syntax/) and additionally supports field filters, like `file:lua$ 'function` There's no snacks picker command, just use lua. ```lua -- all pickers Snacks.picker() -- run files picker Snacks.picker.files(opts) Snacks.picker.pick("files", opts) Snacks.picker.pick({source = "files", ...}) ``` <!-- Describe the big picture of your changes to communicate to the maintainers why we should accept this pull request. --> ## Todo - [x] issue with preview loc not always correct when scrolling fast in list (probably due to `snacks.scroll`) - [x] `grep` (`live_grep`) is sometimes too fast in large repos and can impact ui rendering. Not very noticeable, but something I want to look at. - [x] docs - [x] treesitter highlights are broken. Messed something up somewhere ## Related Issue(s) <!-- If this PR fixes any issues, please link to the issue here. - Fixes #<issue_number> --> ## Screenshots <!-- Add screenshots of the changes if applicable. -->
45 lines
705 B
Markdown
45 lines
705 B
Markdown
# 🍿 meta
|
|
|
|
Meta functions for Snacks
|
|
|
|
<!-- docgen -->
|
|
|
|
## 📚 Types
|
|
|
|
```lua
|
|
---@class snacks.meta.Meta
|
|
---@field desc string
|
|
---@field needs_setup? boolean
|
|
---@field hide? boolean
|
|
---@field readme? boolean
|
|
---@field docs? boolean
|
|
---@field health? boolean
|
|
---@field types? boolean
|
|
---@field config? boolean
|
|
---@field merge? { [string|number]: string }
|
|
```
|
|
|
|
```lua
|
|
---@class snacks.meta.Plugin
|
|
---@field name string
|
|
---@field file string
|
|
---@field meta snacks.meta.Meta
|
|
---@field health? fun()
|
|
```
|
|
|
|
## 📦 Module
|
|
|
|
### `Snacks.meta.file()`
|
|
|
|
```lua
|
|
Snacks.meta.file(name)
|
|
```
|
|
|
|
### `Snacks.meta.get()`
|
|
|
|
Get the metadata for all snacks plugins
|
|
|
|
```lua
|
|
---@return snacks.meta.Plugin[]
|
|
Snacks.meta.get()
|
|
```
|