@tanstack/hotkeys-devtools 1.8.1 → 1.9.0

package/dist/HotkeysContextProvider.js

@@ -1,9 +1,9 @@
 import { needsSequenceProgressClock } from "./sequence-progress.js";
 import { createComponent } from "solid-js/web";
-import { createContext, createEffect, createMemo, createSignal, onCleanup, useContext } from "solid-js";
 import { HotkeyManager, KeyStateTracker, toHotkeyRegistrationView } from "@tanstack/hotkeys";
+import { createContext, createEffect, createMemo, createSignal, onCleanup, useContext } from "solid-js";
 
-//#region src/HotkeysContextProvider.tsx
+// src/HotkeysContextProvider.tsx
 const HotkeysDevtoolsContext = createContext({
 	registrations: () => [],
 	appHotkeys: () => [],
@@ -104,5 +104,4 @@ function useHotkeysDevtoolsState() {
 	return useContext(HotkeysDevtoolsContext);
 }
 
-//#endregion
 export { HotkeysContextProvider, useHotkeysDevtoolsState };

package/dist/_issues.js

@@ -0,0 +1,23 @@
+import { validateHotkey } from "@tanstack/hotkeys";
+
+// src/_issues.ts
+const DESCRIPTIONS = {
+	empty: () => "The hotkey is empty, so it registers nothing.",
+	"empty-part": () => "A part between + signs is empty, so the hotkey registers nothing.",
+	"unknown-modifier": (part) => `'${part}' isn't a modifier, so the hotkey registers nothing. Use Control, Alt, Shift, Meta, or Mod.`,
+	"invalid-physical-key": (part) => `'${part}' isn't a KeyboardEvent.code. Write physical keys like [KeyS].`,
+	"modifier-only": (part) => `'${part}' is a modifier, so the hotkey registers nothing. Add a key that isn't a modifier.`,
+	"unknown-key": (part) => `'${part}' isn't a known key name, so the hotkey may never fire. Key names are case-sensitive, such as Escape and F1.`
+};
+/** A readable sentence for one issue from `validateHotkey`. */
+function describeHotkeyIssue(issue) {
+	const text = DESCRIPTIONS[issue.reason](issue.part ?? "");
+	return issue.step === void 0 ? text : `Step ${issue.step + 1}: ${text}`;
+}
+/** Readable errors and warnings for a hotkey, errors first. */
+function describeHotkeyIssues(hotkey) {
+	const { errors, warnings } = validateHotkey(hotkey);
+	return [...errors, ...warnings].map(describeHotkeyIssue);
+}
+
+export { describeHotkeyIssues };

package/dist/_registrations.js

@@ -1,8 +1,8 @@
 import { useHotkeysDevtoolsState } from "./HotkeysContextProvider.js";
-import { createMemo } from "solid-js";
 import { findHotkeyConflicts, formatForDisplay } from "@tanstack/hotkeys";
+import { createMemo } from "solid-js";
 
-//#region src/_registrations.ts
+// src/_registrations.ts
 /** Refresh shared conflict reporting when either registry changes. */
 function useRegistrationConflicts(registration) {
 	const state = useHotkeysDevtoolsState();
@@ -46,5 +46,4 @@ function getBindingKind(reg) {
 	return codes === 0 ? "Key" : codes === parsed.length ? "Code" : "Mixed";
 }
 
-//#endregion
 export { formatRegistration, getBindingKind, useRegistrationConflicts };

package/dist/_scopes.js

@@ -1,4 +1,4 @@
-//#region src/_scopes.ts
+// src/_scopes.ts
 const scopeStatusDescriptions = {
 	exclusive: "Exclusive: only hotkeys in this scope, scopes nested in it, and scopes it allows fire",
 	allowed: "Allowed: the exclusive scope lets hotkeys in this scope fire",
@@ -37,5 +37,4 @@ function groupByScope(registrations, state) {
 	}));
 }
 
-//#endregion
 export { getScopeStatus, groupByScope, scopeStatusDescriptions };

package/dist/_trigger.js

@@ -1,6 +1,6 @@
 import { HotkeyManager } from "@tanstack/hotkeys";
 
-//#region src/_trigger.ts
+// src/_trigger.ts
 /**
 * Runs a registration's callback as if its hotkey, or a sequence's last step,
 * was pressed, and counts it like a real press. The event names the physical
@@ -37,5 +37,4 @@ function triggerRegistration(id, manager = HotkeyManager.getInstance()) {
 	return true;
 }
 
-//#endregion
 export { triggerRegistration };

package/dist/components/ActionButtons.js

@@ -1,8 +1,8 @@
-import { useStyles } from "../styles/use-styles.js";
 import { triggerRegistration } from "../_trigger.js";
+import { useStyles } from "../styles/use-styles.js";
 import { className, delegateEvents, effect, template } from "solid-js/web";
 
-//#region src/components/ActionButtons.tsx
+// src/components/ActionButtons.tsx
 var _tmpl$ = /*#__PURE__*/ template(`<div><button><span></span>Trigger`);
 function ActionButtons(props) {
 	const styles = useStyles();
@@ -28,5 +28,4 @@ function ActionButtons(props) {
 }
 delegateEvents(["mousedown"]);
 
-//#endregion
 export { ActionButtons };