Merge pull request #146 from github/fix-sort-modifiers

Fix double-modifier bug in hotkey modifier sorting

Author: iansan5653

package-lock.json

@@ -96,14 +96,16 @@ function localizeMod(hotkey: string, platform?: string | undefined): string {
   return hotkey.replace('Mod', localModifier)
 }
 
+const orderedModifiers: Partial<Record<string, number>> = {
+  Control: 0,
+  Alt: 1,
+  Meta: 2,
+  Shift: 3
+}
+
 function sortModifiers(hotkey: string): string {
-  const key = hotkey.split('+').pop()
-  const modifiers: string[] = []
-  for (const modifier of ['Control', 'Alt', 'Meta', 'Shift']) {
-    if (hotkey.includes(modifier)) {
-      modifiers.push(modifier)
-    }
-  }
-  if (key) modifiers.push(key)
-  return modifiers.join('+')
+  return hotkey
+    .split('+')
+    .sort((a, b) => (orderedModifiers[a] ?? Infinity) - (orderedModifiers[b] ?? Infinity))
+    .join('+')
 }

src/hotkey.ts

@@ -30,7 +30,10 @@ describe('normalizeHotkey', () => {
     ['Mod+a', 'Control+a', undefined],
     // Modifier sorting
     ['Shift+Alt+Meta+Control+m', 'Control+Alt+Meta+Shift+m'],
-    ['Shift+Alt+Mod+m', 'Control+Alt+Shift+m', 'win']
+    ['Shift+Alt+Mod+m', 'Control+Alt+Shift+m', 'win'],
+    // Edge case: only modifiers
+    ['Alt', 'Alt', 'win / linux'],
+    ['Alt+Mod', 'Control+Alt', 'win / linux']
   ]
 
   for (const [input, expected, platform = 'any platform'] of tests) {