https://github.com/mikavilpas/nucleo.nvim
Integration to the Helix editor's nucleo fuzzy finder algorithm for Neovim
https://github.com/mikavilpas/nucleo.nvim
Last synced: 3 months ago
JSON representation
Integration to the Helix editor's nucleo fuzzy finder algorithm for Neovim
- Host: GitHub
- URL: https://github.com/mikavilpas/nucleo.nvim
- Owner: mikavilpas
- License: mit
- Created: 2024-12-30T16:02:51.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-30T17:11:58.000Z (4 months ago)
- Last Synced: 2024-12-30T17:18:50.494Z (4 months ago)
- Language: TypeScript
- Size: 156 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚛️nucleo.nvim
> [!NOTE]
>
> This is currently experimental software. It works, but is in an early stage of
> development.
An integration to the [nucleo-matcher](https://github.com/helix-editor/nucleo)
algorithm for Neovim. It's the fuzzy matching algorithm used in the Helix editor
to find files.
## ✨ Features
This includes a lua-rust api to use the
[nucleo-matcher](https://crates.io/crates/nucleo-matcher) rust crate. Using
this, the following features are provided:
- A [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) sorter,
which allows using the nucleo algorithm with telescope.
- A lua api to use the nucleo algorithm directly.
## 📦 Installation
Right now, no binaries are published, so you need to build the rust side of the
plugin yourself.
Using [lazy.nvim](https://lazy.folke.io/):
```lua
---@module "lazy"
---@type LazySpec
return {
"mikavilpas/nucleo.nvim",
build = "cargo build --release",
config = true,
-- it sets itself as the default sorter for telescope's find_files (file
-- picker)
}
```
## 🤔 Alternatives
- [telescope-fzf-native.nvim](https://github.com/nvim-telescope/telescope-fzf-native.nvim)
allows using a C language port of the fzf algorithm with telescope
- [fzf-lua](https://github.com/ibhagwan/fzf-lua) is a mature fuzzy finder for
Neovim. It uses the [fzf](https://github.com/junegunn/fzf) command-line fuzzy
finder under the hood.