-
Notifications
You must be signed in to change notification settings - Fork 97
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
Expose tools for building & normalizing hotkey & sequence strings #94
Merged
Conversation
This file contains 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
Given this is a breaking change, perhaps we should target this change a v3-candidate branch to keep the main branch deployable? |
Open
I added this PR to #74 |
theinterned
approved these changes
Oct 10, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really like the branded type use here. Very cool
theinterned
approved these changes
Oct 10, 2023
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.
This PR expands the usefulness of the
hotkey
package by exposing lower-level utilities so that external tools can work with hotkey strings directly instead of only binding event handlers. This closes #93.The changes include the following:
New types
NormalizedHotkeyString
andNormalizedSequenceString
. These are simple branded string types that should help to encourage the safe use of the hotkey & sequence strings. Normalized hotkey strings can be parsed from plain strings withnormalizeHotkey
or they can be obtained from events witheventToHotkeyString
. This way, a comparison ofstring === NormalizedHotkeyString
will obviously be false and cause a lint error, ensuring that consumers don't forget to normalize before comparing. The same applies to `NormalizedSequenceString.Combined the
sequence.ts
andnormalize-sequence.ts
files since they are closely related. This groups the code that creates sequence strings together.Added a new
normalizeSequence
helper that is the sequence form ofnormalizeHotkey
, enabling abstracting away the splitting and rejoining of sequences. Also added aSEQUENCE_DELIMETER
constant.Exposed all exports from
sequence.ts
andhotkey.ts
publicly.