Fuzzy

Blink uses a SIMD fuzzy matcher called frizbee which achieves ~6x the performance of fzf while ignoring typos. Check out the repo for more information!

Rust vs Lua implementation

Prebuilt binaries are included in the releases and automatically downloaded when on a release tag (see below). However, for unsupported systems or when the download fails, it will automatically fallback to a Lua implementation, emitting a warning. You may suppress this warning or enforce the Lua or Rust implementation.

• prefer_rust_with_warning If available, use the Rust implementation, automatically downloading prebuilt binaries on supported systems. Fallback to the Lua implementation when not available, emitting a warning message.
• prefer_rust: If available, use the Rust implementation, automatically downloading prebuilt binaries on supported systems. Fallback to the Lua implementation when not available.
• rust: Always use the Rust implementation, automatically downloading prebuilt binaries on supported systems. Error if not available.
• lua: Always use the Lua implementation

fuzzy = { implementation = "prefer_rust_with_warning" }

Advantages of Rust implementation

If possible, it's highly recommended to use the Rust implementation of the fuzzy matcher!

• Always finds the best match (resulting in better sorting)
• Performance on long lists (10k+ items)
• Typo resistance
• Proximity bonus
• Frecency

Installation

Prebuilt binaries (default on a release tag)

By default, Blink will download a prebuilt binary from the latest release, when you're on a release tag (via version = '*' on lazy.nvim for example). If you're not on a release tag, you may force a specific version via fuzzy.prebuilt_binaries.force_version. See the latest release for supported systems. See prebuilt_binaries section of the reference configuration for more options.

You may instead install the prebuilt binaries manually by downloading the appropriate binary from the latest release and placing it at $data/lazy/blink.cmp/target/release/libblink_cmp_fuzzy.$ext. Get the $data path via :echo stdpath('data'). Use .so for linux, .dylib for mac, and .dll for windows. If you're unsure whether you want -musl or -gnu for linux, you very likely want -gnu.

# Linux
~/.local/share/nvim/lazy/blink.cmp/target/release/libblink_cmp_fuzzy.so

# Mac
~/.local/share/nvim/lazy/blink.cmp/target/release/libblink_cmp_fuzzy.dylib

# Windows
~/Appdata/Local/nvim/lazy/blink.cmp/target/release/libblink_cmp_fuzzy.dll

Build from source (recommended for main)

When on main, it's highly recommended to build from source via cargo build --release (via build = '...' on lazy.nvim for example). This requires a nightly rust toolchain, which will be automatically downloaded when using rustup.

You may also build with nix via nix run .#build-plugin.

Configuration

See the fuzzy section of the reference configuration. For recipes, see the recipes section.

Sorting

The sorting can be customized by providing a custom function to sort the entries, based on sorting in Lua, or by using one of the built-in sorts:

• exact: Sorts by exact match, case-sensitive
• score: Sorts by the fuzzy matching score
• sort_text: Sorts by the sortText field
  • Generally, this field provides better sorting than label as the source/LSP may prioritize items relevant to the current context
  • If you're writing your own source, use this field to control sort order, instead of requiring users to add a sort function
• label: Sorts by the label field, deprioritizing entries with a leading _
• kind: Sorts by the numeric kind field
  • Check the order via :lua vim.print(vim.lsp.protocol.CompletionItemKind)

fuzzy = {
  sorts = {
    -- example custom sorting function, ensuring `_` entries are always last (untested, YMMV)
    function(a, b)
        if a.label:sub(1, 1) == "_" ~= a.label:sub(1, 1) == "_" then
            -- return true to sort `a` after `b`, and vice versa
            return not a.label:sub(1, 1) == "_"
        end
        -- nothing returned, fallback to the next sort
    end,
    -- default sorts
    'score',
    'sort_text',
}