Electron menu.js ➡️ menu.ts (#2978)

actualbudget · Jul 4, 2024 · 803289e · 803289e
1 parent 76cdad4
commit 803289e
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 45 deletions.
diff --git a/packages/desktop-electron/index.ts b/packages/desktop-electron/index.ts
@@ -17,7 +17,7 @@ import isDev from 'electron-is-dev';
 import promiseRetry from 'promise-retry';
 
 import about from './about';
-import getMenu from './menu';
+import { getMenu } from './menu';
 import updater from './updater';
 import {
   get as getWindowState,

diff --git a/packages/desktop-electron/menu.js → packages/desktop-electron/menu.ts b/packages/desktop-electron/menu.js → packages/desktop-electron/menu.ts
@@ -1,14 +1,24 @@
-const { Menu, ipcMain, app, shell } = require('electron');
+import {
+  MenuItemConstructorOptions,
+  Menu,
+  ipcMain,
+  app,
+  shell,
+} from 'electron';
 
-function getMenu(isDev, createWindow, budgetId) {
-  const template = [
+export function getMenu(
+  isDev: boolean,
+  createWindow: () => Promise<void>,
+  budgetId: string | undefined = undefined,
+) {
+  const template: MenuItemConstructorOptions[] = [
     {
       label: 'File',
       submenu: [
         {
           label: 'Load Backup...',
           enabled: false,
-          click(item, focusedWindow) {
+          click(_item, focusedWindow) {
             if (focusedWindow && budgetId) {
               if (focusedWindow.webContents.getTitle() === 'Actual') {
                 focusedWindow.webContents.executeJavaScript(
@@ -24,7 +34,7 @@ function getMenu(isDev, createWindow, budgetId) {
         {
           label: 'Manage files...',
           accelerator: 'CmdOrCtrl+O',
-          click(item, focusedWindow) {
+          click(_item, focusedWindow) {
             if (focusedWindow) {
               if (focusedWindow.webContents.getTitle() === 'Actual') {
                 focusedWindow.webContents.executeJavaScript(
@@ -48,18 +58,26 @@ function getMenu(isDev, createWindow, budgetId) {
           label: 'Undo',
           enabled: false,
           accelerator: 'CmdOrCtrl+Z',
-          click: function (menuItem, focusedWin) {
+          click: function (_menuItem, focusedWin) {
             // Undo
-            focusedWin.webContents.executeJavaScript('__actionsForMenu.undo()');
+            if (focusedWin) {
+              focusedWin.webContents.executeJavaScript(
+                '__actionsForMenu.undo()',
+              );
+            }
           },
         },
         {
           label: 'Redo',
           enabled: false,
           accelerator: 'Shift+CmdOrCtrl+Z',
-          click: function (menuItem, focusedWin) {
+          click: function (_menuItem, focusedWin) {
             // Redo
-            focusedWin.webContents.executeJavaScript('__actionsForMenu.redo()');
+            if (focusedWin) {
+              focusedWin.webContents.executeJavaScript(
+                '__actionsForMenu.redo()',
+              );
+            }
           },
         },
         {
@@ -75,64 +93,70 @@ function getMenu(isDev, createWindow, budgetId) {
           role: 'paste',
         },
         {
-          role: 'pasteandmatchstyle',
+          role: 'pasteAndMatchStyle',
         },
         {
           role: 'delete',
         },
         {
-          role: 'selectall',
+          role: 'selectAll',
         },
       ],
     },
     {
       label: 'View',
       submenu: [
-        isDev && {
-          label: 'Reload',
-          accelerator: 'CmdOrCtrl+R',
-          click(item, focusedWindow) {
-            if (focusedWindow) focusedWindow.reload();
-          },
-        },
+        isDev
+          ? {
+              label: 'Reload',
+              accelerator: 'CmdOrCtrl+R',
+              click(_item, focusedWindow) {
+                if (focusedWindow) focusedWindow.reload();
+              },
+            }
+          : { label: 'hidden', visible: false },
         {
           label: 'Toggle Developer Tools',
           accelerator:
             process.platform === 'darwin' ? 'Alt+Command+I' : 'Ctrl+Shift+I',
-          click(item, focusedWindow) {
+          click(_item, focusedWindow) {
             if (focusedWindow) focusedWindow.webContents.toggleDevTools();
           },
         },
-        isDev && {
-          type: 'separator',
-        },
+        isDev
+          ? {
+              type: 'separator',
+            }
+          : { label: 'hidden', visible: false },
         {
-          role: 'resetzoom',
+          role: 'resetZoom',
         },
         {
-          role: 'zoomin',
+          role: 'zoomIn',
         },
         {
-          role: 'zoomout',
+          role: 'zoomOut',
         },
         {
           type: 'separator',
         },
         {
           role: 'togglefullscreen',
         },
-      ].filter(x => x),
+      ],
     },
     {
       label: 'Tools',
       submenu: [
         {
           label: 'Find schedules',
           enabled: false,
-          click: function (menuItem, focusedWin) {
-            focusedWin.webContents.executeJavaScript(
-              'window.__actionsForMenu && window.__actionsForMenu.pushModal("schedules-discover")',
-            );
+          click: function (_menuItem, focusedWin) {
+            if (focusedWin) {
+              focusedWin.webContents.executeJavaScript(
+                'window.__actionsForMenu && window.__actionsForMenu.pushModal("schedules-discover")',
+              );
+            }
           },
         },
       ],
@@ -160,7 +184,9 @@ function getMenu(isDev, createWindow, budgetId) {
 
   if (process.platform === 'win32') {
     // Add about to help menu on Windows
-    template[template.length - 1].submenu.unshift({
+    (
+      template[template.length - 1].submenu as MenuItemConstructorOptions[]
+    ).unshift({
       label: 'About Actual',
       click() {
         ipcMain.emit('show-about');
@@ -177,12 +203,14 @@ function getMenu(isDev, createWindow, budgetId) {
             ipcMain.emit('show-about');
           },
         },
-        isDev && {
-          label: 'Screenshot',
-          click() {
-            ipcMain.emit('screenshot');
-          },
-        },
+        isDev
+          ? {
+              label: 'Screenshot',
+              click() {
+                ipcMain.emit('screenshot');
+              },
+            }
+          : { label: 'hidden', visible: false },
         {
           type: 'separator',
         },
@@ -197,7 +225,7 @@ function getMenu(isDev, createWindow, budgetId) {
           role: 'hide',
         },
         {
-          role: 'hideothers',
+          role: 'hideOthers',
         },
         {
           role: 'unhide',
@@ -208,22 +236,22 @@ function getMenu(isDev, createWindow, budgetId) {
         {
           role: 'quit',
         },
-      ].filter(x => x),
+      ],
     });
     // Edit menu.
     const editIdx = template.findIndex(t => t.label === 'Edit');
-    template[editIdx].submenu.push(
+    (template[editIdx].submenu as MenuItemConstructorOptions[]).push(
       {
         type: 'separator',
       },
       {
         label: 'Speech',
         submenu: [
           {
-            role: 'startspeaking',
+            role: 'startSpeaking',
           },
           {
-            role: 'stopspeaking',
+            role: 'stopSpeaking',
           },
         ],
       },
@@ -257,5 +285,3 @@ function getMenu(isDev, createWindow, budgetId) {
 
   return Menu.buildFromTemplate(template);
 }
-
-module.exports = getMenu;
diff --git a/upcoming-release-notes/2978.md b/upcoming-release-notes/2978.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MikesGlitch]
+---
+
+Update Electron menu to use typescript