fix: recreating keyboardShortcuts interface on file changes. #1465

nishu-murmu · 2025-02-28T06:51:31Z

Overview

I noticed that keyboard shortcuts weren't working after files were being saved or HMR was triggered.
Hope this fixes it.

netlify · 2025-02-28T06:51:47Z

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	`abc7f15`
🔍 Latest deploy log	https://app.netlify.com/projects/creative-fairy-df92c4/deploys/68412b29909b4200089167a5
😎 Deploy Preview	https://deploy-preview-1465--creative-fairy-df92c4.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Timeraa

Was noticing this too but wouldn't this potentially be a memory leak since we keep creating it?

…nchange

nishu-murmu · 2025-03-04T11:30:49Z

Was noticing this too but wouldn't this potentially be a memory leak since we keep creating it?

Yeah, now that I think about it, it really can be. as such there are already existing issues for windows.
We can just close the listeners instead of the interface. That way only one interface will be used.

packages/wxt/src/core/keyboard-shortcuts.ts

packages/wxt/src/core/create-server.ts

pkg-pr-new · 2025-03-23T20:23:56Z

Open in StackBlitz

@wxt-dev/analytics

npm i https://pkg.pr.new/@wxt-dev/analytics@1465

@wxt-dev/auto-icons

npm i https://pkg.pr.new/@wxt-dev/auto-icons@1465

@wxt-dev/browser

npm i https://pkg.pr.new/@wxt-dev/browser@1465

@wxt-dev/i18n

npm i https://pkg.pr.new/@wxt-dev/i18n@1465

@wxt-dev/module-react

npm i https://pkg.pr.new/@wxt-dev/module-react@1465

@wxt-dev/module-solid

npm i https://pkg.pr.new/@wxt-dev/module-solid@1465

@wxt-dev/module-svelte

npm i https://pkg.pr.new/@wxt-dev/module-svelte@1465

@wxt-dev/module-vue

npm i https://pkg.pr.new/@wxt-dev/module-vue@1465

@wxt-dev/runner

npm i https://pkg.pr.new/@wxt-dev/runner@1465

@wxt-dev/storage

npm i https://pkg.pr.new/@wxt-dev/storage@1465

@wxt-dev/unocss

npm i https://pkg.pr.new/@wxt-dev/unocss@1465

@wxt-dev/webextension-polyfill

npm i https://pkg.pr.new/@wxt-dev/webextension-polyfill@1465

wxt

npm i https://pkg.pr.new/wxt@1465

commit: abc7f15

…nchange

packages/wxt/src/core/keyboard-shortcuts.ts

aklinker1 · 2025-03-29T14:29:39Z

packages/wxt/src/core/create-server.ts

-      const reloadOnChange = createFileReloader(server);
+      const reloadOnChange = () => {
+        keyboardShortcuts.start();
+        keyboardShortcuts.printHelp({
+          canReopenBrowser:
+            !wxt.config.runnerConfig.config.disabled && !!runner.canOpen?.(),
+        });
+        return createFileReloader(server);
+      };
      server.watcher.on('all', reloadOnChange);
-      keyboardShortcuts.start();
-      keyboardShortcuts.printHelp({
-        canReopenBrowser:
-          !wxt.config.runnerConfig.config.disabled && !!runner.canOpen?.(),
-      });


One side-effect to this change is that the help message is printed after every file is saved, right? Should we leave the printHelp call outside the reloadOnChange where it was before so we only print the message when the server is started/restarted?

Yeah, we can keep it outside, users can see it once when they restart the server.
Vite is also doing the same.

aklinker1

Do we know why the readline interface stops working when a file is saved? Or are we just making a change in hopes that it fixes the problem?

packages/wxt/src/core/create-server.ts

…nchange

…t into keyboardshortcut-onchange

…nchange

…t into keyboardshortcut-onchange

aklinker1

Let's merge this and give it a go.

Edit: hmm, for some reason checks aren't running. I'll get the going when I get home.

…ange

codecov · 2025-06-05T05:31:37Z

Codecov Report

Attention: Patch coverage is 50.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 80.90%. Comparing base (240bbb3) to head (abc7f15).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/wxt/src/core/create-server.ts	50.00%	2 Missing ⚠️
packages/wxt/src/core/keyboard-shortcuts.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1465      +/-   ##
==========================================
- Coverage   81.27%   80.90%   -0.37%     
==========================================
  Files         130      130              
  Lines        6642     6642              
  Branches     1087     1086       -1     
