# 0.10.1

A small bugfix release to fix the keybindings so that <kbd>ctrl-p</kbd> moves the selection up.

Additionally:
* adds libVaxis as a lazyDependency
* adds Void Linux install instruction

# 0.10.0

This release adds support for an fzf-like `--preview` option, rewrites the UI to use
[libvaxis](https://github.com/rockorager/libvaxis/), and updates the Zig module API.

## Preview

The `--preview` option can be used to run a command for the currently selected line. The stdout of the command
is collected and displayed in a preview window on the right. `{}` characters in the command will be substituted with the current line.

The `--preview-width` option can be used to set the width of the preview window as a percent. Values from 20% to 80% are accepted, with or without the percent sign.

As an example

```
fd -tf | zf --preview 'cat {}'
```

will pipe a list of files to `zf` and use `cat` to display the contents of the currently selected file on the right of the window.

## Zig Module API

Zf can be used as a [Zig module](https://github.com/natecraddock/zf/blob/main/doc/lib.md) to add fuzzy matching
to your project. The API was simplified in this release.

Rather than accept boolean parameters, the options are now in a struct passed to the function.

This means

```zig
zf.rank(string, token, false, false);
zf.rank(string, token, false, true);
```

Is now written as

```zig
zf.rank(string, token, .{});
zf.rank(string, token, .{ .plain = true });
```

This makes the default case simpler, and also makes the boolean parameters clear at the call site.

The `case_sensitive` parameter was also named to `to_lower` for more clarity. See [the library docs](https://github.com/natecraddock/zf/blob/main/doc/lib.md) for more information.

## Other Changes

* The UI was completely rewritten to use [libvaxis](https://github.com/rockorager/libvaxis/) instead of my own
  custom terminal rendering code.

* The env variable `ZF_PROMPT` no longer supports terminal escape sequences. It was difficult to support this
  when rewriting to use libvaxis. Support for this feature may return in the future if there is interest.

* Adds an option to `zig build` to compile as a PIE executable. This should be useful for package
  mainainers. Use `zig build -Dpie` to enable this option

* Zf no longer does unicode normalization of the input.

# 0.9.2

This release supports both Zig 0.12.0 and 0.13.0.

No changes since the last release. Just tagging a new version so package managers can build with the newest releases of Zig.

# 0.9.1

Fixes two possible crashes

* **fix**: fix crash when input is invalid utf8
  ([50e3a8](https://github.com/natecraddock/zf/commit/50e3a8))

  zf incorrectly assumed that the input was valid utf-8 encoded unicode. Now the input is validated before normalization.

* **fix**: avoid integer overflow when selecting line down
  ([0456b7](https://github.com/natecraddock/zf/commit/0456b7))

# 0.9.0

This is a smaller release. The main goal of this is to have a stable version of zf that targets Zig 0.11.0. There are also improvements to support the new Zig package manager, refactorings, and small fixes.

I originally planned to release a UI preview feature in this release, but I ran into some issues with in release builds and I haven't had time to debug properly. So that will be postponed until the next release of zf. But a lot of refactoring to support a UI preview is already included in this release.

And although this news is months old, zf is now available in [nix](https://search.nixos.org/packages?channel=23.05&show=zf&from=0&size=50&sort=relevance&type=packages&query=zf).

* **feat**: add -0, -d and --delimiter options
  ([2f84ce](https://github.com/natecraddock/zf/commit/2f84ce))
  ([6b8784](https://github.com/natecraddock/zf/commit/6b8784))

  Adds a new option for setting a custom delimiter for splitting the input. Currently only supports 1 byte delimiters.

  Also adds -0 as a shorthand for `-d'\0'`.

* **feat**: better argument parsing
  ([0bbee9](https://github.com/natecraddock/zf/commit/0bbee9))

  zf now properly handles chained short options and short options immediately followed by an argument. Error handling and reporting is also improved.

* **feat**: handle window resizes
  ([c84872](https://github.com/natecraddock/zf/commit/c84872))

  Properly clears overflowing lines when the terminal resizes.

* **fix**: better buffered terminal writes for reduced flicker
  ([bfb8c2](https://github.com/natecraddock/zf/commit/bfb8c2))

  Further improves the terminal drawing logic to reduce flicker in the UI.

# 0.8.0

This release adds multiselect to the UI, improves the strict path matching feature added in the previous release, and improves the highlighting logic to be more accurate. The library API has also been updated.

* **feat**: add multiselect support
  ([e19409](https://github.com/natecraddock/zf/commit/e19409))

  Adds the ability to select and deselect candidates. Selection is toggled with <kbd>Tab</kbd>. The selected line is moved down with <kbd>Tab</kbd>, and moved up with <kbd>Shift Tab</kbd>. If any lines are selected, the number selected is displayed in the top
  right of the UI.

  Lines are written to stdout separated by newlines. This may be configurable in the future.

* **feat**: allow scrolling the list of candidates
  ([4ea08e](https://github.com/natecraddock/zf/commit/4ea08e))

  When the list of candidates is larger than the terminal height or configured display lines (default 10), moving the selected line past the bottom will now scroll the list. This means any item can be selected with the arrow keys alone.

* **feat**: improved strict path matching
  ([18e6c2](https://github.com/natecraddock/zf/commit/18e6c2))
  ([734af1](https://github.com/natecraddock/zf/commit/734af1))

  This feature was completely rewritten. Strict path matching is now slightly less strict and does not require contiguous path segments to match. This makes it much more useful in practice. The ranking of path segments has also been improved to more accurately find the closest match.

* **feat**: improve highlighting to match byte-by-byte
  ([3b9bf9](https://github.com/natecraddock/zf/commit/3b9bf9))

  This makes the highlights more precise and also fixes a subtle bug in the previous highlighting logic

* **feat**: simplify the module API
  ([0e81f7](https://github.com/natecraddock/zf/commit/0e81f7))

  Removes the filename parameter from the module and C APIs and adds a `plain` boolean parameter. This makes the higher-level API simpler to use.

* **fix**: index out of bounds in library
  ([712ee2](https://github.com/natecraddock/zf/commit/712ee2))

  Previously the library wouldn't properly handle zero-length strings or tokens and would read out of bounds.

* **fix**: `--plain` and `-p` now properly disable strict path matching
  ([c346c1](https://github.com/natecraddock/zf/commit/c346c1))

* **fix**: use os-specific path separators
  ([db69f6](https://github.com/natecraddock/zf/db69f6))

# 0.7.0

The headline feature of this release is strict path matching, another way that zf is optimized for filtering filepaths with accuracy and precision.

With strict path matching, when a query token contains a `/` character, any other characters after the slash must appear in a single path segment. As an example, the query `/foo` would match `/foo/bar/` but not `/fo/obar` because the characters `"foo"` must appear in a single path segment.

This is useful for narrowing down results when you know the exact path structure of your files. As a more complex example, with the following paths

```
app/models/foo/bar/baz.rb
app/models/foo/bar-baz.rb
app/models/foo-bar-baz.rb
app/monsters/dungeon/foo/bar/baz.rb
```

The query `a/m/f/b/baz` filters to only `app/models/foo/bar/baz.rb` whereas in previous versions of zf the string `app/monsters/dungeon/foo/bar/baz.rb` is also included in the results. To end strict path matching, just add a space to start a new token.

This release also includes many fixes, refactors, optimizations, unicode support, and a few other small features. Here's an overview of the biggest changes:

* **feat**: strict path matching
  ([b414ad](https://github.com/natecraddock/zf/commit/b414ad))

* **feat**: unicode support
  ([3e7069](https://github.com/natecraddock/zf/commit/3e7069))
  ([d596cc](https://github.com/natecraddock/zf/commit/d596cc))
  ([b397fa](https://github.com/natecraddock/zf/commit/b397fa))

  zf now normalizes all input (both the lines read on `stdin` and the query text) to unicode NFD form. This improves matching accuracy. The query editing line also now fully supports unicode grapheme cluster editing.

* **feat**: add `ZF_HIGHLIGHT` environment variable to set highlight color
  ([3cf713](https://github.com/natecraddock/zf/commit/3cf713))

  Adds a new environment variable to set the highlight color. Valid colors are: `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `bright_black`, `bright_red`, `bright_green`, `bright_yellow`, `bright_blue`, `bright_magenta`, `bright_cyan`, and `bright_white`

* **perf**: preallocate filtered candidate buffers
  ([c2a36ba](https://github.com/natecraddock/zf/commit/c2a36ba))

  Because zf uses an arena allocator and does not deallocate, this prevents unnecessary allocations. zf no longer has memory use increase over the runtime of the program. This also slightly improves performance by reducing time spent allocating.

* **tests**: add initial zf ranking consistency tests
  ([fbfb8f](https://github.com/natecraddock/zf/commit/fbfb8f))


* **fix**: escape ANSI codes in `ZF_PROMPT`
  ([e0118d](https://github.com/natecraddock/zf/commit/e0118d))

  This adds SGR ANSI escape code handling to `ZF_PROMPT`. It now correctly calculates the width of the prompt when ANSI codes are included. Currently only supports the SGR codes

* **fix**: correctly calculate the width of unicode in `ZF_PROMPT`
  ([c426ac](https://github.com/natecraddock/zf/commit/c426ac))

* **fix**: highlights incorrect when a candidate ends in a `/` character
  ([1d8924](https://github.com/natecraddock/zf/commit/1d8924))

# 0.6.0

This release is focused on small optimizations, refactors, and using zf as a library. Because zf is now packaged as a Zig library, it makes sense to switch back to semantic versioning which makes this version 0.6.0 rather than 0.6. This release also updates the source code to support Zig 0.10.0.

While refactoring zf to be more easily consumed by a library, I designed the library to require zero allocations and be passed external slices of memory. Alongside this I also added a restriction to zf as a cli tool. The number of space-separated tokens in the query is now limited to 16. This seems like a safe upper limit, but can be raised if needed.

* **library**: package zf as a Zig library
  ([47467d](https://github.com/natecraddock/zf/commit/47467d))
  ([f9f17d](https://github.com/natecraddock/zf/commit/f9f17d))

  Adds a Zig package exposing the zf ranking and highlight functions. Also updates the existing C library to match the Zig library.

  See the [docs](https://github.com/natecraddock/zf/blob/master/doc/zf.md) for instructions on using zf as a library.

* **refactor**: reduce size of the Candidate struct and reorganize code
  ([ee2d18](https://github.com/natecraddock/zf/commit/ee2d18))
  ([f88c76](https://github.com/natecraddock/zf/commit/f88c76))
  ([426f4d](https://github.com/natecraddock/zf/commit/426f4d))

  A small optimization that reduces the size of the Candidate struct. This involved a restructure of the ranking algorithm, separating ranking and highlighting into two separate functions. This resulted in a small but measurable performance increase.

* **ci**: zf tests are now run with GitHub actions for pushes and PRs
  ([41eaa5](https://github.com/natecraddock/zf/commit/41eaa5))

# 0.5

This smaller release fixes a few bugs and adds support for a few environment variables.
A long time coming (I've been focused on other projects), I'm finally back to work on zf. The next release will be focused on utf-8 unicode support.

* **feat**: `ZF_PROMPT` environment variable
  ([7c6b0a](https://github.com/natecraddock/zf/commit/7c6b0a))

  Allows customization of the zf prompt. Note that this does not yet support
  unicode characters. If you want a space displayed after the prompt, you must
  include it in the string. For example: `export ZF_PROMPT="> "`.

* **feat**: `ZF_VI_MODE` environment variable
  ([ca05d3](https://github.com/natecraddock/zf/commit/ca05d3))

  Adds an environment variable that changes the behavior of the ctrl+k
  binding. When enabled (the variable is present and is not empty) ctrl+k
  moves up a line. When disabled, ctrl+k acts like readline and deletes
  from the cursor to the end of the line.

* **feat**: `NO_COLOR` environment variable
  ([541052](https://github.com/natecraddock/zf/commit/541052))

  Support the semi-standardized `NO_COLOR` environment variable to disable
  terminal colors.

  See https://no-color.org

* **fix**: missing null check
  ([783441](https://github.com/natecraddock/zf/commit/783441b))

  The name field was assumed to be not null so using the --plain option caused
  a crash. Caught in telescope-zf-native.nvim

* **fix**: trailing chars on TUI stdout
  ([6a717d](https://github.com/natecraddock/zf/commit/6a717d19))

  The buffer wasn't flushed properly, leading to the buffered lines of cleanup
  print statements never being output.

* **fix**: crash when highlight ranges extend past terminal width
  ([bf437f](https://github.com/natecraddock/zf/commit/bf437f))

  When a highlight range extended past the width of the terminal the slice
  would go out of bounds causing a panic.

# 0.4

This release includes many refactors and cleanups to the code. Flicker in
drawing the UI has been resolved, and work has begun on macOS support. And
finally, the algorithm for matching on filenames has received an update and
should be even more precise.

Commit hashes are now included in the changelog for convenience.

* **feat**: increase ranking algorithm precision
  ([d31e70](https://github.com/natecraddock/zf/commit/d31e70))

  Matches on filenames are now given a rank priority relative to the percentage
  of the filename matched. As more query term letters match the filename, the
  higher it ranks.

* **feat**: draw count information in the query line
  ([6aa45e](https://github.com/natecraddock/zf/commit/6aa45e))

  Display a [filtered count]/[total count] indicator on the right side of the
  query line. Currently this is enabled and cannot be toggled, but a flag will
  be added soon.

* **feat**: add more readline bindings ([@jmbaur](https://github.com/jmbaur))
  ([9c7a78](https://github.com/natecraddock/zf/commit/9c7a78))

* **feat**: add `ctrl-j` and `ctrl-k` mappings
  ([3fb459](https://github.com/natecraddock/zf/commit/3fb459))

* **feat**: switch from bright blue to cyan for highlights
  ([ee05d3](https://github.com/natecraddock/zf/commit/ee05d3))

* **fix**: delete keybinding
  ([cbb467](https://github.com/natecraddock/zf/commit/cbb467))

* **fix**: remove flicker in the TUI
  ([cc7c2c](https://github.com/natecraddock/zf/commit/cc7c2c))

  The default TTY writer was not buffered. Buffering the output reduces syscalls
  and makes the TUI much more responsive!

* **fix**: emit DECCKM "application mode" escape sequences
  ([@ratfactor](https://github.com/ratfactor))
  ([d2c795](https://github.com/natecraddock/zf/commit/d2c795))

* **fix**: failure to render TUI on macOS
  ([9ade19](https://github.com/natecraddock/zf/commit/9ade19))

  macOS support is still not official, but should work better now.

# 0.3

This release improves the ranking algorithm, adds two new commandline options,
fixes a few bugs, and optimizes the TUI drawing code. Shell completion scripts
are now provided for bash, zsh, and fish.

* **feat**: prioritize matches on beginning of words

  Matches that begin at the start of a word will be ranked higher than matches
  in the middle of a word.

* **feat**: add keep order option (`-k` `--keep-order`)

  Adds an option to skip sorting of items and preserve the order of lines read
  on stdin.

* **feat**: add plain text option ('-p' '--plain')

  Adds an option to skip the filename match prioritization. Useful when the
  lines are not filepaths.

* **feat**: expose case-sensitive matching in libzf

  Update to the zf algorithm to make matching more precise. Matches on the
  beginning of words are ranked higher.

* **extra**: add shell completions for bash, zsh, and fish

* **fix**: query mangling when moving the cursor left or right

* **fix**: off-by-one scrolling error at bottom of terminals

  When zf was run at the bottom of a terminal the scrolling would remove the
  previous prompt.

* **fix**: don't require pressing esc three times to cancel

# 0.2

This release fixes a few minor bugs, optimizes drawing the terminal user
interface, and introduces a number of new features:

* **feat**: add `libzf` ffi library

  Exposes the zf ranking algorithm to be used as a library. See
  [natecraddock/telescope-zf-native.nvim](https://github.com/natecraddock/telescope-zf-native.nvim)
  for an example neovim plugin that uses libzf.

* **feat**: match highlights

  The results are now highlighted to show the substrings that match the query
  tokens.

* **feat**: drop semver.

  Once v1.0 is released, the commandline argument api will be stabilized. Any
  changes to flags will require a major version increment. Any fixes and
  non-breaking features are considered minor releases.

* **break**: rename `--query` flag to `--filter`

  This makes more sense, and is compatible with fzf. It also makes it possible
  to support a `--query` flag in the future if needed.

* **feat**: add `--lines [num lines]` option

  Allows controlling the number of displayed result lines in the terminal user
  interface.

# 0.0.1

Initial release