Files
kandev/apps/web/lib/keyboard/shortcut-overrides.test.ts
T
João Salavisa 85a1333dec feat(web): make chat reverse-i-search shortcut configurable (#1255)
* feat(web): make chat reverse-i-search shortcut configurable

Ctrl+R was hardcoded in the TipTap ProseMirror plugin and could not be
rebound from Settings → Shortcuts. Register REVERSE_SEARCH in the
shared shortcut registry and resolve the binding through the user
overrides ref so the Settings UI exposes it like every other shortcut.

Default stays Ctrl+R (plain Ctrl, not ctrlOrCmd) so Cmd+R on macOS
keeps reloading the browser tab.

* test(web): cover REVERSE_SEARCH in shortcut-overrides tests

Bump toHaveLength(12) → toHaveLength(13), add toContain check, and
add the label/default assertion in the "each entry" block. Without
this, CI fails on the configurable-shortcut count assertion.

---------

Co-authored-by: Kandev Agent <agent@kandev.dev>
2026-06-02 23:06:11 +01:00

103 lines
4.3 KiB
TypeScript

import { describe, it, expect } from "vitest";
import { SHORTCUTS } from "./constants";
import {
CONFIGURABLE_SHORTCUTS,
getShortcut,
resolveAllShortcuts,
type ConfigurableShortcutId,
} from "./shortcut-overrides";
describe("CONFIGURABLE_SHORTCUTS", () => {
it("contains all expected shortcut IDs", () => {
const ids = Object.keys(CONFIGURABLE_SHORTCUTS);
expect(ids).toContain("SEARCH");
expect(ids).toContain("FILE_SEARCH");
expect(ids).toContain("QUICK_CHAT");
expect(ids).toContain("BOTTOM_TERMINAL");
expect(ids).toContain("TOGGLE_SIDEBAR");
expect(ids).toContain("COMMAND_PANEL");
expect(ids).toContain("NEW_TASK");
expect(ids).toContain("FOCUS_INPUT");
expect(ids).toContain("TOGGLE_PLAN_MODE");
expect(ids).toContain("TASK_SWITCHER");
expect(ids).toContain("TASK_SWITCHER_REVERSE");
expect(ids).toContain("VOICE_INPUT_TOGGLE");
expect(ids).toContain("REVERSE_SEARCH");
expect(ids).toHaveLength(13);
});
it("each entry has a label and default matching SHORTCUTS", () => {
expect(CONFIGURABLE_SHORTCUTS.BOTTOM_TERMINAL.label).toBe("Toggle Bottom Terminal");
expect(CONFIGURABLE_SHORTCUTS.BOTTOM_TERMINAL.default).toBe(SHORTCUTS.BOTTOM_TERMINAL);
expect(CONFIGURABLE_SHORTCUTS.TOGGLE_SIDEBAR.label).toBe("Toggle Sidebar");
expect(CONFIGURABLE_SHORTCUTS.TOGGLE_SIDEBAR.default).toBe(SHORTCUTS.TOGGLE_SIDEBAR);
expect(CONFIGURABLE_SHORTCUTS.COMMAND_PANEL.label).toBe("Command Panel (Alt)");
expect(CONFIGURABLE_SHORTCUTS.COMMAND_PANEL.default).toBe(SHORTCUTS.COMMAND_PANEL);
expect(CONFIGURABLE_SHORTCUTS.NEW_TASK.label).toBe("New Task");
expect(CONFIGURABLE_SHORTCUTS.NEW_TASK.default).toBe(SHORTCUTS.NEW_TASK);
expect(CONFIGURABLE_SHORTCUTS.FOCUS_INPUT.label).toBe("Focus Chat Input");
expect(CONFIGURABLE_SHORTCUTS.FOCUS_INPUT.default).toBe(SHORTCUTS.FOCUS_INPUT);
expect(CONFIGURABLE_SHORTCUTS.TOGGLE_PLAN_MODE.label).toBe("Toggle Plan Mode");
expect(CONFIGURABLE_SHORTCUTS.TOGGLE_PLAN_MODE.default).toBe(SHORTCUTS.TOGGLE_PLAN_MODE);
expect(CONFIGURABLE_SHORTCUTS.TASK_SWITCHER.label).toBe("Recent Task Switcher");
expect(CONFIGURABLE_SHORTCUTS.TASK_SWITCHER.default).toBe(SHORTCUTS.TASK_SWITCHER);
expect(CONFIGURABLE_SHORTCUTS.TASK_SWITCHER_REVERSE.label).toBe(
"Recent Task Switcher (Backward)",
);
expect(CONFIGURABLE_SHORTCUTS.TASK_SWITCHER_REVERSE.default).toBe(
SHORTCUTS.TASK_SWITCHER_REVERSE,
);
expect(CONFIGURABLE_SHORTCUTS.REVERSE_SEARCH.label).toBe("Reverse Chat Search");
expect(CONFIGURABLE_SHORTCUTS.REVERSE_SEARCH.default).toBe(SHORTCUTS.REVERSE_SEARCH);
});
});
describe("getShortcut", () => {
it("returns default when no overrides provided", () => {
expect(getShortcut("BOTTOM_TERMINAL")).toBe(SHORTCUTS.BOTTOM_TERMINAL);
expect(getShortcut("TOGGLE_SIDEBAR")).toBe(SHORTCUTS.TOGGLE_SIDEBAR);
});
it("returns default when override does not contain the ID", () => {
expect(getShortcut("BOTTOM_TERMINAL", {})).toBe(SHORTCUTS.BOTTOM_TERMINAL);
});
it("returns override when present", () => {
const override = { key: "t", modifiers: { ctrlOrCmd: true, shift: true } };
const result = getShortcut("BOTTOM_TERMINAL", { BOTTOM_TERMINAL: override });
expect(result).toEqual(override);
});
it("does not affect other shortcuts when one is overridden", () => {
const overrides = { BOTTOM_TERMINAL: { key: "x", modifiers: { ctrlOrCmd: true } } };
expect(getShortcut("TOGGLE_SIDEBAR", overrides)).toBe(SHORTCUTS.TOGGLE_SIDEBAR);
});
});
describe("resolveAllShortcuts", () => {
it("returns all defaults when no overrides provided", () => {
const result = resolveAllShortcuts();
const ids = Object.keys(CONFIGURABLE_SHORTCUTS) as ConfigurableShortcutId[];
for (const id of ids) {
expect(result[id]).toBe(CONFIGURABLE_SHORTCUTS[id].default);
}
});
it("applies overrides while keeping other defaults", () => {
const override = { key: "m", modifiers: { alt: true } };
const result = resolveAllShortcuts({ TOGGLE_SIDEBAR: override });
expect(result.TOGGLE_SIDEBAR).toEqual(override);
expect(result.BOTTOM_TERMINAL).toBe(SHORTCUTS.BOTTOM_TERMINAL);
expect(result.SEARCH).toBe(SHORTCUTS.SEARCH);
expect(result.TASK_SWITCHER).toBe(SHORTCUTS.TASK_SWITCHER);
});
});