More changes

Author: hovancik

.github/copilot-instructions.md

@@ -0,0 +1,28 @@
+# Stretchly Development Assistant
+
+You are a specialized assistant for developers working on Stretchly, a break-time reminder application that encourages regular stretching and healthy work habits.
+
+## Technical Stack
+- ElectronJS for cross-platform desktop functionality
+- NodeJS backend
+- JavaScript (following StandardJS style guidelines) using ESM (ECMAScript Modules)
+- HTML and CSS for UI components
+
+## Development Guidelines
+- Follow StandardJS style (like no semicolons, 2-space indentation)
+- Prefer ES6+ features (like arrow functions, destructuring, etc.)
+- Maintain cross-platform compatibility (Windows, macOS, Linux)
+- Use appropriate Electron APIs for native functionality
+- Maintain accessibility standards in UI components
+- Keep performance in mind, especially for background processes
+
+## Code Organization
+- Respect the existing project structure
+- Place new functionality in appropriate modules
+- Follow the established patterns for event handling
+
+## Testing Expectations
+- Suggest tests for new functionality
+- Consider edge cases in different operating systems
+
+When suggesting code changes, explain your reasoning and how they align with Stretchly's goals of promoting healthy computer use.

app/break-preload.mjs

@@ -1,7 +1,7 @@
 import { contextBridge, ipcRenderer } from 'electron'
 import humanizeDuration from 'humanize-duration'
 import * as utils from './utils/utils.js'
