snacks.nvim/lua/snacks/picker/sort.lua
Folke Lemaitre 559d6c6bf2
feat(snacks): added snacks.picker (#445)
## 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. -->
2025-01-14 22:53:59 +01:00

45 lines
1.1 KiB
Lua

---@class snacks.picker.sorters
local M = {}
---@alias snacks.picker.sort.Field { name: string, desc: boolean }
---@class snacks.picker.sort.Config
---@field fields? (snacks.picker.sort.Field|string)[]
---@param opts? snacks.picker.sort.Config
function M.default(opts)
local fields = {} ---@type snacks.picker.sort.Field[]
for _, f in ipairs(opts and opts.fields or { { name = "score", desc = true }, "idx" }) do
if type(f) == "string" then
table.insert(fields, { name = f, desc = false })
else
table.insert(fields, f)
end
end
---@param a snacks.picker.Item
---@param b snacks.picker.Item
return function(a, b)
for _, field in ipairs(fields) do
local av, bv = a[field.name], b[field.name]
if (av ~= nil) and (bv ~= nil) and (av ~= bv) then
if field.desc then
return av > bv
else
return av < bv
end
end
end
return false
end
end
function M.idx()
---@param a snacks.picker.Item
---@param b snacks.picker.Item
return function(a, b)
return a.idx < b.idx
end
end
return M