Merging development into main for 0.20.0 release

A series of improvements and bug-fixes

Author: ubidefeo

.github/workflows/build.yml

@@ -24,9 +24,11 @@ jobs:
       matrix:
         config:
           - os: [self-hosted, windows-sign-pc]
+            id: windows
           - os: ubuntu-latest
-          - os: macos-13
-          - os: macos-14
+            id: linux
+          - os: macos-latest
+            id: macos-universal
     runs-on: ${{ matrix.config.os }}
     timeout-minutes: 90
 
@@ -92,9 +94,9 @@ jobs:
             npm run build
 
       - name: Upload [GitHub Actions]
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          name: ${{ env.JOB_TRANSFER_ARTIFACT }}-${{ matrix.config.id }}
           path: dist
 
   artifacts:
@@ -108,26 +110,29 @@ jobs:
         artifact:
           - path: "*-linux_x64.zip"
             name: Arduino-Lab-for-MicroPython_Linux_X86-64
-          - path: "*-mac_x64.zip"
-            name: Arduino-Lab-for-MicroPython_macOS_X86-64
-          - path: "*-mac_arm64.zip"
-            name: Arduino-Lab-for-MicroPython_macOS_arm-64
+            id: linux
+          - path: "*-mac_universal.zip"
+            name: Arduino-Lab-for-MicroPython_macOS_Universal
+            id: macos-universal
           # - path: "*Windows_64bit.exe"
           #   name: Windows_X86-64_interactive_installer
+          #   id: windows
           # - path: "*Windows_64bit.msi"
           #   name: Windows_X86-64_MSI
+          #   id: windows
           - path: "*-win_x64.zip"
             name: Arduino-Lab-for-MicroPython_Windows_X86-64
+            id: windows
 
     steps:
       - name: Download job transfer artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          name: ${{ env.JOB_TRANSFER_ARTIFACT }}-${{ matrix.artifact.id }}
           path: ${{ env.JOB_TRANSFER_ARTIFACT }}
 
       - name: Upload tester build artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.artifact.name }}
           path: ${{ env.JOB_TRANSFER_ARTIFACT }}/${{ matrix.artifact.path }}
@@ -137,23 +142,25 @@ jobs:
     if: github.repository == 'arduino/lab-micropython-editor' && startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
-      - name: Download [GitHub Actions]
-        uses: actions/download-artifact@v3
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
         with:
-          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
-          path: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          path: artifacts
+          
+      - name: List artifacts
+        run: ls -R artifacts
 
       - name: Get Tag
         id: tag_name
         run: |
