fix: restore user keymaps after closing CodeDiff #215
Merged
+351
−19
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #211 - Keymaps not restored properly after quitting :CodeDiff with q The issue was that CodeDiff overwrote user's buffer-local keymaps (J, K, ]h, [h, etc.) but only deleted them on close, never restoring the originals. Changes: - Add save_existing_keymap() to capture keymap metadata before overwriting - Store saved keymaps in session (sess.saved_keymaps) keyed by bufnr:mode:lhs - On cleanup, restore original keymaps with their callbacks and options - Add guard to prevent double-cleanup from deleting restored keymaps - Add comprehensive tests for keymap restoration scenarios
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #211 - Keymaps not restored properly after quitting
:CodeDiffwithqProblem
When users had buffer-local keymaps (e.g.,
J,K,]h,[h) and opened CodeDiff, the plugin would overwrite these keymaps. On close, it only deleted the CodeDiff keymaps without restoring the user's originals.Solution
save_existing_keymap()to capture keymap metadata (callback, rhs, options) before CodeDiff sets its ownbufnr:mode:lhsexpr,silent,noremap,nowait,desc)Changes
lua/codediff/ui/lifecycle/accessors.lua: Save and restore keymaps logictests/keymap_restore_spec.lua: Comprehensive tests for the fixTesting
All tests pass including 3 new keymap restoration tests covering: