chore: rename shortcut formatting functions

Author: microbit-matt-hillsdon

src/actions/clipboard.ts

@@ -18,7 +18,7 @@ import * as Constants from '../constants';
 import type {BlockSvg, WorkspaceSvg} from 'blockly';
 import {Navigation} from '../navigation';
 import {ScopeWithConnection} from './action_menu';
-import {formatActionShortcut} from '../shortcut_formatting';
+import {getShortActionShortcut} from '../shortcut_formatting';
 
 const KeyCodes = blocklyUtils.KeyCodes;
 const createSerializedKey = ShortcutRegistry.registry.createSerializedKey.bind(
@@ -101,7 +101,7 @@ export class Clipboard {
    */
   private registerCutContextMenuAction() {
     const cutAction: ContextMenuRegistry.RegistryItem = {
-      displayText: (scope) => `Cut (${formatActionShortcut('cut', 'short')})`,
+      displayText: (scope) => `Cut (${getShortActionShortcut('cut')})`,
       preconditionFn: (scope) => {
         const ws = scope.block?.workspace;
         if (!ws) return 'hidden';
@@ -196,7 +196,7 @@ export class Clipboard {
    */
   private registerCopyContextMenuAction() {
     const copyAction: ContextMenuRegistry.RegistryItem = {
-      displayText: (scope) => `Copy (${formatActionShortcut('copy', 'short')})`,
+      displayText: (scope) => `Copy (${getShortActionShortcut('copy')})`,
       preconditionFn: (scope) => {
         const ws = scope.block?.workspace;
         if (!ws) return 'hidden';
@@ -305,8 +305,7 @@ export class Clipboard {
    */
   private registerPasteContextMenuAction() {
     const pasteAction: ContextMenuRegistry.RegistryItem = {
-      displayText: (scope) =>
-        `Paste (${formatActionShortcut('paste', 'short')})`,
+      displayText: (scope) => `Paste (${getShortActionShortcut('paste')})`,
       preconditionFn: (scope: ScopeWithConnection) => {
         const block = scope.block ?? scope.connection?.getSourceBlock();
         const ws = block?.workspace as WorkspaceSvg | null;

src/actions/enter.ts

@@ -22,7 +22,7 @@ import type {
 
 import * as Constants from '../constants';
 import type {Navigation} from '../navigation';
-import {formatActionShortcut} from '../shortcut_formatting';
+import {getShortActionShortcut} from '../shortcut_formatting';
 import {Mover} from './mover';
 
 const KeyCodes = BlocklyUtils.KeyCodes;
@@ -104,7 +104,7 @@ export class EnterAction {
     } else if (nodeType === ASTNode.types.BLOCK) {
       const block = curNode.getLocation() as Block;
       if (!this.tryShowFullBlockFieldEditor(block)) {
-        const shortcut = formatActionShortcut('list_shortcuts', 'short');
+        const shortcut = getShortActionShortcut('list_shortcuts');
         const message = `Press ${shortcut} for help on keyboard controls`;
         dialog.alert(message);
       }

src/shortcut_dialog.ts

@@ -8,7 +8,7 @@ import * as Blockly from 'blockly/core';
 import * as Constants from './constants';
 import {ShortcutRegistry} from 'blockly/core';
 import {
-  actionShortcutsForPlatform,
+  getLongActionShortcutsAsKeys,
   upperCaseFirst,
 } from './shortcut_formatting';
 
@@ -139,7 +139,7 @@ export class ShortcutDialog {
   }
 
   private actionShortcutsToHTML(action: string) {
-    const shortcuts = actionShortcutsForPlatform(action, 'long');
+    const shortcuts = getLongActionShortcutsAsKeys(action);
     return shortcuts.map((keys) => this.actionShortcutToHTML(keys)).join(' / ');
   }
 

src/shortcut_formatting.ts

@@ -4,34 +4,39 @@ import {keyNames} from './keynames';
 const isMacPlatform = navigator.platform.startsWith('Mac');
 
 /**
- * Format the primary shortcut for this platform in a user facing format.
+ * Find the primary shortcut for this platform and return it as single string
+ * in a short user facing format.
  *
  * @param action The action name, e.g. "cut".
- * @param format The key format.
  * @returns The formatted shortcut.
  */
-export function formatActionShortcut(
-  action: string,
-  format: ShortcutFormat,
-): string {
-  const parts = actionShortcutsForPlatform(action, format)[0];
+export function getShortActionShortcut(action: string): string {
+  const parts = getActionShortcutsAsKeys(action, shortModifierNames)[0];
   return parts.join(isMacPlatform ? ' ' : ' + ');
 }
 
-const modifierNamesByFormat: Record<ShortcutFormat, Record<string, string>> = {
-  long: {
-    'Control': 'Ctrl',
-    'Meta': '⌘ Command',
-    'Alt': isMacPlatform ? '⌥ Option' : 'Alt',
-  },
-  short: {
-    'Control': 'Ctrl',
-    'Meta': '⌘',
-    'Alt': isMacPlatform ? '⌥' : 'Alt',
-  },
+/**
+ * Find the relevant shortcuts for the given action for the current platform.
+ * Keys are returned in a long user facing format.
+ *
+ * @param action The action name, e.g. "cut".
+ * @returns The formatted shortcuts as individual keys.
+ */
+export function getLongActionShortcutsAsKeys(action: string): string[][] {
+  return getActionShortcutsAsKeys(action, longModifierNames);
+}
+
+const longModifierNames: Record<string, string> = {
+  'Control': 'Ctrl',
+  'Meta': '⌘ Command',
+  'Alt': isMacPlatform ? '⌥ Option' : 'Alt',
 };
 
-export type ShortcutFormat = 'long' | 'short';
+const shortModifierNames: Record<string, string> = {
+  'Control': 'Ctrl',
+  'Meta': '⌘',
+  'Alt': isMacPlatform ? '⌥' : 'Alt',
+};
 
 /**
  * Find the relevant shortcuts for the given action for the current platform.
@@ -41,14 +46,13 @@ export type ShortcutFormat = 'long' | 'short';
  * current platform or tagged them with a platform.
  *
  * @param action The action name, e.g. "cut".
- * @param format The key format.
+ * @param modifierNames The names to use for the Meta/Control/Alt modifiers.
  * @returns The formatted shortcuts.
  */
-export function actionShortcutsForPlatform(
+function getActionShortcutsAsKeys(
   action: string,
-  format: ShortcutFormat,
+  modifierNames: Record<string, string>,
 ): string[][] {
-  const modifierNames = modifierNamesByFormat[format];
   const shortcuts = ShortcutRegistry.registry.getKeyCodesByShortcutName(action);
   // See ShortcutRegistry.createSerializedKey for the starting format.
   const named = shortcuts.map((shortcut) => {