hasundue / ddu-filter-zf

A filter for ddu.vim featuring 'zf', a fuzzy-finder designed for file paths (currently unmaintained)

ddu-filter-zf

Important

The maintainance of this plugin is suspended indefinitely, since the author no longer uses ddu.vim. If you are interested in taking over the project, please let the author know.

Introduction

ddu-filter-zf is a fuzzy-filter for ddu.vim, featuring zf, a fuzzy-finder designed for fuzzy-matching file paths.

Requirements

• Deno
• denops.vim
• ddu.vim
• Zig (optional, if you want to build libzf yourself)

Latest stable versions are only supported unless explicitly mentioned.

Installation

A build step is required to compile libzf. In the case of dein, for example, you can specify the build command as follows:

call dein#add('hasundue/ddu-filter-zf', #{ build: 'deno task build' })

Alternatively, you can use the pre-built libzf provided in the release archives (available for Linux x86_64, Windows x86_64, and macOS x86_64). In this case, you need to specify the download command as follows:

call dein#add('hasundue/ddu-filter-zf', #{ build: 'deno task fetch' })

Configuration

ddu-filter-zf provides matcher_zf, sorter_zf, and converter_zf (highlighter) for ddu.vim. Here is an example configuration where ddu-filter-zf is used as the default filter for all the sources:

call ddu#custom#patch_global(#{
  \   sourceOptions: #{
  \     _: #{
  \       matchers: ['matcher_zf'],
  \       sorters: ['sorter_zf'],
  \       converters: ['converter_zf'],
  \     },
  \   },
  \   filterParams: #{
  \     converter_zf: #{
  \       highlight: 'Search',
  \     },
  \   },
  \ })

Parameters

converter_zf

highlight

• Type: string (highlight group name)
• Default: Search

The highlight group used to highlight the matched characters.

Features

Please refer to the original documentation of zf for the details of the zf-specific features.

Here are some non-trivial features of ddu-filter-zf:

• It enables the file-path-specific features only for items with kind = 'file'. For other kind of items, it treats them as plain strings and behaves like a conventional filter.