-import './expose-process.js'
+import './exposes/expose-process.js'
 
 contextBridge.exposeInMainWorld('i18next', {
   t: (key, options) => ipcRenderer.invoke('i18next-translate', key, options),

app/contributor-preferences-preload.mjs

@@ -1,5 +1,5 @@
 import { ipcRenderer, contextBridge } from 'electron'
-import './expose-process.js'
+import './exposes/expose-process.js'
 
 contextBridge.exposeInMainWorld('settings', {
   currentSettings: async () => {

app/expose-process.js app/exposes/expose-process.jsapp/expose-process.js renamed to app/exposes/expose-process.js

@@ -1,7 +1,7 @@
 import { contextBridge, ipcRenderer } from 'electron'
 import humanizeDuration from 'humanize-duration'
 import * as utils from './utils/utils.js'
-import './expose-process.js'
+import './exposes/expose-process.js'
 
 contextBridge.exposeInMainWorld('i18next', {
   t: (key, options) => ipcRenderer.invoke('i18next-translate', key, options),

app/microbreak-preload.mjs

@@ -1,37 +1,7 @@
-import { ipcRenderer, shell, contextBridge } from 'electron'
-import './expose-process.js'
+import { exposeGlobal, exposeI18next, exposeProcess, exposeSettings, exposeStretchly } from './utils/context-bridge-exposers.js'
 
-contextBridge.exposeInMainWorld('settings', {
-  currentSettings: async () => {
-    return await ipcRenderer.invoke('current-settings')
-  },
-  saveSettings: async (key, value) => {
-    ipcRenderer.send('save-setting', key, value)
-  }
-})
-
-contextBridge.exposeInMainWorld('i18next', {
-  t: (key, options) => ipcRenderer.invoke('i18next-translate', key, options),
-  dir: () => ipcRenderer.invoke('i18next-dir')
-})
-
-contextBridge.exposeInMainWorld('electronAPI', {
-  onTranslate: (callback) => ipcRenderer.on('translate', () => callback()),
-  onEnableContributorPreferences: (callback) => ipcRenderer.on('enable-contributor-preferences', () => callback()),
-  openExternal: (path) => shell.openExternal(path),
-  openPath: (path) => shell.openPath(path),
-  getWindowBounds: () => ipcRenderer.invoke('get-window-bounds'),
-  getVersion: () => ipcRenderer.invoke('get-version'),
-  setWindowSize: (width, height) => ipcRenderer.send('set-window-size', width, height),
-  openContributorPreferences: () => ipcRenderer.send('open-contributor-preferences'),
-  openSyncPreferences: () => ipcRenderer.send('open-sync-preferences'),
-  showDebug: () => ipcRenderer.invoke('show-debug'),
-  restoreDefaults: () => ipcRenderer.send('restore-defaults'),
-  playSound: (name) => ipcRenderer.send('play-sound', name),
-  openContributorAuth: (provider) => ipcRenderer.send('open-contributor-auth', provider)
-})
-
-contextBridge.exposeInMainWorld('global', {
-  setValue: (name, value) => ipcRenderer.send('set-global-value', name, value),
-  getValue: (name) => ipcRenderer.invoke('get-global-value', name)
-})
+exposeGlobal()
+exposeI18next()
+exposeProcess()
+exposeSettings()
+exposeStretchly()

app/preferences-preload.mjs

@@ -8,7 +8,7 @@ const versionChecker = new VersionChecker()
 let eventsAttached = false
 
 window.onload = async (e) => {
-  const bounds = await window.electronAPI.getWindowBounds()
+  const bounds = await window.stretchly.getWindowBounds()
   const settings = await window.settings.currentSettings()
 
   new HtmlTranslate(document).translate()
@@ -50,7 +50,7 @@ window.onload = async (e) => {
       const [
         reference, timeleft, breaknumber,
         postponesnumber, settingsfile, logsfile, doNotDisturb
-      ] = await window.electronAPI.showDebug()
+      ] = await window.stretchly.showDebug()
       const debugInfo = document.querySelector('.debug > :first-child')
       if (debugInfo.style.display === 'block') {
         debugInfo.style.display = 'none'
@@ -73,7 +73,7 @@ window.onload = async (e) => {
     }
   }
 
-  window.electronAPI.onTranslate(async () => {
+  window.stretchly.onTranslate(async () => {
     new HtmlTranslate(document).translate()
     document.querySelectorAll('input[type="range"]').forEach(async range => {
       const settings = await window.settings.currentSettings()
@@ -88,7 +88,7 @@ window.onload = async (e) => {
     setWindowHeight()
   })
 
-  window.electronAPI.onEnableContributorPreferences(() => {
+  window.stretchly.onEnableContributorPreferences(() => {
     showContributorPreferencesButton()
   })
 
@@ -111,12 +111,12 @@ window.onload = async (e) => {
 
   document.querySelector('[name="contributorPreferences"]').onclick = (event) => {
     event.preventDefault()
-    window.electronAPI.openContributorPreferences()
+    window.stretchly.openContributorPreferences()
   }
 
   document.querySelector('[name="syncPreferences"]').onclick = (event) => {
     event.preventDefault()
-    window.electronAPI.openSyncPreferences()
+    window.stretchly.openSyncPreferences()
   }
 
   // TODO refactor out?
@@ -226,7 +226,7 @@ window.onload = async (e) => {
   document.querySelectorAll('.sounds img').forEach(preview => {
     if (!eventsAttached) {
       preview.onclick = (event) =>
-        window.electronAPI.playSound(preview.closest('div').querySelector('input').value)
+        window.stretchly.playSound(preview.closest('div').querySelector('input').value)
     }
   })
 
@@ -248,22 +248,22 @@ window.onload = async (e) => {
   })
 
   document.querySelector('.settings > div > button').onclick = (event) => {
-    window.electronAPI.restoreDefaults()
+    window.stretchly.restoreDefaults()
   }
 
   document.querySelectorAll('.about a').forEach((item) => {
     item.onclick = (event) => {
       event.preventDefault()
       if (event.target.classList.contains('file')) {
-        window.electronAPI.openPath(event.target.innerHTML)
+        window.electronApi.openPath(event.target.innerHTML)
       } else {
-        window.electronAPI.openExternal(event.target.href)
+        window.electronApi.openExternal(event.target.href)
       }
     }
   })
 
   document.querySelector('[name="becomePatron"]').onclick = () => {
-    window.electronAPI.openExternal('https://hovancik.net/stretchly/sponsor')
+    window.electronApi.openExternal('https://hovancik.net/stretchly/sponsor')
   }
 
   document.querySelector('[name="alreadyContributor"]').onclick = () => {
@@ -279,11 +279,11 @@ window.onload = async (e) => {
   document.querySelectorAll('.authenticate a').forEach((button) => {
     button.onclick = (event) => {
       event.preventDefault()
-      window.electronAPI.openContributorAuth(button.dataset.provider)
+      window.stretchly.openContributorAuth(button.dataset.provider)
     }
   })
 
-  document.querySelector('.version').innerHTML = await window.electronAPI.getVersion()
+  document.querySelector('.version').innerHTML = await window.stretchly.getVersion()
   versionChecker.latest()
     .then(version => {
       document.querySelector('.latestVersion').innerHTML = version.replace('v', '')
@@ -312,7 +312,7 @@ window.onload = async (e) => {
       }
     }
     if (height) {
-      window.electronAPI.setWindowSize(bounds.width, height)
+      window.stretchly.setWindowSize(bounds.width, height)
     }
   }
 

app/preferences-renderer.js

@@ -1,42 +1,17 @@
-import { contextBridge, ipcRenderer, shell } from 'electron'
-import semver from 'semver'
-import * as utils from './utils/utils.js'
+import {
+  exposeElectronApi,
+  exposeGlobal,
+  exposeI18next,
+  exposeProcess,
+  exposeSemver,
+  exposeStretchly,
+  exposeUtils
+} from './utils/context-bridge-exposers.js'
 
-contextBridge.exposeInMainWorld('electronAPI', {
-  onPlaySound: (callback) => ipcRenderer.on('play-sound',
-    (_event, file, volume) => callback(file, volume)),
-  onShowNotification: (callback) => ipcRenderer.on('show-notification',
-    (_event, text, silent) => callback(text, silent)),
-  onCheckVersion: (callback) => ipcRenderer.on('check-version',
-    (_event, oldVersion, notify, silent) => callback(oldVersion, notify, silent)),
-  updateTray: () => ipcRenderer.send('update-tray'),
-  openExternal: (path) => shell.openExternal(path)
-})
-
-contextBridge.exposeInMainWorld('semver', {
-  valid: (version) => semver.valid(version),
-  clean: (version) => semver.clean(version),
-  coerce: (version) => semver.coerce(version),
-  gt: (a, b) => semver.gt(a, b),
-  gte: (a, b) => semver.gte(a, b)
-})
-
-contextBridge.exposeInMainWorld('process', {
-  platform: () => process.platform,
-  getSystemVersion: () => process.getSystemVersion()
-})
-
-contextBridge.exposeInMainWorld('global', {
-  setValue: (name, value) => ipcRenderer.send('set-global-value', name, value),
-  getValue: (name) => ipcRenderer.invoke('get-global-value', name)
-})
-
-contextBridge.exposeInMainWorld('i18next', {
-  t: (key, options) => ipcRenderer.invoke('i18next-translate', key, options)
-})
-
-contextBridge.exposeInMainWorld('utils', {
-  shouldShowNotificationTitle: (platform, systemVersion) => {
-    return utils.shouldShowNotificationTitle(platform, systemVersion, semver)
-  }
-})
+exposeElectronApi()
+exposeGlobal()
+exposeI18next()
+exposeProcess()
+exposeStretchly()
+exposeSemver()
+exposeUtils()

app/process-preload.mjs

@@ -1,14 +1,14 @@
 import VersionChecker from './utils/versionChecker.js'
 
 window.onload = async (e) => {
-  window.electronAPI.onPlaySound((file, volume) => {
+  window.stretchly.onPlaySound((file, volume) => {
     __electronLog.info(`Stretchly: playing audio/${file}.wav (volume: ${volume})`)
     const audio = new Audio(`audio/${file}.wav`)
     audio.volume = volume
     audio.play()
   })
 
-  window.electronAPI.onShowNotification(async (text, silent) => {
+  window.stretchly.onShowNotification(async (text, silent) => {
     __electronLog.info(`Stretchly: showing notification "${text}" (silent: ${silent})`)
     const title = await window.utils.shouldShowNotificationTitle(
       await window.process.platform,
@@ -24,7 +24,7 @@ window.onload = async (e) => {
     setTimeout(() => notification.close(), 7000)
   })
 
-  window.electronAPI.onCheckVersion(async (oldVersion, notify, silent) => {
+  window.stretchly.onCheckVersion(async (oldVersion, notify, silent) => {
     if (window.global.getValue('isNewVersion') && notify) {
       notifyNewVersion(silent)
     } else {
@@ -36,7 +36,7 @@ window.onload = async (e) => {
             __electronLog.info(`Stretchly: checking for new version (local: ${oldVersion}, remote: ${cleanVersion})`)
             if (await window.semver.valid(cleanVersion) && await window.semver.gt(cleanVersion, oldVersion)) {
               await window.global.setValue('isNewVersion', true)
-              window.electronAPI.updateTray()
+              window.stretchly.updateTray()
               if (notify) {
                 notifyNewVersion(silent)
               }
@@ -55,6 +55,6 @@ window.onload = async (e) => {
       body: await window.i18next.t('process.newVersionAvailable'),
       silent
     })
-    notification.onclick = () => window.electronAPI.openExternal('https://hovancik.net/stretchly/downloads')
+    notification.onclick = () => window.electronApi.openExternal('https://hovancik.net/stretchly/downloads')
   }
 }