Mini Fuzzy - Mini Nvim

Minimal and fast fuzzy matching

See more details in Features and Documentation.

[!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.

⦿ This is a part of mini.nvim library. Please use this link if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See whole library documentation to learn about general design principles, disable/configuration recipes, and more.

If you want to help this project grow but don't know where to start, check out contributing guides of 'mini.nvim' 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.

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):

<details> <summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

lua

vim.pack.add({ 'https://github.com/nvim-mini/mini.fuzzy' })

Stable branch:

lua

vim.pack.add({
  { src = 'https://github.com/nvim-mini/mini.fuzzy', version = 'stable' },
})

</details> <details> <summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>

Full library

Standalone plugin:

Main branch:

lua

add('nvim-mini/mini.fuzzy')

Stable branch:

lua

add({ source = 'nvim-mini/mini.fuzzy', checkout = 'stable' })

</details> <details> <summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>

Full library

Follow 'mini.nvim' installation.

Standalone plugin

Main branch:

lua

{ 'nvim-mini/mini.fuzzy', version = false },

Stable branch:

lua

{ 'nvim-mini/mini.fuzzy', version = '*' },

</details>

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 <some file name>: 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