- Notifications
You must be signed in to change notification settings - Fork502
refactor(keys): use allowlist for valid opts#1938
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
devxpain wants to merge1 commit intofolke:mainChoose a base branch fromdevxpain-fork:main
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
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
Instead of using a blacklist for specific keys, use an allowlist for valid keys in the `opts` function of `LazyKeysHandler`.
This PR is stale because it has been open 30 days with no activity. |
Sign up for freeto 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
This pull request refactors the
optsfunction inLazyKeysHandlerto use an allowlist for valid options instead of a blacklist. This change enhances code clarity and maintainability by explicitly defining accepted options, reducing the risk of unintentional errors from unsupported keys.Changes Made
optsfunction ofLazyKeysHandler.Reason
I provided this pull request to allow the addition of which-key's key specifications to each plugin's
keysattribute. The previous blacklist method restricted the addition of attributes that weren't explicitly allowed, such as theiconattribute, resulting in errors from Neovim. By using an allowlist, we can avoid these issues and freely include all necessary attributes in the key specifications. Following is an example of what we can do after applying the pull request.In
nvim/lua/plugins/notify.luaIn
nvim/lua/plugins/which-key.lua