Fix hotkey aliases

README.md

@@ -3,7 +3,7 @@
 [![MIT](https://img.shields.io/github/license/rameel/ramstack.hotkey.js)](https://github.com/rameel/ramstack.hotkey.js/blob/main/LICENSE)
 
 The `@ramstack/hotkey` package is a very small and lightweight library for handling hotkeys.
-The library weighs around 1.3KB and approximately 750 bytes when gzipped.
+The library weighs around 1.4KB and approximately 800 bytes when gzipped.
 
 ## Installation
 
@@ -102,41 +102,39 @@ registerHotkey(window, "Win + PgUp", e => {
 
 #### hotkey (required)
 The combination of keys for the hotkey, e.g., `Ctrl + Alt + Delete`
-The hotkey description is a case-insensitive. Spaces are not important. Standard key names are used.
-You can find them here [Key values for keyboard events](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values)
+The hotkey description is case-insensitive. Spaces are not important. Standard key names are used.
+You can find them here [Key values for keyboard events](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values).
 
 In addition, there are also aliases for some key names:
 
 ```js
 const aliases: Record<string, string> = {
-    "esc"         : "escape",
-    "ins"         : "insert",
-    "del"         : "delete",
-    "up"          : "arrowup",
-    "down"        : "arrowdown",
-    "right"       : "arrowright",
-    "left"        : "arrowleft",
-    "pgup"        : "pageup",
-    "pgdn"        : "pagedown",
-    "break"       : "pause",
-    "scroll"      : "scrolllock",
-    "scrlk"       : "scrolllock",
-    "prtscr"      : "printscreen",
-    "win"         : "meta",
-    "windows"     : "meta",
-    "cmd"         : "meta",
-    "command"     : "meta",
-    "comma"       : ",",
-    "period"      : ".",
-    "quote"       : "\"",
-    "singlequote" : "'",
-    "colon"       : ":",
-    "semicolon"   : ";",
-    "plus"        : "+",
-    "minus"       : "-",
-    "tilde"       : "~",
-    "equal"       : "=",
-    "slash"       : "/"
+    "esc"     : "escape",
+    "ins"     : "insert",
+    "del"     : "delete",
+    "up"      : "arrowup",
+    "down"    : "arrowdown",
+    "right"   : "arrowright",
+    "left"    : "arrowleft",
+    "pgup"    : "pageup",
+    "pgdn"    : "pagedown",
+    "break"   : "pause",
+    "scroll"  : "scrolllock",
+    "scrlk"   : "scrolllock",
+    "prtscr"  : "printscreen",
+    "win"     : "meta",
+    "windows" : "meta",
+    "cmd"     : "meta",
+    "command" : "meta",
+    ","       : "comma",
+    "."       : "period",
+    "/"       : "slash",
+    "\\"      : "backslash",
+    ";"       : "semicolon",
+    "="       : "equal",
+    "`"       : "backquote",
+    "]"       : "bracketright",
+    "["       : "bracketleft",
 };
 ```
 

src/hotkey.ts

@@ -16,17 +16,15 @@ const aliases: Record<string, string> = {
     "windows": "meta",
     "cmd": "meta",
     "command": "meta",
-    "comma": ",",
-    "period": ".",
-    "quote": "\"",
-    "singlequote": "'",
-    "colon": ":",
-    "semicolon": ";",
-    "plus": "+",
-    "minus": "-",
-    "tilde": "~",
-    "equal": "=",
-    "slash": "/"
+    ",": "comma",
+    ".": "period",
+    "/": "slash",
+    "\\": "backslash",
+    ";": "semicolon",
+    "=": "equal",
+    "`": "backquote",
+    "]": "bracketright",
+    "[": "bracketleft",
 };
 
 const control_keys: string[] = [
@@ -117,7 +115,9 @@ function describe(hotkey: string): Hotkey {
                 k.length || error_invalid_key(hotkey);
                 k = k.toUpperCase();
 
-                data.code = k.length === 1 && k >= 'A' && k <= 'Z' ? `KEY${k}` : k;
+                data.code = /^[A-Z]$/.test(k) ? `KEY${k}`
+                          : /^[0-9]$/.test(k) ? `DIGIT${k}`
+                          : k;
                 break;
         }
         return data;

tests/aliases.spec.js

@@ -0,0 +1,200 @@
+import process from "node:process";
+import { test, expect } from "@playwright/test";
+
+test.beforeEach(async ({ page }) => {
+    await page.goto(`file://${process.cwd()}/tests/assets/generic.html`);
+    await page.evaluate(() => {
+        window.hotkeyTriggered = false;
+    });
+});
+
+test("should trigger when using 'Esc' alias for Escape", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Esc", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.press("Escape");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Del' alias for Delete", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Del", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.press("Delete");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ins' alias for Insert", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ins", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.press("Insert");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'PgUp' alias for PageUp", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "PgUp", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.press("PageUp");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'PgDn' alias for PageDown", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "PgDn", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.press("PageDown");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+,' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+,", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down(",");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+.' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+.", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down(".");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+/' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+/", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("/");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+\\' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+\\", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("\\");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+;' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+;", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down(";");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+=' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+=", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("=");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+`' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+`", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("`");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+]' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+]", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("]");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});
+
+test("should trigger when using 'Ctrl+[' literal character alias", async ({ page }) => {
+    await page.evaluate(() => {
+        window.registerHotkey(document, "Ctrl+[", () => {
+            window.hotkeyTriggered = true;
+        });
+    });
+
+    await page.keyboard.down("Control");
+    await page.keyboard.down("[");
+
+    const triggered = await page.evaluate(() => window.hotkeyTriggered);
+    expect(triggered).toBe(true);
+});

tests/generic.html → tests/assets/generic.html

@@ -16,6 +16,6 @@
             </div>
         </div>
     </div>
-    <script src="../dist/hotkey.js"></script>
+    <script src="../../dist/hotkey.js"></script>
 </body>
 </html>