==========================================
- Hits         5398     5374      -24     
- Misses       1233     1257      +24     
  Partials       11       11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2025-06-05T05:35:23Z

Thanks for helping make WXT better!

fix: restarting keyboardShortcuts listener on file changes.

5eefbfd

nishu-murmu requested review from aklinker1 and Timeraa as code owners February 28, 2025 06:51

nishu-murmu changed the title ~~fix: restarting keyboardShortcuts listener on file changes.~~ fix: recreating keyboardShortcuts interface on file changes. Feb 28, 2025

Timeraa reviewed Mar 4, 2025

View reviewed changes

nishu-murmu added 2 commits March 4, 2025 16:53

Merge branch 'main' of github.com:wxt-dev/wxt into keyboardshortcut-o…

f522341

…nchange

fix: closing the listeners instead of the interface

d077bb0

aleclarson suggested changes Mar 22, 2025

View reviewed changes

packages/wxt/src/core/keyboard-shortcuts.ts Outdated Show resolved Hide resolved

packages/wxt/src/core/keyboard-shortcuts.ts Outdated Show resolved Hide resolved

packages/wxt/src/core/create-server.ts Outdated Show resolved Hide resolved

nishu-murmu added 2 commits March 24, 2025 10:14

Merge branch 'main' of github.com:wxt-dev/wxt into keyboardshortcut-o…

18b15c1

…nchange

fix: returning createFileReloader function and adding null checks.

408ff24

aleclarson reviewed Mar 24, 2025

View reviewed changes

packages/wxt/src/core/keyboard-shortcuts.ts Outdated Show resolved Hide resolved

chore: remove if statement.

417676f

aklinker1 reviewed Mar 29, 2025

View reviewed changes

aklinker1 requested changes Mar 29, 2025

View reviewed changes

packages/wxt/src/core/create-server.ts Outdated Show resolved Hide resolved

nishu-murmu added 6 commits March 31, 2025 23:06

Merge branch 'main' of github.com:wxt-dev/wxt into keyboardshortcut-o…

1f45727

…nchange

Merge branch 'main' of github.com:wxt-dev/wxt into keyboardshortcut-o…

f8b27ac

…nchange

Merge branch 'keyboardshortcut-onchange' of github.com:nishu-murmu/wx…

e2cb479

…t into keyboardshortcut-onchange

Merge branch 'main' of github.com:wxt-dev/wxt into keyboardshortcut-o…

286677a

…nchange

Merge branch 'keyboardshortcut-onchange' of github.com:nishu-murmu/wx…

c952a42

…t into keyboardshortcut-onchange

fix: updating reloadOnChange function.

2ee680c

aklinker1 approved these changes Jun 4, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into keyboardshortcut-onch…

abc7f15

…ange

aklinker1 merged commit 6be9a4e into wxt-dev:main Jun 5, 2025
18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: recreating keyboardShortcuts interface on file changes. #1465

fix: recreating keyboardShortcuts interface on file changes. #1465

Uh oh!

nishu-murmu commented Feb 28, 2025

Uh oh!

netlify bot commented Feb 28, 2025 •

edited

Loading

Uh oh!

Timeraa left a comment

Uh oh!

nishu-murmu commented Mar 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Mar 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

aklinker1 Mar 29, 2025

Uh oh!

nishu-murmu Apr 10, 2025

Uh oh!

aklinker1 left a comment

Uh oh!

Uh oh!

aklinker1 left a comment •

edited

Loading

Uh oh!

codecov bot commented Jun 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

fix: recreating keyboardShortcuts interface on file changes. #1465

fix: recreating keyboardShortcuts interface on file changes. #1465

Uh oh!

Conversation

nishu-murmu commented Feb 28, 2025

Overview

Uh oh!

netlify bot commented Feb 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for creative-fairy-df92c4 ready!

Uh oh!

Timeraa left a comment

Choose a reason for hiding this comment

Uh oh!

nishu-murmu commented Mar 4, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

aklinker1 Mar 29, 2025

Choose a reason for hiding this comment

Uh oh!

nishu-murmu Apr 10, 2025

Choose a reason for hiding this comment

Uh oh!

aklinker1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aklinker1 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

github-actions bot commented Jun 5, 2025

Uh oh!

Uh oh!

netlify bot commented Feb 28, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 23, 2025 •

edited

Loading

aklinker1 left a comment •

edited

Loading

codecov bot commented Jun 5, 2025 •

edited

Loading