Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking changes #18

Open
ggandor opened this issue May 21, 2022 · 14 comments
Open

Breaking changes #18

ggandor opened this issue May 21, 2022 · 14 comments

Comments

@ggandor
Copy link
Owner

ggandor commented May 21, 2022

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
Copy link
Owner Author

ggandor commented Jun 23, 2022

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

@ggandor
Copy link
Owner Author

ggandor commented Jul 8, 2022

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
Copy link
Owner Author

ggandor commented Jul 15, 2022

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
Copy link
Owner Author

ggandor commented Jul 23, 2022

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
Copy link
Owner Author

ggandor commented Aug 19, 2022

860e2d3 renamed the opts field character_classes to equivalence_classes.

@ggandor
Copy link
Owner Author

ggandor commented Sep 1, 2022

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
Copy link
Owner Author

ggandor commented Oct 14, 2022

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
Copy link
Owner Author

ggandor commented Oct 14, 2022

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

@ggandor
Copy link
Owner Author

ggandor commented Nov 18, 2022

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
Copy link
Owner Author

ggandor commented Feb 2, 2023

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

@ggandor
Copy link
Owner Author

ggandor commented Jun 24, 2023

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
Copy link
Owner Author

ggandor commented Dec 25, 2023

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
Copy link
Owner Author

ggandor commented Feb 24, 2024

ce16fae: multiselect mode has been removed.

@ggandor
Copy link
Owner Author

ggandor commented Jul 4, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant