https://github.com/nvim-mini/mini.fuzzy
Neovim Lua plugin with fuzzy matching functionality. Part of 'mini.nvim' library.
https://github.com/nvim-mini/mini.fuzzy
lua mini-nvim neovim neovim-plugin
Last synced: 5 months ago
JSON representation
Neovim Lua plugin with fuzzy matching functionality. Part of 'mini.nvim' library.
- Host: GitHub
- URL: https://github.com/nvim-mini/mini.fuzzy
- Owner: nvim-mini
- License: mit
- Created: 2022-10-24T16:21:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-28T13:02:16.000Z (5 months ago)
- Last Synced: 2025-08-28T20:42:53.952Z (5 months ago)
- Topics: lua, mini-nvim, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 48.8 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Minimal and fast fuzzy matching
See more details in [Features](#features) and [help file](doc/mini-fuzzy.txt).
---
> [!NOTE]
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
⦿ This is a part of [mini.nvim](https://github.com/nvim-mini/mini.nvim) library. Please use [this link](https://github.com/nvim-mini/mini.nvim/blob/main/readmes/mini-fuzzy.md) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See the repository page to learn about common design principles and configuration recipes.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/nvim-mini/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://user-images.githubusercontent.com/24854248/173044594-3599fcec-02d6-4bb7-a47d-23f8400f6656.mp4
## Features
- Function to perform fuzzy matching of one string to others.
- Sorter for [nvim-telescope/telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
## Installation
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
There are two branches to install from:
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
Here are code snippets for some common installation methods (use only one):
With mini.deps
Github repo
Branch Code snippet
'mini.nvim' library Main Follow recommended 'mini.deps' installation
Stable
Standalone plugin Main add('nvim-mini/mini.fuzzy')
Stable add({ source = 'nvim-mini/mini.fuzzy', checkout = 'stable' })
With folke/lazy.nvim
Github repo
Branch Code snippet
'mini.nvim' library
Main { 'nvim-mini/mini.nvim', version = false },
Stable { 'nvim-mini/mini.nvim', version = '*' },
Standalone plugin
Main { 'nvim-mini/mini.fuzzy', version = false },
Stable { 'nvim-mini/mini.fuzzy', version = '*' },
With junegunn/vim-plug
Github repo
Branch Code snippet
'mini.nvim' library
Main Plug 'nvim-mini/mini.nvim'
Stable Plug 'nvim-mini/mini.nvim', { 'branch': 'stable' }
Standalone plugin Main Plug 'nvim-mini/mini.fuzzy'
Stable Plug 'nvim-mini/mini.fuzzy', { 'branch': 'stable' }
**Important**: no need to call `require('mini.fuzzy').setup()`, but it can be done to improve usability.
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
- Install plugin in other place with shorter path.
## Default config
```lua
-- No need to copy this inside `setup()`. Will be used automatically.
{
-- Maximum allowed value of match features (width and first match). All
-- feature values greater than cutoff can be considered "equally bad".
cutoff = 100,
}
```
## Similar plugins
- [nvim-telescope/telescope-fzy-native.nvim](https://github.com/nvim-telescope/telescope-fzy-native.nvim)