feat: highlight conflicting hotkeys

Author: ycnmhd

src/obsidian/helpers/get-used-hotkeys.ts

@@ -0,0 +1,32 @@
+import Lineage from 'src/main';
+import { App, Hotkey } from 'obsidian';
+import { hotkeyToString } from 'src/view/actions/keyboard-shortcuts/helpers/keyboard-events/hotkey-to-string';
+
+export type HotkeyDictionary = {
+    [commandId: string]: Hotkey[];
+};
+
+type ExtendedApp = App & {
+    hotkeyManager: {
+        defaultKeys: HotkeyDictionary;
+        customKeys: HotkeyDictionary;
+    };
+};
+
+const reverseDictionary = (dictionary: HotkeyDictionary) => {
+    const entries = Object.entries(dictionary)
+        .map(([command, hotkeys]) => {
+            return hotkeys.map((hk) => [hotkeyToString(hk), command]);
+        })
+        .filter((x) => x)
+        .flat() as [string, string][];
+    return Object.fromEntries(entries);
+};
+
+export const getUsedHotkeys = (plugin: Lineage) => {
+    const hotkeyManager = (plugin.app as ExtendedApp).hotkeyManager;
+    return {
+        ...reverseDictionary(hotkeyManager.defaultKeys),
+        ...reverseDictionary(hotkeyManager.customKeys),
+    };
+};

src/view/actions/keyboard-shortcuts/helpers/create-commands.ts

@@ -1,11 +1,11 @@
 import { Hotkey } from 'obsidian';
 import { ViewStore } from 'src/view/view';
 import Lineage from 'src/main';
-import { addNodeAndSplitAtCursor } from 'src/view/actions/keyboard-shortcuts/helpers/add-node-and-split-at-cursor';
-import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/save-node-content';
-import { cancelChanges } from 'src/view/actions/keyboard-shortcuts/helpers/cancel-changes';
-import { saveNodeAndInsertNode } from 'src/view/actions/keyboard-shortcuts/helpers/save-node-and-insert-node';
-import { mergeNode } from 'src/view/actions/keyboard-shortcuts/helpers/merge-node';
+import { addNodeAndSplitAtCursor } from 'src/view/actions/keyboard-shortcuts/helpers/tree/add-node-and-split-at-cursor';
+import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/tree/save-node-content';
+import { cancelChanges } from 'src/view/actions/keyboard-shortcuts/helpers/tree/cancel-changes';
+import { saveNodeAndInsertNode } from 'src/view/actions/keyboard-shortcuts/helpers/tree/save-node-and-insert-node';
+import { mergeNode } from 'src/view/actions/keyboard-shortcuts/helpers/tree/merge-node';
 
 export const hotkeysLang = {
     save_changes_and_exit_card: 'Save changes and exit card',
@@ -39,6 +39,8 @@ export type PluginCommand = {
     hotkeys: Hotkey[];
 };
 
+export type LineageCommandName = keyof typeof hotkeysLang;
+export type LineageCommands = Record<LineageCommandName, PluginCommand>;
 export const createCommands = (plugin: Lineage) => {
     const isEditing = (store: ViewStore) => {
         return !!store.getValue().ui.state.editing.activeNodeId;
@@ -297,5 +299,5 @@ export const createCommands = (plugin: Lineage) => {
                 { key: 'ArrowDown', modifiers: ['Ctrl', 'Shift'] },
             ],
         },
-    } satisfies Record<keyof typeof hotkeysLang, PluginCommand>;
+    } satisfies LineageCommands;
 };

src/view/actions/keyboard-shortcuts/helpers/keyboard-events/detect-conflicting-hotkeys.ts

