fuzzy.nvim

An abstraction layer on top of fzf and fzy.

Installation

Depends on telescope-fzf-native.nvim or fzy-lua-native or telescope-zf-native.nvim.

Priority: fzf > fzy > zf

Using Packer with fzf:

use {'nvim-telescope/telescope-fzf-native.nvim', run = 'make'}
use {'tzachar/fuzzy.nvim', requires = {'nvim-telescope/telescope-fzf-native.nvim'}}

Using Packer with fzy:

use {'romgrk/fzy-lua-native', run = 'make'}
use {'tzachar/fuzzy.nvim', requires = {'romgrk/fzy-lua-native'}}

Using Packer with zf:

use {'tzachar/fuzzy.nvim', requires = {'natecraddock/telescope-zf-native.nvim'}}

Api

This plugin supports a module with a single method: filter. The filter method receives three parameters: a pattern to match, lines a list of strings or tables where the first element is a string and an extra parameter passed to the fuzzy library: for fzy, its a boolean indicating is_case_sensitive, for fzf its the case_mode (see this).

The method returns a list of {string|table, match_positions, score, index}. For the meanings of match_positions and score see individual documentations of fzf and fzy. index is the index of the matched line from the parameter lines.

Example Usage

local matcher = require('fuzzy_nvim')
matcher:filter('abc', {'aabbcc', '123', 'a1b2c'})

result with fzf is then: { { "a1b2c", { 5, 3, 1 }, 58, 3 }, { "aabbcc", { 5, 3, 1 }, 49, 1 } }

local matcher = require('fuzzy_nvim')
matcher:filter('abc', {
    { 'aabbcc', action1 },
    { '123', action2 },
    { 'a1b2c', action3 }
})

result with fzf is then:

{
    { { "a1b2c", action3 }, { 5, 3, 1 }, 58, 3 },
    { { "aabbcc", action1 }, { 5, 3, 1 }, 49, 1 }
}