Conversation
fredericbahr
changed the title
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0c2183d968
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| } | ||
|
|
||
| // Register the hotkey | ||
| registration = manager.register(sequence, descriptor as HotkeyCallback, { |
There was a problem hiding this comment.
hotkeySequence currently passes descriptor to manager.register as if it were a callback, but SequenceManager later invokes registration.callback(event, context), so sequence matches will fail at runtime with a non-function callback. This should register the method function (typically descriptor.value) bound to the current element instance, otherwise @hotkeySequence is effectively broken.
Useful? React with 👍 / 👎.
| proto.disconnectedCallback = function () { | ||
| originalDisconnected.call(this) | ||
|
|
||
| if (registration.isActive) { |
There was a problem hiding this comment.
connectedCallback can return before registration is created (for example when target resolves to null, or in environments without document), but disconnectedCallback always reads registration.isActive. In those cases teardown throws because registration is undefined, so components that intentionally skip registration crash on disconnect.
Useful? React with 👍 / 👎.
| const originalConnected = proto.connectedCallback | ||
| const originalDisconnected = proto.disconnectedCallback | ||
|
|
||
| let registration: HotkeyRegistrationHandle |
There was a problem hiding this comment.
The registration handle is stored in decorator closure state on the prototype, so all instances of a decorated component share one mutable handle. When multiple instances mount, later mounts overwrite earlier handles; unmounting one instance can unregister another instance’s hotkey and leak the first one. Store registrations on this (or a WeakMap keyed by instance) so lifecycle cleanup is instance-safe.
Useful? React with 👍 / 👎.
fredericbahr
force-pushed
the
feat-lit-adapter
branch
from
0c2183d to
af261b1
Compare
KevinVandy
changed the title
@tanstack/angular-hotkeys
@tanstack/hotkeys
@tanstack/hotkeys-devtools
@tanstack/lit-hotkeys
@tanstack/preact-hotkeys
@tanstack/preact-hotkeys-devtools
@tanstack/react-hotkeys
@tanstack/react-hotkeys-devtools
@tanstack/solid-hotkeys
@tanstack/solid-hotkeys-devtools
@tanstack/svelte-hotkeys
@tanstack/vue-hotkeys
@tanstack/vue-hotkeys-devtools
commit: |
|
📝 WalkthroughWalkthroughIntroduces a new Changes
Sequence DiagramsequenceDiagram
participant LitEl as LitElement<br/>(with `@hotkey`)
participant Decorator as `@hotkey`<br/>Decorator
participant Controller as HotkeyController
participant Manager as HotkeyManager
participant Browser as Browser<br/>KeyEvent
LitEl->>Decorator: Class decorated with `@hotkey`
LitEl->>LitEl: connectedCallback()
LitEl->>Decorator: hostConnected triggered
Decorator->>Controller: new HotkeyController(...)
Decorator->>LitEl: addController(controller)
Controller->>Manager: registerHotkey(hotkey, target, callback)
Manager->>Manager: Store registration handle
Browser->>Manager: KeyboardEvent fires
Manager->>Manager: Match hotkey pattern
Manager->>Controller: Invoke callback
Controller->>LitEl: Execute decorated method
LitEl->>LitEl: disconnectedCallback()
Controller->>Manager: unregisterHotkey()
Manager->>Manager: Remove registration handle
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 9
🧹 Nitpick comments (7)
examples/lit/hotkey-sequence/src/index.css (2)
137-149: Add explicit keyboard focus styling for buttons.You already style hover; adding
:focus-visiblekeeps keyboard navigation clear and consistent.Suggested patch
button:hover { background: `#0052a3`; } + +button:focus-visible { + outline: 2px solid `#0066cc`; + outline-offset: 2px; +}🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/lit/hotkey-sequence/src/index.css` around lines 137 - 149, Add explicit keyboard focus styling for the existing button rules: implement a focus-visible style for the button selector (e.g., target button:focus-visible) that provides a clear outline or box-shadow and visible contrast (and optionally include a fallback button:focus for browsers without focus-visible) so keyboard users see focused state consistent with the hover state; update the rules near the existing button and button:hover selectors to include these focus styles while keeping current colors and rounded corners.
93-97: Increase hint text contrast for readability.This hint style is quite low-contrast at small size; darkening it a bit improves legibility without changing layout.
Suggested patch
.hint { font-size: 12px; - color: `#888`; + color: `#666`; font-style: italic; }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/lit/hotkey-sequence/src/index.css` around lines 93 - 97, The .hint rule in examples/lit/hotkey-sequence/src/index.css uses a low-contrast color (`#888`) that reduces readability at small sizes; update the .hint CSS rule to use a darker color (for example `#666` or `#444`) to improve contrast while keeping font-size and font-style the same so layout is unaffected.examples/lit/hotkey-sequence/package.json (1)
14-14: Update dependency to use workspace protocol to ensure example consumes local package.The example currently uses
"@tanstack/lit-hotkeys": "^0.4.0", which may resolve to a published version from npm rather than the local workspace package. To dogfood current branch changes, useworkspace:*orworkspace:^instead.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/lit/hotkey-sequence/package.json` at line 14, Update the dependency entry for "@tanstack/lit-hotkeys" in the example's package.json to use the workspace protocol so it consumes the local package instead of the published npm version; replace the version string "^0.4.0" with a workspace spec such as "workspace:*" (or "workspace:^" if you want caret behavior) to ensure the example dogfoods the local package.examples/lit/hotkey/src/app.ts (1)
410-420: Arrow function property vs method for hotkey handlers.Using arrow function class properties (like
_handleSaving) with decorators can have subtle differences from regular methods. The decorator accessesdescriptor?.valuewhich may beundefinedfor arrow function properties since they're initialized in the constructor, not defined on the prototype.The fallback
host[propertyKey]on line 52 of the decorator handles this, but it's worth noting the inconsistency across handlers (some use arrow functions, some use methods).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/lit/hotkey/src/app.ts` around lines 410 - 420, The _handleSaving handler is defined as an arrow function property which may not appear on the prototype for the hotkey decorator to inspect (descriptor?.value can be undefined); convert _handleSaving into a normal class method (e.g., private _handleSaving(event: KeyboardEvent, ctx: HotkeyCallbackContext) { ... }) so the decorator can access it via the descriptor, and update any usages that relied on lexical binding (if necessary bind in constructor or use the decorator fallback). Ensure consistency with other handlers by making them methods too so the decorator's descriptor-based logic works uniformly.packages/lit-hotkeys/src/decorators/hotkey.ts (1)
29-32: Default options are replaced, not merged.When a user passes partial options like
{ requireReset: true }, the entireHOTKEY_DEFAULT_OPTIONSobject is replaced rather than merged. This means other sensible defaults (e.g.,preventDefault: true) won't apply unless explicitly provided.Consider spreading defaults:
♻️ Proposed fix to merge defaults
export function hotkey( hotkey: RegisterableHotkey, - options: HotkeyOptions = HOTKEY_DEFAULT_OPTIONS, + options: Partial<HotkeyOptions> = {}, ) { + const mergedOptions: HotkeyOptions = { ...HOTKEY_DEFAULT_OPTIONS, ...options } return function <T extends HotkeyCallback>( ... const controller: HotkeyController = new HotkeyController( this, hotkey, callback, - options, + mergedOptions, )🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/lit-hotkeys/src/decorators/hotkey.ts` around lines 29 - 32, The hotkey function currently replaces HOTKEY_DEFAULT_OPTIONS when callers pass partial HotkeyOptions; update the function to merge defaults with provided options so missing keys keep defaults (e.g., combine HOTKEY_DEFAULT_OPTIONS and the incoming options before using them). Locate the hotkey function and ensure you merge HOTKEY_DEFAULT_OPTIONS with the parameter named options (or set a mergedOptions local variable) so flags like preventDefault remain true unless explicitly overridden; keep the parameter type HotkeyOptions and use the merged result throughout the function.packages/lit-hotkeys/src/controllers/hotkey-sequence.ts (1)
48-78: Consider the same default options merging pattern.Similar to the
@hotkeydecorator, the constructor usesoptions = HOTKEY_SEQUENCE_DEFAULT_OPTIONSwhich replaces rather than merges. When users provide partial options like{ timeout: 500 }, other defaults won't apply.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/lit-hotkeys/src/controllers/hotkey-sequence.ts` around lines 48 - 78, The current logic in hostConnected relies on this.options but the constructor used options = HOTKEY_SEQUENCE_DEFAULT_OPTIONS which overwrites defaults; instead merge user options with HOTKEY_SEQUENCE_DEFAULT_OPTIONS so missing defaults remain (use something like mergedOptions = { ...HOTKEY_SEQUENCE_DEFAULT_OPTIONS, ...this.options }), then use mergedOptions when extracting enabled/target and when passing options to manager.register; update references in hostConnected (replace uses of this.options with mergedOptions) and ensure target resolution and optionsWithoutTarget are derived from the merged object.packages/lit-hotkeys/src/decorators/hotkey-sequence.ts (1)
34-37: Inconsistency:descriptoris required here but optional in@hotkey.In
hotkey.tsline 36,descriptorisTypedPropertyDescriptor<T> | undefined, allowing the decorator to work on both methods and class field properties. Here it's required, which may cause issues when decorating arrow function class fields.♻️ Proposed fix for consistency
return function <T extends HotkeyCallback>( proto: LitElement, methodName: string, - descriptor: TypedPropertyDescriptor<T>, + descriptor?: TypedPropertyDescriptor<T>, ) {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/lit-hotkeys/src/decorators/hotkey-sequence.ts` around lines 34 - 37, The decorator's inner function currently requires descriptor but should accept an optional descriptor to match `@hotkey` and support arrow-function class fields; change the signature in the returned function to accept descriptor?: TypedPropertyDescriptor<T> | undefined (or descriptor: TypedPropertyDescriptor<T> | undefined) and then update any code that reads/writes descriptor.value or descriptor.initializer to safely handle descriptor being undefined (create/assign a proper descriptor when decorating a class field or use proto[methodName] fallback). Ensure the returned function (the decorator in hotkey-sequence.ts) mirrors the optional descriptor handling used in hotkey.ts so both method and field/arrow-function decorations work consistently.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@examples/lit/hotkey/package.json`:
- Around line 13-15: Replace the external semver for the internal package
`@tanstack/lit-hotkeys` in the example package.json (currently "^0.4.0") with the
workspace protocol "workspace:*" so pnpm resolves the local package; make the
same change for the other lit example's package.json (the hotkey-sequence
example) to ensure both use "workspace:*" for `@tanstack/lit-hotkeys`.
In `@examples/lit/hotkey/src/app.ts`:
- Around line 523-528: The hotkey decorator value and the displayed lastHotkey
are inconsistent in the _f4 handler: `@hotkey`('Meta+F4') registers Meta+F4 but
the handler sets this.lastHotkey = 'Alt+F4' (method _f4), causing UI confusion;
fix by making the two match—either change the decorator on _f4 to
`@hotkey`('Alt+F4') to match the UI and alert text, or update this.lastHotkey and
the alert text to 'Meta+F4' so they consistently reflect the registered hotkey.
In `@packages/lit-hotkeys/CHANGELOG.md`:
- Around line 1-111: The CHANGELOG.md currently has the wrong package header
"@tanstack/react-hotkeys" and mismatched entries for this package; update the
file (CHANGELOG.md) to target "lit-hotkeys" by replacing the title string and
regenerating or replacing the changelog content with the correct lit-hotkeys
release history, ensuring the top-level header reads "lit-hotkeys" (or the
package's exact name) and entries correspond to lit-hotkeys releases rather than
`@tanstack/react-hotkeys`.
In `@packages/lit-hotkeys/src/controllers/hotkey-sequence.ts`:
- Line 72: Remove the debug console.log call that prints 'optionsWithoutTarget'
in the HotkeySequence controller (the line referencing this.sequence and
optionsWithoutTarget); locate the statement in the hotkey-sequence.ts
implementation (inside the HotkeySequence class / relevant method where
this.sequence and optionsWithoutTarget are used) and delete that console.log so
no debug output remains in production.
In `@packages/lit-hotkeys/src/controllers/hotkey.ts`:
- Around line 47-74: HOTKEY_DEFAULT_OPTIONS must be made server-safe by removing
any module-scope reference to document (e.g., change the default target from
document to undefined or null in packages/lit-hotkeys/src/constants.ts) and keep
hostConnected() as the place that chooses document at runtime; then ensure
hostConnected() uses the existing runtime check ('target' in this.options ?
(this.options.target ?? null) : typeof document !== "undefined" ? document :
null) to lazily resolve to document only when typeof document !== "undefined" so
that HOTKEY_DEFAULT_OPTIONS, HotkeyOptions, and the hostConnected() logic no
longer import a browser global at module load (adjust HotkeyOptions type if
needed to allow undefined/null for options.target).
In `@packages/lit-hotkeys/src/index.ts`:
- Line 4: The comment "// React-specific exports" is stale and misleading for
this Lit-focused package; update that comment in
packages/lit-hotkeys/src/index.ts by replacing the exact string "//
React-specific exports" with a Lit-appropriate comment such as "// Lit-specific
exports" or "// Exports for Lit / LitElement consumers" so the comment
accurately reflects the package intent and exports.
In `@packages/lit-hotkeys/tsconfig.json`:
- Around line 2-4: The package tsconfig is missing experimental decorators which
breaks compilation of the legacy decorator syntax used by `@hotkey` and
`@hotkeySequence` (they use TypedPropertyDescriptor parameters); open the
packages/lit-hotkeys tsconfig (the object containing
"extends"/"include"/"exclude") and add "experimentalDecorators": true under
compilerOptions so TypeScript accepts legacy decorators; ensure the
compilerOptions section exists (create it if needed) and keep other options
intact.
In `@packages/lit-hotkeys/vitest.config.ts`:
- Around line 2-6: The vitest config incorrectly imports and applies the React
Vite plugin; remove the import statement "import react from
'@vitejs/plugin-react'" and remove the react() entry from the plugins array in
the default export (the plugins field in the defineConfig block) so the Lit
package's tests do not load React-specific tooling; if a Lit-specific Vite
plugin is required, add that instead, otherwise leave plugins empty or only
include plugins actually declared in this package.json.
---
Nitpick comments:
In `@examples/lit/hotkey-sequence/package.json`:
- Line 14: Update the dependency entry for "@tanstack/lit-hotkeys" in the
example's package.json to use the workspace protocol so it consumes the local
package instead of the published npm version; replace the version string
"^0.4.0" with a workspace spec such as "workspace:*" (or "workspace:^" if you
want caret behavior) to ensure the example dogfoods the local package.
In `@examples/lit/hotkey-sequence/src/index.css`:
- Around line 137-149: Add explicit keyboard focus styling for the existing
button rules: implement a focus-visible style for the button selector (e.g.,
target button:focus-visible) that provides a clear outline or box-shadow and
visible contrast (and optionally include a fallback button:focus for browsers
without focus-visible) so keyboard users see focused state consistent with the
hover state; update the rules near the existing button and button:hover
selectors to include these focus styles while keeping current colors and rounded
corners.
- Around line 93-97: The .hint rule in
examples/lit/hotkey-sequence/src/index.css uses a low-contrast color (`#888`) that
reduces readability at small sizes; update the .hint CSS rule to use a darker
color (for example `#666` or `#444`) to improve contrast while keeping font-size and
font-style the same so layout is unaffected.
In `@examples/lit/hotkey/src/app.ts`:
- Around line 410-420: The _handleSaving handler is defined as an arrow function
property which may not appear on the prototype for the hotkey decorator to
inspect (descriptor?.value can be undefined); convert _handleSaving into a
normal class method (e.g., private _handleSaving(event: KeyboardEvent, ctx:
HotkeyCallbackContext) { ... }) so the decorator can access it via the
descriptor, and update any usages that relied on lexical binding (if necessary
bind in constructor or use the decorator fallback). Ensure consistency with
other handlers by making them methods too so the decorator's descriptor-based
logic works uniformly.
In `@packages/lit-hotkeys/src/controllers/hotkey-sequence.ts`:
- Around line 48-78: The current logic in hostConnected relies on this.options
but the constructor used options = HOTKEY_SEQUENCE_DEFAULT_OPTIONS which
overwrites defaults; instead merge user options with
HOTKEY_SEQUENCE_DEFAULT_OPTIONS so missing defaults remain (use something like
mergedOptions = { ...HOTKEY_SEQUENCE_DEFAULT_OPTIONS, ...this.options }), then
use mergedOptions when extracting enabled/target and when passing options to
manager.register; update references in hostConnected (replace uses of
this.options with mergedOptions) and ensure target resolution and
optionsWithoutTarget are derived from the merged object.
In `@packages/lit-hotkeys/src/decorators/hotkey-sequence.ts`:
- Around line 34-37: The decorator's inner function currently requires
descriptor but should accept an optional descriptor to match `@hotkey` and support
arrow-function class fields; change the signature in the returned function to
accept descriptor?: TypedPropertyDescriptor<T> | undefined (or descriptor:
TypedPropertyDescriptor<T> | undefined) and then update any code that
reads/writes descriptor.value or descriptor.initializer to safely handle
descriptor being undefined (create/assign a proper descriptor when decorating a
class field or use proto[methodName] fallback). Ensure the returned function
(the decorator in hotkey-sequence.ts) mirrors the optional descriptor handling
used in hotkey.ts so both method and field/arrow-function decorations work
consistently.
In `@packages/lit-hotkeys/src/decorators/hotkey.ts`:
- Around line 29-32: The hotkey function currently replaces
HOTKEY_DEFAULT_OPTIONS when callers pass partial HotkeyOptions; update the
function to merge defaults with provided options so missing keys keep defaults
(e.g., combine HOTKEY_DEFAULT_OPTIONS and the incoming options before using
them). Locate the hotkey function and ensure you merge HOTKEY_DEFAULT_OPTIONS
with the parameter named options (or set a mergedOptions local variable) so
flags like preventDefault remain true unless explicitly overridden; keep the
parameter type HotkeyOptions and use the merged result throughout the function.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1535cb6b-4154-4a0a-8ada-e423d6cf8f8a
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (31)
examples/lit/hotkey-sequence/.gitignoreexamples/lit/hotkey-sequence/index.htmlexamples/lit/hotkey-sequence/package.jsonexamples/lit/hotkey-sequence/src/app.tsexamples/lit/hotkey-sequence/src/index.cssexamples/lit/hotkey-sequence/tsconfig.jsonexamples/lit/hotkey/index.htmlexamples/lit/hotkey/package.jsonexamples/lit/hotkey/src/app.tsexamples/lit/hotkey/src/index.cssexamples/lit/hotkey/tsconfig.jsonpackage.jsonpackages/lit-hotkeys/CHANGELOG.mdpackages/lit-hotkeys/README.mdpackages/lit-hotkeys/eslint.config.jspackages/lit-hotkeys/package.jsonpackages/lit-hotkeys/src/constants.tspackages/lit-hotkeys/src/controllers/held-keys.tspackages/lit-hotkeys/src/controllers/hotkey-sequence.tspackages/lit-hotkeys/src/controllers/hotkey.tspackages/lit-hotkeys/src/controllers/index.tspackages/lit-hotkeys/src/controllers/key-hold.tspackages/lit-hotkeys/src/decorators/hotkey-sequence.tspackages/lit-hotkeys/src/decorators/hotkey.tspackages/lit-hotkeys/src/decorators/index.tspackages/lit-hotkeys/src/index.tspackages/lit-hotkeys/tests/useHotkey.test.tsxpackages/lit-hotkeys/tsconfig.docs.jsonpackages/lit-hotkeys/tsconfig.jsonpackages/lit-hotkeys/tsdown.config.tspackages/lit-hotkeys/vitest.config.ts
| "dependencies": { | ||
| "@tanstack/lit-hotkeys": "^0.4.0", | ||
| "lit": "^3.3.1" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "All `@tanstack` dependency pins in examples:"
rg -nP '"@tanstack/[^"]+"\s*:\s*"[^"]+"' examples -g '**/package.json'
echo
echo "Lit example manifests specifically:"
for f in examples/lit/hotkey/package.json examples/lit/hotkey-sequence/package.json; do
echo "---- $f"
rg -nP '"@tanstack/lit-hotkeys"\s*:\s*"[^"]+"' "$f" || true
doneRepository: TanStack/hotkeys
Length of output: 7199
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== Root package.json workspaces definition ==="
cat -n package.json | head -30
echo
echo "=== Check for workspace: protocol usage in examples ==="
rg -n 'workspace:\*' examples -g '**/package.json' || echo "No workspace:* found in examples"
echo
echo "=== Check root monorepo structure ==="
ls -la | grep -E 'package|npm|yarn'
echo
echo "=== Check for pnpm-workspace.yaml ==="
test -f pnpm-workspace.yaml && cat pnpm-workspace.yaml || echo "No pnpm-workspace.yaml"
echo
echo "=== Check for lerna.json ==="
test -f lerna.json && cat lerna.json || echo "No lerna.json"Repository: TanStack/hotkeys
Length of output: 3154
Use workspace dependency protocol for the internal package in this example.
Both lit examples use ^0.4.0, which is also an older version than other framework examples (^0.4.1). In this pnpm monorepo with preferWorkspacePackages: true configured, dependencies should explicitly use the workspace:* protocol to guarantee local package resolution.
🔧 Proposed fix
"dependencies": {
- "@tanstack/lit-hotkeys": "^0.4.0",
+ "@tanstack/lit-hotkeys": "workspace:*",
"lit": "^3.3.1"
},Apply the same fix to examples/lit/hotkey-sequence/package.json.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "dependencies": { | |
| "@tanstack/lit-hotkeys": "^0.4.0", | |
| "lit": "^3.3.1" | |
| "dependencies": { | |
| "@tanstack/lit-hotkeys": "workspace:*", | |
| "lit": "^3.3.1" |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/lit/hotkey/package.json` around lines 13 - 15, Replace the external
semver for the internal package `@tanstack/lit-hotkeys` in the example
package.json (currently "^0.4.0") with the workspace protocol "workspace:*" so
pnpm resolves the local package; make the same change for the other lit
example's package.json (the hotkey-sequence example) to ensure both use
"workspace:*" for `@tanstack/lit-hotkeys`.
| @hotkey('Meta+F4') | ||
| private _f4 = () => { | ||
| this.lastHotkey = 'Alt+F4' | ||
| this.functionKeyCount++ | ||
| alert('Alt+F4 pressed (normally closes window)') | ||
| } |
There was a problem hiding this comment.
Mismatch between decorator key and lastHotkey assignment.
Line 523 uses @hotkey('Meta+F4') but line 525 sets this.lastHotkey = 'Alt+F4'. The UI at line 181 displays "Alt+F4" but the actual hotkey registered is Meta+F4. This inconsistency could confuse users.
🐛 Proposed fix
- `@hotkey`('Meta+F4')
+ `@hotkey`('Alt+F4')
private _f4 = () => {
this.lastHotkey = 'Alt+F4'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @hotkey('Meta+F4') | |
| private _f4 = () => { | |
| this.lastHotkey = 'Alt+F4' | |
| this.functionKeyCount++ | |
| alert('Alt+F4 pressed (normally closes window)') | |
| } | |
| `@hotkey`('Alt+F4') | |
| private _f4 = () => { | |
| this.lastHotkey = 'Alt+F4' | |
| this.functionKeyCount++ | |
| alert('Alt+F4 pressed (normally closes window)') | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/lit/hotkey/src/app.ts` around lines 523 - 528, The hotkey decorator
value and the displayed lastHotkey are inconsistent in the _f4 handler:
`@hotkey`('Meta+F4') registers Meta+F4 but the handler sets this.lastHotkey =
'Alt+F4' (method _f4), causing UI confusion; fix by making the two match—either
change the decorator on _f4 to `@hotkey`('Alt+F4') to match the UI and alert text,
or update this.lastHotkey and the alert text to 'Meta+F4' so they consistently
reflect the registered hotkey.
| # @tanstack/react-hotkeys | ||
|
|
||
| ## 0.4.0 | ||
|
|
||
| ### Minor Changes | ||
|
|
||
| - add angular adapter and upgrade packages ([#31](https://github.com/TanStack/hotkeys/pull/31)) | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`c173ed0`](https://github.com/TanStack/hotkeys/commit/c173ed079c6b0f282c9cf8dcb6d9523408eca5a0)]: | ||
| - @tanstack/hotkeys@0.4.0 | ||
|
|
||
| ## 0.3.3 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`029f473`](https://github.com/TanStack/hotkeys/commit/029f4733e5e7ed8739cf17125d327c626e4bb1d0)]: | ||
| - @tanstack/hotkeys@0.3.3 | ||
|
|
||
| ## 0.3.2 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`67decce`](https://github.com/TanStack/hotkeys/commit/67decced89ce5dc874c5559fefb46096e76e560b)]: | ||
| - @tanstack/hotkeys@0.3.2 | ||
|
|
||
| ## 0.3.1 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`762cabf`](https://github.com/TanStack/hotkeys/commit/762cabfd6e765f6ced1efdacbbf296ead0a5a080)]: | ||
| - @tanstack/hotkeys@0.3.1 | ||
|
|
||
| ## 0.3.0 | ||
|
|
||
| ### Minor Changes | ||
|
|
||
| - feat: overhaul sequence-manager and hooks to be in feature parity with hotkey-manager. ([#21](https://github.com/TanStack/hotkeys/pull/21)) | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`7328e36`](https://github.com/TanStack/hotkeys/commit/7328e360f0e99b5374fb97c07e0f2a500d8e5b9c)]: | ||
| - @tanstack/hotkeys@0.3.0 | ||
|
|
||
| ## 0.2.0 | ||
|
|
||
| ### Minor Changes | ||
|
|
||
| - feat: upgrade tanstack store version ([#35](https://github.com/TanStack/hotkeys/pull/35)) | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`8ae6b64`](https://github.com/TanStack/hotkeys/commit/8ae6b64ef10b53186c367f594f81ecdec15071d7)]: | ||
| - @tanstack/hotkeys@0.2.0 | ||
|
|
||
| ## 0.1.3 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`26a74d8`](https://github.com/TanStack/hotkeys/commit/26a74d8e3279766a5cddbc7e7f146af0557cfbb9)]: | ||
| - @tanstack/hotkeys@0.1.3 | ||
|
|
||
| ## 0.1.2 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`54f550f`](https://github.com/TanStack/hotkeys/commit/54f550f1d2e47084ea11411d465780ede19fbdfa)]: | ||
| - @tanstack/hotkeys@0.1.2 | ||
|
|
||
| ## 0.1.1 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`56d50ba`](https://github.com/TanStack/hotkeys/commit/56d50ba4595a7609b13a36376afdc46ba92fab29)]: | ||
| - @tanstack/hotkeys@0.1.1 | ||
|
|
||
| ## 0.1.0 | ||
|
|
||
| ### Minor Changes | ||
|
|
||
| - feat: smarter ignoreInputs default ([#10](https://github.com/TanStack/hotkeys/pull/10)) | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - Updated dependencies [[`8d4ad42`](https://github.com/TanStack/hotkeys/commit/8d4ad423b9c6de4f406505b08e7547a9112ceb41)]: | ||
| - @tanstack/hotkeys@0.1.0 | ||
|
|
||
| ## 0.0.3 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - fix: rerun register when options.enabled is changed ([`3ada864`](https://github.com/TanStack/hotkeys/commit/3ada864e07d6a6fe46dd95162592b29e681f52d1)) | ||
|
|
||
| ## 0.0.2 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - feat: initial release ([`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)) | ||
|
|
||
| - Updated dependencies [[`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)]: | ||
| - @tanstack/hotkeys@0.0.2 | ||
|
|
||
| ## 0.0.1 | ||
|
|
||
| ### Patch Changes | ||
|
|
||
| - feat: TanStack Hotkeys ([#5](https://github.com/TanStack/hotkeys/pull/5)) | ||
|
|
||
| - Updated dependencies [[`e16b529`](https://github.com/TanStack/hotkeys/commit/e16b52983d4bf4ba249668591e8fc7133fcf8b85)]: | ||
| - @tanstack/hotkeys@0.0.1 |
There was a problem hiding this comment.
This changelog appears to target the wrong package and should be regenerated.
On Line 1, the title is @tanstack/react-hotkeys while this file is for packages/lit-hotkeys. The entries also look mismatched for lit-hotkeys history. Please regenerate or replace with the correct lit-hotkeys changelog content before release.
🔧 Minimal immediate fix for the header
-# `@tanstack/react-hotkeys`
+# `@tanstack/lit-hotkeys`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # @tanstack/react-hotkeys | |
| ## 0.4.0 | |
| ### Minor Changes | |
| - add angular adapter and upgrade packages ([#31](https://github.com/TanStack/hotkeys/pull/31)) | |
| ### Patch Changes | |
| - Updated dependencies [[`c173ed0`](https://github.com/TanStack/hotkeys/commit/c173ed079c6b0f282c9cf8dcb6d9523408eca5a0)]: | |
| - @tanstack/hotkeys@0.4.0 | |
| ## 0.3.3 | |
| ### Patch Changes | |
| - Updated dependencies [[`029f473`](https://github.com/TanStack/hotkeys/commit/029f4733e5e7ed8739cf17125d327c626e4bb1d0)]: | |
| - @tanstack/hotkeys@0.3.3 | |
| ## 0.3.2 | |
| ### Patch Changes | |
| - Updated dependencies [[`67decce`](https://github.com/TanStack/hotkeys/commit/67decced89ce5dc874c5559fefb46096e76e560b)]: | |
| - @tanstack/hotkeys@0.3.2 | |
| ## 0.3.1 | |
| ### Patch Changes | |
| - Updated dependencies [[`762cabf`](https://github.com/TanStack/hotkeys/commit/762cabfd6e765f6ced1efdacbbf296ead0a5a080)]: | |
| - @tanstack/hotkeys@0.3.1 | |
| ## 0.3.0 | |
| ### Minor Changes | |
| - feat: overhaul sequence-manager and hooks to be in feature parity with hotkey-manager. ([#21](https://github.com/TanStack/hotkeys/pull/21)) | |
| ### Patch Changes | |
| - Updated dependencies [[`7328e36`](https://github.com/TanStack/hotkeys/commit/7328e360f0e99b5374fb97c07e0f2a500d8e5b9c)]: | |
| - @tanstack/hotkeys@0.3.0 | |
| ## 0.2.0 | |
| ### Minor Changes | |
| - feat: upgrade tanstack store version ([#35](https://github.com/TanStack/hotkeys/pull/35)) | |
| ### Patch Changes | |
| - Updated dependencies [[`8ae6b64`](https://github.com/TanStack/hotkeys/commit/8ae6b64ef10b53186c367f594f81ecdec15071d7)]: | |
| - @tanstack/hotkeys@0.2.0 | |
| ## 0.1.3 | |
| ### Patch Changes | |
| - Updated dependencies [[`26a74d8`](https://github.com/TanStack/hotkeys/commit/26a74d8e3279766a5cddbc7e7f146af0557cfbb9)]: | |
| - @tanstack/hotkeys@0.1.3 | |
| ## 0.1.2 | |
| ### Patch Changes | |
| - Updated dependencies [[`54f550f`](https://github.com/TanStack/hotkeys/commit/54f550f1d2e47084ea11411d465780ede19fbdfa)]: | |
| - @tanstack/hotkeys@0.1.2 | |
| ## 0.1.1 | |
| ### Patch Changes | |
| - Updated dependencies [[`56d50ba`](https://github.com/TanStack/hotkeys/commit/56d50ba4595a7609b13a36376afdc46ba92fab29)]: | |
| - @tanstack/hotkeys@0.1.1 | |
| ## 0.1.0 | |
| ### Minor Changes | |
| - feat: smarter ignoreInputs default ([#10](https://github.com/TanStack/hotkeys/pull/10)) | |
| ### Patch Changes | |
| - Updated dependencies [[`8d4ad42`](https://github.com/TanStack/hotkeys/commit/8d4ad423b9c6de4f406505b08e7547a9112ceb41)]: | |
| - @tanstack/hotkeys@0.1.0 | |
| ## 0.0.3 | |
| ### Patch Changes | |
| - fix: rerun register when options.enabled is changed ([`3ada864`](https://github.com/TanStack/hotkeys/commit/3ada864e07d6a6fe46dd95162592b29e681f52d1)) | |
| ## 0.0.2 | |
| ### Patch Changes | |
| - feat: initial release ([`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)) | |
| - Updated dependencies [[`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)]: | |
| - @tanstack/hotkeys@0.0.2 | |
| ## 0.0.1 | |
| ### Patch Changes | |
| - feat: TanStack Hotkeys ([#5](https://github.com/TanStack/hotkeys/pull/5)) | |
| - Updated dependencies [[`e16b529`](https://github.com/TanStack/hotkeys/commit/e16b52983d4bf4ba249668591e8fc7133fcf8b85)]: | |
| - @tanstack/hotkeys@0.0.1 | |
| # `@tanstack/lit-hotkeys` | |
| ## 0.4.0 | |
| ### Minor Changes | |
| - add angular adapter and upgrade packages ([`#31`](https://github.com/TanStack/hotkeys/pull/31)) | |
| ### Patch Changes | |
| - Updated dependencies [[`c173ed0`](https://github.com/TanStack/hotkeys/commit/c173ed079c6b0f282c9cf8dcb6d9523408eca5a0)]: | |
| - `@tanstack/hotkeys`@0.4.0 | |
| ## 0.3.3 | |
| ### Patch Changes | |
| - Updated dependencies [[`029f473`](https://github.com/TanStack/hotkeys/commit/029f4733e5e7ed8739cf17125d327c626e4bb1d0)]: | |
| - `@tanstack/hotkeys`@0.3.3 | |
| ## 0.3.2 | |
| ### Patch Changes | |
| - Updated dependencies [[`67decce`](https://github.com/TanStack/hotkeys/commit/67decced89ce5dc874c5559fefb46096e76e560b)]: | |
| - `@tanstack/hotkeys`@0.3.2 | |
| ## 0.3.1 | |
| ### Patch Changes | |
| - Updated dependencies [[`762cabf`](https://github.com/TanStack/hotkeys/commit/762cabfd6e765f6ced1efdacbbf296ead0a5a080)]: | |
| - `@tanstack/hotkeys`@0.3.1 | |
| ## 0.3.0 | |
| ### Minor Changes | |
| - feat: overhaul sequence-manager and hooks to be in feature parity with hotkey-manager. ([`#21`](https://github.com/TanStack/hotkeys/pull/21)) | |
| ### Patch Changes | |
| - Updated dependencies [[`7328e36`](https://github.com/TanStack/hotkeys/commit/7328e360f0e99b5374fb97c07e0f2a500d8e5b9c)]: | |
| - `@tanstack/hotkeys`@0.3.0 | |
| ## 0.2.0 | |
| ### Minor Changes | |
| - feat: upgrade tanstack store version ([`#35`](https://github.com/TanStack/hotkeys/pull/35)) | |
| ### Patch Changes | |
| - Updated dependencies [[`8ae6b64`](https://github.com/TanStack/hotkeys/commit/8ae6b64ef10b53186c367f594f81ecdec15071d7)]: | |
| - `@tanstack/hotkeys`@0.2.0 | |
| ## 0.1.3 | |
| ### Patch Changes | |
| - Updated dependencies [[`26a74d8`](https://github.com/TanStack/hotkeys/commit/26a74d8e3279766a5cddbc7e7f146af0557cfbb9)]: | |
| - `@tanstack/hotkeys`@0.1.3 | |
| ## 0.1.2 | |
| ### Patch Changes | |
| - Updated dependencies [[`54f550f`](https://github.com/TanStack/hotkeys/commit/54f550f1d2e47084ea11411d465780ede19fbdfa)]: | |
| - `@tanstack/hotkeys`@0.1.2 | |
| ## 0.1.1 | |
| ### Patch Changes | |
| - Updated dependencies [[`56d50ba`](https://github.com/TanStack/hotkeys/commit/56d50ba4595a7609b13a36376afdc46ba92fab29)]: | |
| - `@tanstack/hotkeys`@0.1.1 | |
| ## 0.1.0 | |
| ### Minor Changes | |
| - feat: smarter ignoreInputs default ([`#10`](https://github.com/TanStack/hotkeys/pull/10)) | |
| ### Patch Changes | |
| - Updated dependencies [[`8d4ad42`](https://github.com/TanStack/hotkeys/commit/8d4ad423b9c6de4f406505b08e7547a9112ceb41)]: | |
| - `@tanstack/hotkeys`@0.1.0 | |
| ## 0.0.3 | |
| ### Patch Changes | |
| - fix: rerun register when options.enabled is changed ([`3ada864`](https://github.com/TanStack/hotkeys/commit/3ada864e07d6a6fe46dd95162592b29e681f52d1)) | |
| ## 0.0.2 | |
| ### Patch Changes | |
| - feat: initial release ([`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)) | |
| - Updated dependencies [[`341d167`](https://github.com/TanStack/hotkeys/commit/341d16731f09709a463343852ae4c0e1b6bc6613)]: | |
| - `@tanstack/hotkeys`@0.0.2 | |
| ## 0.0.1 | |
| ### Patch Changes | |
| - feat: TanStack Hotkeys ([`#5`](https://github.com/TanStack/hotkeys/pull/5)) | |
| - Updated dependencies [[`e16b529`](https://github.com/TanStack/hotkeys/commit/e16b52983d4bf4ba249668591e8fc7133fcf8b85)]: | |
| - `@tanstack/hotkeys`@0.0.1 |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/CHANGELOG.md` around lines 1 - 111, The CHANGELOG.md
currently has the wrong package header "@tanstack/react-hotkeys" and mismatched
entries for this package; update the file (CHANGELOG.md) to target "lit-hotkeys"
by replacing the title string and regenerating or replacing the changelog
content with the correct lit-hotkeys release history, ensuring the top-level
header reads "lit-hotkeys" (or the package's exact name) and entries correspond
to lit-hotkeys releases rather than `@tanstack/react-hotkeys`.
| this.host as unknown as object, | ||
| ) | ||
|
|
||
| console.log('optionsWithoutTarget', this.sequence, optionsWithoutTarget) |
There was a problem hiding this comment.
Remove debug console.log statement.
This appears to be a debug artifact that should be removed before merging.
🧹 Proposed fix
- console.log('optionsWithoutTarget', this.sequence, optionsWithoutTarget)
-
this._registration = manager.register(this.sequence, boundCallback, {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| console.log('optionsWithoutTarget', this.sequence, optionsWithoutTarget) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/src/controllers/hotkey-sequence.ts` at line 72, Remove
the debug console.log call that prints 'optionsWithoutTarget' in the
HotkeySequence controller (the line referencing this.sequence and
optionsWithoutTarget); locate the statement in the hotkey-sequence.ts
implementation (inside the HotkeySequence class / relevant method where
this.sequence and optionsWithoutTarget are used) and delete that console.log so
no debug output remains in production.
| private options: HotkeyOptions = HOTKEY_DEFAULT_OPTIONS, | ||
| ) {} | ||
|
|
||
| /** | ||
| * Registers the hotkey with the global manager when the host is connected to the DOM. | ||
| * Skips registration if no target is available (e.g. no document or options.target is null). | ||
| */ | ||
| hostConnected(): void { | ||
| const manager: HotkeyManager = getHotkeyManager() | ||
|
|
||
| const platform = this.options.platform ?? detectPlatform() | ||
| const hotkeyString: Hotkey = | ||
| typeof this.hotkey === 'string' | ||
| ? this.hotkey | ||
| : (formatHotkey( | ||
| rawHotkeyToParsedHotkey(this.hotkey, platform), | ||
| ) as Hotkey) | ||
|
|
||
| const resolvedTarget = | ||
| 'target' in this.options | ||
| ? (this.options.target ?? null) | ||
| : typeof document !== 'undefined' | ||
| ? document | ||
| : null | ||
|
|
||
| if (!resolvedTarget) { | ||
| return | ||
| } |
There was a problem hiding this comment.
Resolve the default target lazily to keep SSR imports from crashing.
Line 47 defaults to HOTKEY_DEFAULT_OPTIONS, and packages/lit-hotkeys/src/constants.ts:3-13 currently defines target: document at module scope. On the server, importing this controller will throw before Lines 68-70 reach the typeof document guard. Keep the shared defaults free of browser globals and choose document inside hostConnected() only when it actually exists.
🐛 Proposed fix
Update packages/lit-hotkeys/src/constants.ts so the shared defaults stay server-safe:
export const HOTKEY_DEFAULT_OPTIONS: HotkeyOptions = {
enabled: true,
preventDefault: true,
stopPropagation: true,
eventType: 'keydown',
requireReset: false,
ignoreInputs: undefined,
- target: document,
+ target: undefined,
platform: undefined,
conflictBehavior: 'warn',
}Then resolve the fallback target lazily in this file:
- const resolvedTarget =
- 'target' in this.options
- ? (this.options.target ?? null)
- : typeof document !== 'undefined'
- ? document
- : null
+ const resolvedTarget =
+ this.options.target !== undefined
+ ? this.options.target
+ : typeof document !== 'undefined'
+ ? document
+ : null🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/src/controllers/hotkey.ts` around lines 47 - 74,
HOTKEY_DEFAULT_OPTIONS must be made server-safe by removing any module-scope
reference to document (e.g., change the default target from document to
undefined or null in packages/lit-hotkeys/src/constants.ts) and keep
hostConnected() as the place that chooses document at runtime; then ensure
hostConnected() uses the existing runtime check ('target' in this.options ?
(this.options.target ?? null) : typeof document !== "undefined" ? document :
null) to lazily resolve to document only when typeof document !== "undefined" so
that HOTKEY_DEFAULT_OPTIONS, HotkeyOptions, and the hostConnected() logic no
longer import a browser global at module load (adjust HotkeyOptions type if
needed to allow undefined/null for options.target).
| // Re-export everything from the core package | ||
| export * from '@tanstack/hotkeys' | ||
|
|
||
| // React-specific exports |
There was a problem hiding this comment.
Fix stale adapter comment (“React-specific exports”).
This package is Lit-focused; the current comment is misleading.
Suggested patch
-// React-specific exports
+// Lit-specific exports
export * from './decorators'
export * from './controllers'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // React-specific exports | |
| // Lit-specific exports | |
| export * from './decorators' | |
| export * from './controllers' |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/src/index.ts` at line 4, The comment "// React-specific
exports" is stale and misleading for this Lit-focused package; update that
comment in packages/lit-hotkeys/src/index.ts by replacing the exact string "//
React-specific exports" with a Lit-appropriate comment such as "// Lit-specific
exports" or "// Exports for Lit / LitElement consumers" so the comment
accurately reflects the package intent and exports.
| import { renderHook, act } from '@testing-library/react' | ||
| import { HotkeyManager } from '@tanstack/hotkeys' | ||
| import { useHotkey } from '../src/useHotkey' | ||
| import { useState, useRef } from 'react' |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
fd '^useHotkey\.(ts|tsx)$' packages/lit-hotkeys/src || true
rg -n --glob 'packages/lit-hotkeys/tests/**' "@testing-library/react|renderHook|from \"react\"|from 'react'" || trueRepository: TanStack/hotkeys
Length of output: 1099
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# List contents of lit-hotkeys src directory
echo "=== Lit package source structure ==="
find packages/lit-hotkeys/src -type f -name "*.ts" -o -name "*.tsx" 2>/dev/null | head -20
echo ""
echo "=== All test files in lit-hotkeys tests ==="
find packages/lit-hotkeys/tests -type f -name "*.test.*" -o -name "*.spec.*" 2>/dev/null
echo ""
echo "=== Contents of lit-hotkeys package.json ==="
cat packages/lit-hotkeys/package.json | grep -A 20 '"dependencies"\|"devDependencies"\|"peerDependencies"' | head -30Repository: TanStack/hotkeys
Length of output: 901
Replace this test file with Lit controller and decorator integration tests.
The test file imports and uses React testing utilities (@testing-library/react, renderHook, useState, useRef) to test a non-existent useHotkey hook, but packages/lit-hotkeys/src/ only contains Lit controllers and decorators (hotkey.ts, hotkey-sequence.ts, key-hold.ts, held-keys.ts). The test is fundamentally misaligned with the package purpose and will fail on import. Write tests for the actual Lit surface instead.
🧰 Tools
🪛 ESLint
[error] 3-3: Member 'act' of the import declaration should be sorted alphabetically.
(sort-imports)
[error] 6-6: react import should occur before import of ../src/useHotkey
(import/order)
[error] 6-6: Member 'useRef' of the import declaration should be sorted alphabetically.
(sort-imports)
| "extends": "../../tsconfig.json", | ||
| "include": ["src", "vitest.config.ts", "tests"], | ||
| "exclude": ["eslint.config.js"] |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Confirm decorator compiler flag presence/absence
echo "Checking decorator compiler flags..."
rg -nP '"experimentalDecorators"\s*:' tsconfig.json packages/lit-hotkeys/tsconfig.json || true
# 2) Find legacy decorator typing patterns in lit-hotkeys sources
echo "Searching for legacy decorator signatures..."
rg -nP --type=ts 'TypedPropertyDescriptor|MethodDecorator|PropertyDecorator|ClassDecorator' packages/lit-hotkeys/src || true
# 3) Find decorator usage sites
echo "Searching for decorator usage..."
rg -nP --type=ts '^\s*@\w+' packages/lit-hotkeys/src || trueRepository: TanStack/hotkeys
Length of output: 370
🏁 Script executed:
# Check root tsconfig for experimentalDecorators
cat tsconfig.json | head -20
# Inspect the decorator implementations
echo "=== hotkey.ts ==="
cat packages/lit-hotkeys/src/decorators/hotkey.ts
echo ""
echo "=== hotkey-sequence.ts ==="
cat packages/lit-hotkeys/src/decorators/hotkey-sequence.tsRepository: TanStack/hotkeys
Length of output: 4992
🏁 Script executed:
# Get full root tsconfig
cat tsconfig.json
# Also check the package tsconfig
echo ""
echo "=== packages/lit-hotkeys/tsconfig.json ==="
cat packages/lit-hotkeys/tsconfig.jsonRepository: TanStack/hotkeys
Length of output: 1041
Enable legacy decorators in this package tsconfig.
This package uses legacy decorator syntax (@hotkey, @hotkeySequence) with TypedPropertyDescriptor parameters in the decorator implementations. Without experimentalDecorators: true, TypeScript will fail to compile or type-check these decorators. Add it under compilerOptions.
🔧 Proposed fix
{
"extends": "../../tsconfig.json",
+ "compilerOptions": {
+ "experimentalDecorators": true
+ },
"include": ["src", "vitest.config.ts", "tests"],
"exclude": ["eslint.config.js"]
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "extends": "../../tsconfig.json", | |
| "include": ["src", "vitest.config.ts", "tests"], | |
| "exclude": ["eslint.config.js"] | |
| { | |
| "extends": "../../tsconfig.json", | |
| "compilerOptions": { | |
| "experimentalDecorators": true | |
| }, | |
| "include": ["src", "vitest.config.ts", "tests"], | |
| "exclude": ["eslint.config.js"] | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/tsconfig.json` around lines 2 - 4, The package tsconfig
is missing experimental decorators which breaks compilation of the legacy
decorator syntax used by `@hotkey` and `@hotkeySequence` (they use
TypedPropertyDescriptor parameters); open the packages/lit-hotkeys tsconfig (the
object containing "extends"/"include"/"exclude") and add
"experimentalDecorators": true under compilerOptions so TypeScript accepts
legacy decorators; ensure the compilerOptions section exists (create it if
needed) and keep other options intact.
| import react from '@vitejs/plugin-react' | ||
| import packageJson from './package.json' with { type: 'json' } | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [react()], |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check if packages/lit-hotkeys exists and examine package.json
cd packages/lit-hotkeys 2>/dev/null && ls -la || echo "Directory check"
# Look at the package.json
fd "package.json" packages/lit-hotkeys -x cat {}Repository: TanStack/hotkeys
Length of output: 928
🏁 Script executed:
# Check vitest.config.ts in lit-hotkeys
fd "vitest.config.ts" packages/lit-hotkeys -x cat -n {}Repository: TanStack/hotkeys
Length of output: 545
🏁 Script executed:
# Check if `@vitejs/plugin-react` is referenced anywhere in lit-hotkeys package
rg "@vitejs/plugin-react" packages/lit-hotkeys/Repository: TanStack/hotkeys
Length of output: 138
🏁 Script executed:
# Check the main package.json for lit-hotkeys dependencies and devDependencies
rg "\"(dependencies|devDependencies)\"" packages/lit-hotkeys/package.json -A 20Repository: TanStack/hotkeys
Length of output: 261
🏁 Script executed:
cat packages/lit-hotkeys/README.mdRepository: TanStack/hotkeys
Length of output: 5962
🏁 Script executed:
# Also check if there are any .tsx or .jsx files in the lit-hotkeys source
fd "\.(tsx?|jsx?)$" packages/lit-hotkeys/src -type fRepository: TanStack/hotkeys
Length of output: 230
🏁 Script executed:
# Check what's in the src directory
ls -la packages/lit-hotkeys/src/Repository: TanStack/hotkeys
Length of output: 405
Remove the React Vite plugin from this Lit package's test configuration.
The vitest config imports and uses @vitejs/plugin-react (lines 2, 6), but @vitejs/plugin-react is not declared in packages/lit-hotkeys/package.json. This package is the Lit framework adapter for TanStack Hotkeys and declares lit as a peer and dev dependency—not React. The React plugin should not be applied to the Lit test harness.
♻️ Proposed fix
import { defineConfig } from 'vitest/config'
-import react from '@vitejs/plugin-react'
import packageJson from './package.json' with { type: 'json' }
export default defineConfig({
- plugins: [react()],
test: {
name: packageJson.name,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| import react from '@vitejs/plugin-react' | |
| import packageJson from './package.json' with { type: 'json' } | |
| export default defineConfig({ | |
| plugins: [react()], | |
| import packageJson from './package.json' with { type: 'json' } | |
| export default defineConfig({ |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/lit-hotkeys/vitest.config.ts` around lines 2 - 6, The vitest config
incorrectly imports and applies the React Vite plugin; remove the import
statement "import react from '@vitejs/plugin-react'" and remove the react()
entry from the plugins array in the default export (the plugins field in the
defineConfig block) so the Lit package's tests do not load React-specific
tooling; if a Lit-specific Vite plugin is required, add that instead, otherwise
leave plugins empty or only include plugins actually declared in this
package.json.
2 participants
🎯 Changes
Add Lit Adapter for Hotkeys
✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit
New Features
@tanstack/lit-hotkeyspackage with Lit framework support for keyboard hotkey management.Examples
Documentation
Tests