@@ -0,0 +1,39 @@
+import { eventToString } from 'src/view/actions/keyboard-shortcuts/helpers/keyboard-events/event-to-string';
+import { PluginCommand } from 'src/view/actions/keyboard-shortcuts/helpers/create-commands';
+import { hotkeyToString } from 'src/view/actions/keyboard-shortcuts/helpers/keyboard-events/hotkey-to-string';
+import { getUsedHotkeys } from 'src/obsidian/helpers/get-used-hotkeys';
+import Lineage from 'src/main';
+
+export const detectConflictingHotkeys = (
+    plugin: Lineage,
+    commands: PluginCommand[],
+    container: HTMLElement,
+) => {
+    const free = new Set();
+    const all = [];
+    const listener = (event: KeyboardEvent) => {
+        const hotkey = eventToString(event);
+        free.add(hotkey);
+    };
+    const el = document.createElement('div');
+    el.addEventListener('keydown', listener);
+    container.append(el);
+
+    for (const command of commands) {
+        for (const hotkey of command.hotkeys) {
+            all.push(hotkeyToString(hotkey));
+            const modifiers = new Set(hotkey.modifiers);
+            const event = new KeyboardEvent('keydown', {
+                key: hotkey.key,
+                shiftKey: modifiers.has('Shift'),
+                altKey: modifiers.has('Alt'),
+                ctrlKey: modifiers.has('Ctrl'),
+            });
+            el.dispatchEvent(event);
+        }
+    }
+    el.removeEventListener('keydown', listener);
+    container.removeChild(el);
+    const used = getUsedHotkeys(plugin);
+    return new Map(all.filter((h) => !free.has(h)).map((hk) => [hk, used[hk]]));
+};

src/view/actions/keyboard-shortcuts/helpers/keyboard-events/event-to-string.ts

@@ -0,0 +1,9 @@
+import { Modifiers } from 'src/view/actions/keyboard-shortcuts/keyboard-shortcuts';
+
+export const eventToString = (event: KeyboardEvent) => {
+    let string = event.key.toUpperCase();
+    if (event.altKey) string += Modifiers.Alt;
+    if (event.ctrlKey) string += Modifiers.Ctrl;
+    if (event.shiftKey) string += Modifiers.Shift;
+    return string;
+};

src/view/actions/keyboard-shortcuts/helpers/keyboard-events/hotkey-to-string.ts

@@ -0,0 +1,8 @@
+import { Hotkey } from 'obsidian';
+
+export const hotkeyToString = (hotkey: Hotkey) =>
+    hotkey.key.toUpperCase() +
+    hotkey.modifiers
+        .sort()
+        .map((x) => (x === 'Mod' ? 'Ctrl' : x))
+        .join('');

…/helpers/add-node-and-split-at-cursor.ts …ers/tree/add-node-and-split-at-cursor.tssrc/view/actions/keyboard-shortcuts/helpers/add-node-and-split-at-cursor.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/add-node-and-split-at-cursor.ts src/view/actions/keyboard-shortcuts/helpers/add-node-and-split-at-cursor.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/add-node-and-split-at-cursor.ts

@@ -2,7 +2,7 @@ import { ViewStore } from 'src/view/view';
 import Lineage from 'src/main';
 import { Direction } from 'src/stores/view/view-reducer';
 
-import { saveNodeAndInsertNode } from 'src/view/actions/keyboard-shortcuts/helpers/save-node-and-insert-node';
+import { saveNodeAndInsertNode } from 'src/view/actions/keyboard-shortcuts/helpers/tree/save-node-and-insert-node';
 import { activeTextArea } from 'src/view/components/container/column/components/group/components/card/actions/save-node-content-action';
 
 export const addNodeAndSplitAtCursor = (

…oard-shortcuts/helpers/cancel-changes.ts …shortcuts/helpers/tree/cancel-changes.tssrc/view/actions/keyboard-shortcuts/helpers/cancel-changes.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/cancel-changes.ts src/view/actions/keyboard-shortcuts/helpers/cancel-changes.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/cancel-changes.ts

@@ -1,6 +1,6 @@
 import { ViewStore } from 'src/view/view';
 import { VerticalDirection } from 'src/stores/view/view-reducer';
-import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/save-node-content';
+import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/tree/save-node-content';
 
 export const mergeNode = (store: ViewStore, direction: VerticalDirection) => {
     saveNodeContent(store);

…keyboard-shortcuts/helpers/merge-node.ts …ard-shortcuts/helpers/tree/merge-node.tssrc/view/actions/keyboard-shortcuts/helpers/merge-node.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/merge-node.ts src/view/actions/keyboard-shortcuts/helpers/merge-node.ts renamed to src/view/actions/keyboard-shortcuts/helpers/tree/merge-node.ts

@@ -1,6 +1,6 @@
 import { ViewStore } from 'src/view/view';
 import { Direction } from 'src/stores/view/view-reducer';
-import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/save-node-content';
+import { saveNodeContent } from 'src/view/actions/keyboard-shortcuts/helpers/tree/save-node-content';
 
 export const saveNodeAndInsertNode = (
     store: ViewStore,