Breaking changes

[ggandor]

As of bb66dc9, the leap function expects a list of winids instead of wininfo tables as the target-windows argument. See the updated snippets in the README.

[ggandor]

5183894 changed the flag case_insensitive to case_sensitive (with default false).

[ggandor]

97ab70a changes all arguments of the leap function and all fields of the (so far undocumented) state table (i.e., the user-facing API) to snake case, to ease usage in plain Lua. For most people the relevant change is ['target-windows'] = ... -> target_windows = ....

[ggandor]

As of 235ad9d, opts.max_aot_targets replaces opts.highlight_ahead_of_time. This is analogous to our "smart" autojump feature - instead of using a binary flag, ahead-of-time displaying of target beacons can be enabled conditionally, for a certain maximum number of (phase 1) targets. Setting max_aot_targets to nil corresponds to the old flag's true state (always enabled), while setting it to 0 corresponds to false.

[ggandor]

539d6e6 removed special_keys.eol. If you want to set an alias for \n, simply define a character class that contains it, e.g. "\r\n" (or {'\r', '\n'}) if you want to use <enter>. (<space> is kept as the default alias.)

[ggandor]

860e2d3 renamed the opts field character_classes to equivalence_classes.

[ggandor]

5f4d67c: nil or false cannot be used anymore to mark labels and safe_labels "disabled" - set them to {}. (This flexibility provided practically zero value for users, while making our lives unnecessarily harder.)

[ggandor]

Not a breaking change (yet), but a deprecation notice: 937bc92 replaced set_default_keymaps() with add_default_mappings() (applying a new mapping scheme), and the most of the old <Plug> keys with new ones. See more info in the docs.

[ggandor]

9cc4114 renamed a bunch of fields in opts and opts.special_keys. See the rationale in the commit message.

[ggandor]

Deprecation notice: setup is not recommended to use from now on - set the opts fields directly. Instead of setup, it is possible that we'll expose a convenience function under the name configure or something like that in the future.

[ggandor]

6068651 renamed <Plug>(leap-cross-window) to <Plug>(leap-from-window).

[ggandor]

3cc0e6a: special_keys.next_target takes the role of repeat_search and next_phase_one_target too now. See the commit message for details.

[ggandor]

Deprecation notice: new default mappings, hopefully for the last time: 88c627e. The -till/-to <Plug> keys are still documented, and the old mapping arrangement is suggested as an alternative one.

[ggandor]

ce16fae: multiselect mode has been removed.

[ggandor]

b75a86f simplified the highlighting logic. LeapLabelPrimary is kept as an alias for the new, generic LeapLabel group, but deprecated, and should be renamed if possible.