Create a slight delay in on shortcut keys so you can't spam theme in theme dev #6711
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
Contributor
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success3493 tests passing in 1407 suites. Report generated by 🧪jest coverage report action from eda441d |
Contributor
|
/snapit |
graygilmore
reviewed
Dec 11, 2025
Contributor
graygilmore
left a comment
graygilmore
left a comment
There was a problem hiding this comment.
🎩 went great but I'm a little confused about the unused function
|
|
||
| // This prevents the keypress handler from being called multiple times in a short span | ||
| keyBlock = true | ||
| setTimeout(() => { |
Contributor
There was a problem hiding this comment.
Are you familiar with debouncing? We have a debounce helper function that we could potentially use here instead? Might be overkill for what you're doing but it's there if you want! https://github.com/Shopify/cli/blob/main/packages/cli-kit/src/public/common/function.ts#L39
We could use leading: true to make sure we don't delay the first keypress.
Contributor
Author
There was a problem hiding this comment.
Sure I could use the helper since it's already available. Let me check this out!
EvilGenius13
force-pushed
the
theme-dev-shortcut-debounce
branch
from
d29fe1e to
cd9753f
Compare
…open multiple tabs.
EvilGenius13
force-pushed
the
theme-dev-shortcut-debounce
branch
from
cd9753f to
eda441d
Compare
graygilmore
approved these changes
Dec 12, 2025
graygilmore
reviewed
Dec 12, 2025
| switch (key.name) { | ||
| case 't': | ||
| openURLSafely(urls.local, 'localhost') | ||
| debouncedOpenURL(urls.local, 'localhost') |
Contributor
There was a problem hiding this comment.
I might've debounced the click handler instead of the URL opening itself but this works, too!
dejmedus
approved these changes
Dec 12, 2025
Contributor
dejmedus
left a comment
dejmedus
left a comment
There was a problem hiding this comment.
This was a super fun 🎩 Looks great!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
WHY are these changes introduced?
Fixes https://github.com/Shopify/developer-tools-team/issues/918
If you copy and paste in the terminal when running
theme devyou can end up with a ton of tabs opening.Since we are watching for certain keys like
tto open localhost, if you were to copy and paste text that had multiplet|p|e|g<-- shortcut keys, you can end up opening a lot of tabs.WHAT is this pull request doing?
When a key is pressed we create a short lived lock, and any other keys pressed during that time will be ignored. The delay is set to 100ms so we shouldn't see any problems with someone quickly doing something like opening localhost and then the editor for themselves.
I also added some extra keypress tests that we didn't originally have.
How to test your changes?
This is a fun one to test.
theme devand in the console, pastetteeppggtt. This should open 10 tabs.t) and open localhost once.Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist