@tanstack/alpine-hotkeys 0.11.0 → 0.11.2

package/dist/createAppHotkeys.js

@@ -1,9 +1,9 @@
 import { createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
 
-//#region src/createAppHotkeys.ts
+// src/createAppHotkeys.ts
 function requireStore(scope) {
 	const store = scope.appHotkeys();
-	if (!store) throw new Error("App hotkeys require provideAppHotkeys()");
+	if (!store) throw new Error("[hotkeys] App hotkeys require provideAppHotkeys()");
 	return store;
 }
 function createAppHotkeys(scope) {
@@ -29,5 +29,4 @@ function createCustomHotkeys(scope) {
 	};
 }
 
-//#endregion
 export { createAppHotkeyList, createAppHotkeys, createCustomHotkeys };

package/dist/createHeldKeyCodes.js

@@ -1,9 +1,8 @@
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/createHeldKeyCodes.ts
+// src/createHeldKeyCodes.ts
 function createHeldKeyCodes(scope) {
 	return scope.select(getKeyStateTracker().store, (state) => state.heldCodes);
 }
 
-//#endregion
 export { createHeldKeyCodes };

package/dist/createHeldKeys.js

@@ -1,9 +1,8 @@
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/createHeldKeys.ts
+// src/createHeldKeys.ts
 function createHeldKeys(scope) {
 	return scope.select(getKeyStateTracker().store, (state) => state.heldKeys);
 }
 
-//#endregion
 export { createHeldKeys };

package/dist/createHotkey.js

@@ -1,7 +1,7 @@
-import { read } from "./scope.js";
 import { createHotkeys } from "./createHotkeys.js";
+import { read } from "./scope.js";
 
-//#region src/createHotkey.ts
+// src/createHotkey.ts
 function createHotkey(scope, hotkey, callback, options = {}) {
 	createHotkeys(scope, () => [{
 		hotkey: read(hotkey),
@@ -10,5 +10,4 @@ function createHotkey(scope, hotkey, callback, options = {}) {
 	}]);
 }
 
-//#endregion
 export { createHotkey };

package/dist/createHotkeyHint.js

@@ -1,7 +1,7 @@
 import { read } from "./scope.js";
 import { getHotkeyManager, getKeyStateTracker, isAppHotkey, matchesHeldModifiers, resolveAppHotkey } from "@tanstack/hotkeys";
 
-//#region src/createHotkeyHint.ts
+// src/createHotkeyHint.ts
 function createHotkeyHint(scope, hotkey, options = {}) {
 	const manager = getHotkeyManager();
 	const registrations = scope.select(manager.registrations, (state) => state);
@@ -12,5 +12,4 @@ function createHotkeyHint(scope, hotkey, options = {}) {
 	});
 }
 
-//#endregion
 export { createHotkeyHint };

package/dist/createHotkeyRecorder.d.ts

@@ -1,7 +1,6 @@
-import { AlpineHotkeyRecorder, AlpineHotkeys } from "./types.js";
 import "./scope.js";
+import { AlpineHotkeyRecorder, AlpineHotkeys } from "./types.js";
 import { HotkeyChord, HotkeyChordRecorderOptions, HotkeyRecorderOptions, HotkeySequenceRecorderOptions } from "@tanstack/hotkeys";
-//#region src/createHotkeyRecorder.d.ts
 /**
  * Creates a recorder owned by a `createHotkeysScope` owner. It uses the
  * owner's `hotkeyRecorder` defaults, and options can follow Alpine state.
@@ -11,5 +10,4 @@ export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: Hotk
 export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: HotkeySequenceRecorderOptions): AlpineHotkeyRecorder;
 export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: () => HotkeySequenceRecorderOptions): AlpineHotkeyRecorder;
 export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: () => HotkeyChordRecorderOptions): AlpineHotkeyRecorder<HotkeyChord>;
-export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: () => HotkeyRecorderOptions): AlpineHotkeyRecorder;
-//#endregion
+export declare function createHotkeyRecorder(owner: AlpineHotkeys, options: () => HotkeyRecorderOptions): AlpineHotkeyRecorder;

package/dist/createHotkeyRecorder.js

@@ -2,7 +2,7 @@ import { read, scopeOf } from "./scope.js";
 import { HotkeyRecorder } from "@tanstack/hotkeys";
 import { withDefaults } from "@tanstack/hotkeys/adapter";
 
-//#region src/createHotkeyRecorder.ts
+// src/createHotkeyRecorder.ts
 function createHotkeyRecorder(owner, options) {
 	return createRecorder(scopeOf(owner), options);
 }
@@ -30,5 +30,4 @@ function createRecorder(scope, options) {
 	};
 }
 
-//#endregion
 export { createHotkeyRecorder, createRecorder };

package/dist/createHotkeyRegistrations.js

@@ -1,6 +1,6 @@
 import { getHotkeyManager, toHotkeyRegistrationView } from "@tanstack/hotkeys";
 
-//#region src/createHotkeyRegistrations.ts
+// src/createHotkeyRegistrations.ts
 function createHotkeyRegistrations(scope) {
 	const state = scope.select(getHotkeyManager().registrations, (value) => Array.from(value.values()).map(toHotkeyRegistrationView));
 	return { get hotkeys() {
@@ -8,5 +8,4 @@ function createHotkeyRegistrations(scope) {
 	} };
 }
 
-//#endregion
 export { createHotkeyRegistrations };

package/dist/createHotkeyScopesState.js

@@ -1,9 +1,8 @@
 import { getHotkeyManager } from "@tanstack/hotkeys";
 
-//#region src/createHotkeyScopesState.ts
+// src/createHotkeyScopesState.ts
 function createHotkeyScopesState(scope) {
 	return scope.select(getHotkeyManager().scopes, (state) => state);
 }
 
-//#endregion
 export { createHotkeyScopesState };

package/dist/createHotkeys.js

@@ -1,7 +1,7 @@
 import { read } from "./scope.js";
 import { createHotkeyBindings, prepareHotkeyDefinitions } from "@tanstack/hotkeys/adapter";
 
-//#region src/createHotkeys.ts
+// src/createHotkeys.ts
 function createHotkeys(scope, definitions, options = {}) {
 	scope.assertActive();
 	const bindings = createHotkeyBindings();
@@ -19,5 +19,4 @@ function createHotkeys(scope, definitions, options = {}) {
 	}
 }
 
-//#endregion
 export { createHotkeys };

package/dist/createHotkeysScope.d.ts

@@ -1,10 +1,8 @@
 import { AlpineHotkeys, DefaultHotkeysOptions, MaybeGetter } from "./types.js";
-//#region src/createHotkeysScope.d.ts
 /**
  * Owns Alpine effects and Store subscriptions, with optional shared defaults.
  * App hotkeys come from `provideAppHotkeys`. Call destroy from x-data's
  * destroy hook.
  */
 export declare function createHotkeysScope(defaultOptions?: MaybeGetter<DefaultHotkeysOptions>): AlpineHotkeys;
-//#endregion
 export type { AlpineHotkeys, DefaultHotkeysOptions, MaybeGetter };

package/dist/createHotkeysScope.js

@@ -1,15 +1,15 @@
-import { createScope, ownerScopes } from "./scope.js";
-import { createHotkeys } from "./createHotkeys.js";
-import { createHotkey } from "./createHotkey.js";
-import { createHeldKeys } from "./createHeldKeys.js";
+import { createAppHotkeyList, createAppHotkeys, createCustomHotkeys } from "./createAppHotkeys.js";
 import { createHeldKeyCodes } from "./createHeldKeyCodes.js";
-import { createKeyHold } from "./createKeyHold.js";
+import { createHeldKeys } from "./createHeldKeys.js";
+import { createHotkey } from "./createHotkey.js";
 import { createHotkeyHint } from "./createHotkeyHint.js";
 import { createHotkeyRegistrations } from "./createHotkeyRegistrations.js";
 import { createHotkeyScopesState } from "./createHotkeyScopesState.js";
-import { createAppHotkeyList, createAppHotkeys, createCustomHotkeys } from "./createAppHotkeys.js";
+import { createHotkeys } from "./createHotkeys.js";
+import { createKeyHold } from "./createKeyHold.js";
+import { createScope, ownerScopes } from "./scope.js";
 
-//#region src/createHotkeysScope.ts
+// src/createHotkeysScope.ts
 /**
 * Owns Alpine effects and Store subscriptions, with optional shared defaults.
 * App hotkeys come from `provideAppHotkeys`. Call destroy from x-data's
@@ -35,5 +35,4 @@ function createHotkeysScope(defaultOptions = {}) {
 	return owner;
 }
 
-//#endregion
 export { createHotkeysScope };

package/dist/createKeyHold.js

@@ -1,10 +1,9 @@
 import { read } from "./scope.js";
 import { getKeyStateTracker } from "@tanstack/hotkeys";
 
-//#region src/createKeyHold.ts
+// src/createKeyHold.ts
 function createKeyHold(scope, key) {
 	return scope.select(getKeyStateTracker().store, (state) => state.heldKeys.includes(read(key)));
 }
 
-//#endregion
 export { createKeyHold };

package/dist/hotkeyRecorderPlugin.d.ts

@@ -1,9 +1,7 @@
 import Alpine from "alpinejs";
-//#region src/hotkeyRecorderPlugin.d.ts
 /**
  * Installs $hotkeyRecorder, a function that creates recorders owned by its
  * element. It is separate from `hotkeysPlugin`, so apps that don't record
  * hotkeys don't ship the recorder.
  */
-export declare function hotkeyRecorderPlugin(alpine: typeof Alpine): void;
-//#endregion
+export declare function hotkeyRecorderPlugin(alpine: typeof Alpine): void;

package/dist/hotkeyRecorderPlugin.js

@@ -1,7 +1,7 @@
-import { createScope, setAlpine } from "./scope.js";
 import { createRecorder } from "./createHotkeyRecorder.js";
+import { createScope, setAlpine } from "./scope.js";
 
-//#region src/hotkeyRecorderPlugin.ts
+// src/hotkeyRecorderPlugin.ts
 /**
 * Installs $hotkeyRecorder, a function that creates recorders owned by its
 * element. It is separate from `hotkeysPlugin`, so apps that don't record
@@ -25,5 +25,4 @@ function hotkeyRecorderPlugin(alpine) {
 	});
 }
 
-//#endregion
 export { hotkeyRecorderPlugin };

package/dist/hotkeysPlugin.d.ts

@@ -1,9 +1,7 @@
 import Alpine from "alpinejs";
-//#region src/hotkeysPlugin.d.ts
 /**
  * Installs $hotkeys, whose registrations and subscriptions belong to its
  * element. Every hotkeys scope, including ones from `createHotkeysScope`, uses
  * the Alpine instance passed here.
  */
-export declare function hotkeysPlugin(alpine: typeof Alpine): void;
-//#endregion
+export declare function hotkeysPlugin(alpine: typeof Alpine): void;

package/dist/hotkeysPlugin.js

@@ -1,7 +1,7 @@
-import { setAlpine } from "./scope.js";
 import { createHotkeysScope } from "./createHotkeysScope.js";
+import { setAlpine } from "./scope.js";
 
-//#region src/hotkeysPlugin.ts
+// src/hotkeysPlugin.ts
 /**
 * Installs $hotkeys, whose registrations and subscriptions belong to its
 * element. Every hotkeys scope, including ones from `createHotkeysScope`, uses
@@ -25,5 +25,4 @@ function hotkeysPlugin(alpine) {
 	});
 }
 
-//#endregion
 export { hotkeysPlugin };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { AlpineAppHotkeyOptions, AlpineCreateHotkey, AlpineCreateHotkeyRecorder, AlpineCustomHotkeys, AlpineHotkeyCommonOptions, AlpineHotkeyDefinition, AlpineHotkeyOptionsFor, AlpineHotkeyRecorder, AlpineHotkeyState, AlpineHotkeyTarget, AlpineHotkeys, DefaultHotkeysOptions, HotkeyRegistrationsResult, MaybeGetter } from "./types.js";
 import { createHotkeysScope } from "./createHotkeysScope.js";
 import { hotkeysPlugin } from "./hotkeysPlugin.js";
 import { createHotkeyRecorder } from "./createHotkeyRecorder.js";
 import { hotkeyRecorderPlugin } from "./hotkeyRecorderPlugin.js";
+import { AlpineAppHotkeyOptions, AlpineCreateHotkey, AlpineCreateHotkeyRecorder, AlpineCustomHotkeys, AlpineHotkeyCommonOptions, AlpineHotkeyDefinition, AlpineHotkeyOptionsFor, AlpineHotkeyRecorder, AlpineHotkeyState, AlpineHotkeyTarget, AlpineHotkeys, DefaultHotkeysOptions, HotkeyRegistrationsResult, MaybeGetter } from "./types.js";
 export * from "@tanstack/hotkeys";
 export { AlpineAppHotkeyOptions, AlpineCreateHotkey, AlpineCreateHotkeyRecorder, AlpineCustomHotkeys, AlpineHotkeyCommonOptions, AlpineHotkeyDefinition, AlpineHotkeyOptionsFor, AlpineHotkeyRecorder, AlpineHotkeyState, AlpineHotkeyTarget, AlpineHotkeys, DefaultHotkeysOptions, HotkeyRegistrationsResult, MaybeGetter, createHotkeyRecorder, createHotkeysScope, hotkeyRecorderPlugin, hotkeysPlugin };

package/dist/scope.d.ts

@@ -1,4 +1,4 @@
 import "./types.js";
 import "@tanstack/hotkeys";
 import "@tanstack/hotkeys/adapter";
-import Alpine from "alpinejs";
+import "alpinejs";

package/dist/scope.js

@@ -1,7 +1,7 @@
 import { getHotkeyManager } from "@tanstack/hotkeys";
 import { subscribePublishedAppHotkeys } from "@tanstack/hotkeys/adapter";
 
-//#region src/scope.ts
+// src/scope.ts
 let pluginAlpine;
 /** Records the Alpine instance passed to `hotkeysPlugin`. */
 function setAlpine(alpine) {
@@ -9,7 +9,7 @@ function setAlpine(alpine) {
 }
 function getAlpine() {
 	const alpine = pluginAlpine ?? globalThis.Alpine;
-	if (!alpine) throw new Error("[TanStack Hotkeys] Alpine was not found. Call Alpine.plugin(hotkeysPlugin) before Alpine.start(), or set window.Alpine.");
+	if (!alpine) throw new Error("[hotkeys] Alpine not found. Call Alpine.plugin(hotkeysPlugin) before Alpine.start(), or set window.Alpine");
 	return alpine;
 }
 /** The internal scope behind each `createHotkeysScope` owner. */
@@ -28,7 +28,7 @@ function createScope(defaultOptions) {
 	const cleanups = /* @__PURE__ */ new Set();
 	let destroyed = false;
 	function assertActive() {
-		if (destroyed) throw new Error("Cannot use a destroyed hotkeys scope");
+		if (destroyed) throw new Error("[hotkeys] Cannot use a destroyed hotkeys scope");
 	}
 	function effect(callback) {
 		assertActive();
@@ -95,5 +95,4 @@ function createScope(defaultOptions) {
 	};
 }
 
-//#endregion
 export { createScope, ownerScopes, read, scopeOf, setAlpine };

package/dist/types.d.ts

@@ -1,6 +1,5 @@
 import { AppHotkey, AppHotkeyListItem, CustomHotkeys, HeldModifierOptions, Hotkey, HotkeyCallback, HotkeyCallbackContextFor, HotkeyChord, HotkeyChordRecorderOptions, HotkeyRecorderOptions, HotkeyRegistrationView, HotkeyScopesState, HotkeySequence, HotkeySequenceRecorderOptions, IndividualKey, RegisterableHotkey, RegisteredAppHotkeys, Target } from "@tanstack/hotkeys";
 import { AdapterAppHotkeyOptions, AdapterCommonOptions, AdapterHotkeyDefinition, AdapterOptionsFor } from "@tanstack/hotkeys/adapter";
-//#region src/types.d.ts
 /** A reactive value. Read `.value` where the framework tracks dependencies. */
 export interface AlpineHotkeyState<T> {
   readonly value: T;
@@ -108,5 +107,4 @@ export interface DefaultHotkeysOptions {
   hotkey?: AlpineHotkeyCommonOptions;
   /** Defaults for every recorder. */
   hotkeyRecorder?: Partial<Omit<HotkeyChordRecorderOptions & HotkeySequenceRecorderOptions, 'maxSteps' | 'onRecord' | 'validate'>>;
-}
-//#endregion
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/alpine-hotkeys",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "description": "Alpine adapter for TanStack Hotkeys",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -35,20 +35,20 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/hotkeys": "0.23.0"
+    "@tanstack/hotkeys": "0.25.0"
   },
   "devDependencies": {
     "@types/alpinejs": "^3.17.0",
-    "alpinejs": "^3.17.4"
+    "alpinejs": "^3.17.5"
   },
   "peerDependencies": {
     "alpinejs": "^3.13.0"
   },
   "scripts": {
     "clean": "premove ./build ./dist",
-    "lint": "eslint ./src",
-    "lint:fix": "eslint ./src --fix",
-    "test:eslint": "eslint ./src",
+    "lint": "oxlint ./src",
+    "lint:fix": "oxlint ./src --fix",
+    "test:oxlint": "oxlint ./src",
     "test:lib": "vitest --passWithNoTests",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc",

package/skills/alpine-hotkeys/SKILL.md

@@ -34,8 +34,8 @@ requires:
 Before starting, load the `@tanstack/hotkeys#hotkeys-core` skill (`npx @tanstack/intent@latest load @tanstack/hotkeys#hotkeys-core`).
 
 ```ts no-check
-import Alpine from 'alpinejs'
 import { createHotkeysScope, hotkeysPlugin } from '@tanstack/alpine-hotkeys'
+import Alpine from 'alpinejs'
 
 Alpine.plugin(hotkeysPlugin) // before Alpine.start()
 

package/skills/alpine-hotkeys/references/app-hotkeys.md

@@ -35,12 +35,12 @@ The app hotkey methods throw until `provideAppHotkeys` has run. When saved short
 A settings row records with `createHotkeyRecorder` on its owner:
 
 ```ts
-import Alpine from 'alpinejs'
 import {
   createHotkeyRecorder,
   createHotkeysScope,
   formatForDisplay,
 } from '@tanstack/alpine-hotkeys'
+import Alpine from 'alpinejs'
 import type { AppHotkeyId } from '@tanstack/alpine-hotkeys'
 
 Alpine.data('shortcutRow', (id: AppHotkeyId) => {