-          echo ::set-output name=TAG_NAME::${GITHUB_REF#refs/tags/}
+          echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
 
       - name: Publish Release [GitHub]
         uses: svenstaro/[email protected]
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           release_name: ${{ steps.tag_name.outputs.TAG_NAME }}
-          file: ${{ env.JOB_TRANSFER_ARTIFACT }}/*
+          file: artifacts/**/*
           tag: ${{ github.ref }}
           file_glob: true
 
@@ -167,7 +174,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Remove unneeded job transfer artifact
+      - name: Remove unneeded job transfer artifacts
         uses: geekyeggo/delete-artifact@v2
         with:
-          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          name: |
+            ${{ env.JOB_TRANSFER_ARTIFACT }}-windows
+            ${{ env.JOB_TRANSFER_ARTIFACT }}-linux
+            ${{ env.JOB_TRANSFER_ARTIFACT }}-macos-x64
+            ${{ env.JOB_TRANSFER_ARTIFACT }}-macos-arm64

backend/ipc.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const registerMenu = require('./menu.js')
 const serial = require('./serial/serial.js').sharedInstance
+const { shell } = require('electron');
 
 const {
   openFolderDialog,
@@ -138,6 +139,30 @@ module.exports = function registerIPCHandlers(win, ipcMain, app, dialog) {
     registerMenu(win, state)
   })
 
+  ipcMain.handle('launch-app', async (event, urlScheme) => {
+    // Launch an external app with a custom protocol
+    return new Promise((resolve, reject) => {
+      if(app.getApplicationNameForProtocol(urlScheme) === '') {        
+        resolve(false); // App not installed
+        return;
+      }
+
+      try {
+        shell.openExternal(urlScheme).then(() => {
+          resolve(true);  // App opened successfully
+        }).catch(() => {
+          resolve(false);  // App not installed
+        });
+      } catch (err) {
+        reject(err);
+      }
+    });
+  });
+  
+  ipcMain.handle('open-url', async (event, url) => {
+    shell.openExternal(url);
+  });
+
   win.on('close', (event) => {
     console.log('BrowserWindow', 'close')
     event.preventDefault()

backend/menu.js

@@ -1,18 +1,49 @@
 const { app, Menu } = require('electron')
+const { shortcuts, disableShortcuts } = require('./shortcuts.js')
 const path = require('path')
 const serial = require('./serial/serial.js').sharedInstance
 const openAboutWindow = require('about-window').default
-const shortcuts  = require('./shortcuts.js')
+
 const { type } = require('os')
 
+let appInfoWindow = null
+
+function closeAppInfo(win) {
+  disableShortcuts(win, false)
+  appInfoWindow.off('close', () => closeAppInfo(win))
+  appInfoWindow = null
+  
+}
+function openAppInfo(win) {
+  if (appInfoWindow != null) {
+    appInfoWindow.show()
+  } else {
+    appInfoWindow = openAboutWindow({
+      icon_path: path.resolve(__dirname, '../ui/arduino/media/about_image.png'),
+      css_path: path.resolve(__dirname, '../ui/arduino/views/about.css'),
+      copyright: '© Arduino SA 2022',
+      package_json_dir: path.resolve(__dirname, '..'),
+      bug_report_url: "https://github.com/arduino/lab-micropython-editor/issues",
+      bug_link_text: "report an issue",
+      homepage: "https://labs.arduino.cc",
+      use_version_info: false,
+      win_options: {
+          parent: win,
+          modal: true,
+      },
+      show_close_button: 'Close',
+    })
+    appInfoWindow.on('close', () => closeAppInfo(win));
+    disableShortcuts(win, true)
+  }
+}
+
 module.exports = function registerMenu(win, state = {}) {
   const isMac = process.platform === 'darwin'
   const template = [
     ...(isMac ? [{
       label: app.name,
       submenu: [
-        { role: 'about'},
-        { type: 'separator' },
         { type: 'separator' },
         { role: 'hide', accelerator: 'CmdOrCtrl+Shift+H' },
         { role: 'hideOthers' },
@@ -24,7 +55,22 @@ module.exports = function registerMenu(win, state = {}) {
     {
       label: 'File',
       submenu: [
-        isMac ? { role: 'close' } : { role: 'quit' }
+        { label: 'New', 
+          accelerator: shortcuts.menu.NEW,
+          enabled: state.view === 'editor',
+          click: () => win.webContents.send('shortcut-cmd', shortcuts.global.NEW)
+        },
+        { label: 'Save', 
+          accelerator: shortcuts.menu.SAVE,
+          enabled: state.view === 'editor',
+          click: () => win.webContents.send('shortcut-cmd', shortcuts.global.SAVE)
+        },
+        { label: 'Close tab',
+          accelerator: 'CmdOrCtrl+W',
+          enabled: state.view === 'editor',
+          click: () => win.webContents.send('shortcut-cmd', shortcuts.global.CLOSE)
+         },
+        { role: 'quit' }
       ]
     },
     {
@@ -167,41 +213,15 @@ module.exports = function registerMenu(win, state = {}) {
           }
         },
         {
-          label:'Info about this app',
-          click: () => {
-              openAboutWindow({
-                  icon_path: path.resolve(__dirname, '../ui/arduino/media/about_image.png'),
-                  css_path: path.resolve(__dirname, '../ui/arduino/views/about.css'),
-                  copyright: '© Arduino SA 2022',
-                  package_json_dir: path.resolve(__dirname, '..'),
-                  bug_report_url: "https://github.com/arduino/lab-micropython-editor/issues",
-                  bug_link_text: "report an issue",
-                  homepage: "https://labs.arduino.cc",
-                  use_version_info: false,
-                  win_options: {
-                      parent: win,
-                      modal: true,
-                  },
-                  show_close_button: 'Close',
-              })
-            }
+          label:'About Arduino Lab for MicroPython',
+          click: () => { openAppInfo(win) }
         },
       ]
     }
   ]
 
   const menu = Menu.buildFromTemplate(template)
 
-  app.setAboutPanelOptions({
-    applicationName: app.name,
-    applicationVersion: app.getVersion(),
-    copyright: app.copyright,
-    credits: '(See "Info about this app" in the Help menu)',
-    authors: ['Arduino'],
-    website: 'https://arduino.cc',
-    iconPath: path.join(__dirname, '../assets/image.png'),
-  })
-
   Menu.setApplicationMenu(menu)
 
 }

backend/serial/serial-bridge.js

@@ -97,7 +97,7 @@ const SerialBridge = {
     return path.posix.join(navigation, target)
   },
   getFullPath: (root, navigation, file) => {
-    return path.posix.join(root, navigation, file)
+    return path.posix.join(root, navigation.replaceAll(path.win32.sep, path.posix.sep), file.replaceAll(path.win32.sep, path.posix.sep))
   },
   getParentPath: (navigation) => {
     return path.posix.dirname(navigation)

backend/shortcuts.js

@@ -1,29 +1,46 @@
-module.exports = {
+const { globalShortcut } = require('electron')
+let shortcutsActive = false
+const shortcuts = {
   global: {
+    CLOSE: 'CommandOrControl+W',
     CONNECT: 'CommandOrControl+Shift+C',
     DISCONNECT: 'CommandOrControl+Shift+D',
-    SAVE: 'CommandOrControl+S',
     RUN: 'CommandOrControl+R',
     RUN_SELECTION: 'CommandOrControl+Alt+R',
     RUN_SELECTION_WL: 'CommandOrControl+Alt+S',
     STOP: 'CommandOrControl+H',
     RESET: 'CommandOrControl+Shift+R',
+    NEW: 'CommandOrControl+N',
+    SAVE: 'CommandOrControl+S',
     CLEAR_TERMINAL: 'CommandOrControl+L',
     EDITOR_VIEW: 'CommandOrControl+Alt+1',
     FILES_VIEW: 'CommandOrControl+Alt+2',
-    ESC: 'Escape'
   },
   menu: {
+    CLOSE: 'CmdOrCtrl+W',
     CONNECT: 'CmdOrCtrl+Shift+C',
     DISCONNECT: 'CmdOrCtrl+Shift+D',
-    SAVE: 'CmdOrCtrl+S',
     RUN: 'CmdOrCtrl+R',
     RUN_SELECTION: 'CmdOrCtrl+Alt+R',
     RUN_SELECTION_WL: 'CmdOrCtrl+Alt+S',
     STOP: 'CmdOrCtrl+H',
     RESET: 'CmdOrCtrl+Shift+R',
+    NEW: 'CmdOrCtrl+N',
+    SAVE: 'CmdOrCtrl+S',
     CLEAR_TERMINAL: 'CmdOrCtrl+L',
     EDITOR_VIEW: 'CmdOrCtrl+Alt+1',
     FILES_VIEW: 'CmdOrCtrl+Alt+2'
-  }
+  },
+  // Shortcuts
+}
+
+function disableShortcuts (win, value) {
+  console.log(value ? 'disabling' : 'enabling', 'shortcuts')
+  win.send('ignore-shortcuts', value)
+}
+
+module.exports = {
+  shortcuts,
+  disableShortcuts
 }
+

index.js

@@ -1,8 +1,6 @@
 const { app, BrowserWindow, ipcMain, dialog, globalShortcut } = require('electron')
 const path = require('path')
 const fs = require('fs')
-const shortcuts = require('./backend/shortcuts.js').global
-
 const registerIPCHandlers = require('./backend/ipc.js')
 const registerMenu = require('./backend/menu.js')
 
@@ -14,8 +12,8 @@ let splashTimestamp = null
 function createWindow () {
   // Create the browser window.
   win = new BrowserWindow({
-    width: 720,
-    height: 640,
+    width: 820,
+    height: 700,
     webPreferences: {
       nodeIntegration: false,
       webSecurity: true,
@@ -63,28 +61,13 @@ function createWindow () {
   })
 }
 
-function shortcutAction(key) {
-  win.webContents.send('shortcut-cmd', key);
-}
-
-// Shortcuts
-function registerShortcuts() {
-  Object.entries(shortcuts).forEach(([command, shortcut]) => {
-    globalShortcut.register(shortcut, () => {
-      shortcutAction(shortcut)
-    });
-  })
-}
-
 app.on('ready', () => {
   createWindow()
-  registerShortcuts()
 
   win.on('focus', () => {
-    registerShortcuts()
   })
+
   win.on('blur', () => {
-    globalShortcut.unregisterAll()
   })
 
-})
+})