refactor: improve code structure (#45)

* refactor electron module

* feat(updater): implement app updater with auto-update functionality

- Added AppUpdater class to handle application updates using electron-updater.
- Implemented methods for checking updates, downloading, and installing updates.
- Introduced WebUpdater class as a placeholder for future web resource hot-reload logic.
- Created types for AppUpdateState and UpdaterStatus in shared-types package.
- Updated IPC communication to include app update state messages.
- Enhanced the web application to display update status and control updates.
- Improved UI with new styles and layout for the update control panel.
- Added error handling and logging for update processes.

* fix: correct usage of import.meta.dirname in catchException and appConfig

* refactor: update publish workflow to trigger on main branch and change release type to release

Author: buqiyuan

.github/workflows/build.yml .github/workflows/publish-app.yml.github/workflows/build.yml renamed to .github/workflows/publish-app.yml

@@ -1,4 +1,4 @@
-name: Build
+name: Publish Electron App
 
 on:
   push:
@@ -45,7 +45,7 @@ jobs:
       - name: Release for Windows
         if: matrix.os == 'windows-latest'
         run: |
-          pnpm pack:dev
+          pnpm pack:prod
 
       - name: Release for MacOS
         if: matrix.os == 'macos-latest'
@@ -80,9 +80,9 @@ jobs:
           # apply provisioning profile
           mkdir -p ~/Library/MobileDevice/Provisioning\ Profiles
           cp $PP_PATH ~/Library/MobileDevice/Provisioning\ Profiles
-          pnpm pack:dev
+          pnpm pack:prod
 
       - name: Release for Linux
         if: matrix.os == 'ubuntu-latest'
         run: |
-          pnpm pack:dev
+          pnpm pack:prod

.npmrc

@@ -1,9 +1,6 @@
 
 package-manager-strict=false
 
-# https://github.com/electron-userland/electron-builder/issues/8346
-virtual-store-dir-max-length=70
-
 # 使用淘宝镜像源
 registry = https://registry.npmmirror.com
 # registry = https://registry.npmjs.org

.vscode/extensions.json

@@ -0,0 +1,20 @@
+{
+  "recommendations": [
+    // Vue 3 的语言支持
+    "Vue.volar",
+    // 将 ESLint JavaScript 集成到 VS Code 中。
+    "dbaeumer.vscode-eslint",
+    // 支持 dotenv 文件语法
+    "mikestead.dotenv",
+    // 源代码的拼写检查器
+    "streetsidesoftware.code-spell-checker",
+    // Tailwind CSS 的官方 VS Code 插件
+    "bradlc.vscode-tailwindcss",
+    // 在 package.json 文件中显示可用更新
+    "codeandstuff.package-json-upgrade"
+  ],
+  "unwantedRecommendations": [
+    // 和 volar 冲突
+    "octref.vetur"
+  ]
+}

.vscode/settings.json

@@ -1,28 +1,66 @@
 {
+  "typescript.preferences.importModuleSpecifier": "non-relative",
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
-  "editor.formatOnSave": true,
-
+  "editor.formatOnSave": false,
   // Auto fix
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit",
     "source.organizeImports": "never"
   },
-
-  // Silent the stylistic rules in you IDE, but still auto fix them
+  // Silent the stylistic rules in your IDE, but still auto fix them
   "eslint.rules.customizations": [
-    { "rule": "style/*", "severity": "off", "fixable": true },
-    { "rule": "format/*", "severity": "off", "fixable": true },
-    { "rule": "*-indent", "severity": "off", "fixable": true },
-    { "rule": "*-spacing", "severity": "off", "fixable": true },
-    { "rule": "*-spaces", "severity": "off", "fixable": true },
-    { "rule": "*-order", "severity": "off", "fixable": true },
-    { "rule": "*-dangle", "severity": "off", "fixable": true },
-    { "rule": "*-newline", "severity": "off", "fixable": true },
-    { "rule": "*quotes", "severity": "off", "fixable": true },
-    { "rule": "*semi", "severity": "off", "fixable": true }
+    {
+      "rule": "style/*",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "format/*",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-indent",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-spacing",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-spaces",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-order",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-dangle",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*-newline",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*quotes",
+      "severity": "off",
+      "fixable": true
+    },
+    {
+      "rule": "*semi",
+      "severity": "off",
+      "fixable": true
+    }
   ],
-
   // Enable eslint for all supported languages
   "eslint.validate": [
     "javascript",
@@ -40,6 +78,7 @@
     "gql",
     "graphql",
     "astro",
+    "svelte",
     "css",
     "less",
     "scss",

apps/electron/.electron-vendors.cache.json

@@ -1 +1 @@
-{ "chrome": "134", "node": "22" }
+{"chrome":"142","node":"22"}

apps/electron/.env.development

@@ -1,3 +1,3 @@
 # 测试环境配置
 NODE_ENV=development
-VITE_APP_VERSION=0.2.0
+VITE_APP_VERSION=0.0.1

apps/electron/dev-app-update.yml

@@ -1,2 +1,8 @@
-provider: generic
-url: 'http://localhost:8080'
+# provider: generic
+# url: 'http://localhost:8080'
+
+provider: github
+owner: buqiyuan
+repo: electron-vite-monorepo
+releaseType: release # 如果构建脚本发布成 Draft，可保留；否则设为 release/latest
+private: false # 若仓库私有则改为 true 并提供 token

apps/electron/package.json

@@ -1,5 +1,6 @@
 {
   "name": "electron-main",
+  "type": "module",
   "version": "0.2.0",
   "private": false,
   "description": "Electron main process",
@@ -13,33 +14,37 @@
     "type": "git",
     "url": "https://github.com/buqiyuan/electron-vite-monorepo.git"
   },
-  "main": "dist-vite/index.cjs",
+  "main": "dist-vite/index.mjs",
   "engines": {
     "node": ">=22.0.0"
   },
   "scripts": {
-    "bundle": "npx rimraf ./dist && webpack --config webpack.config.js",
+    "bundle": "npx rimraf ./dist && webpack --config webpack.config.cjs",
     "build:dev": "vite build --mode development && pnpm bundle",
     "build:prod": "vite build && pnpm bundle",
-    "pack:app": "npx tsx scripts/build.ts",
+    "pack:app": "npx tsx scripts/build.mts",
     "pack:dev": "pnpm build:dev && dotenvx run -f .env.development -- pnpm pack:app",
     "pack:prod": "pnpm build:prod && dotenvx run -f .env.production -- pnpm pack:app",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "install:electron": "cross-env ELECTRON_GET_USE_PROXY=true node node_modules/electron/install.js",
-    "gen:vendors": "cross-env ELECTRON_RUN_AS_NODE=1 electron ./scripts/update-electron-vendors.js",
+    "gen:vendors": "cross-env ELECTRON_RUN_AS_NODE=1 electron ./scripts/update-electron-vendors.mjs",
     "postinstall": "pnpm install:electron && pnpm gen:vendors"
   },
   "devDependencies": {
-    "@electron/notarize": "^3.0.1",
+    "@electron/notarize": "^3.1.1",
     "@repo/electron-preload": "workspace:*",
+    "@repo/shared-types": "workspace:*",
     "@types/node": "^22.14.1",
-    "electron": "35.1.4",
-    "electron-builder": "26.0.12",
+    "date-fns": "^4.1.0",
+    "electron": "39.2.6",
+    "electron-builder": "26.3.4",
+    "electron-log": "^5.4.3",
+    "electron-store": "^11.0.2",
     "electron-updater": "6.6.2",
-    "terser-webpack-plugin": "^5.3.14",
-    "typescript": "5.8.3",
-    "vite": "6.2.6",
-    "webpack": "^5.99.5",
+    "terser-webpack-plugin": "^5.3.15",
+    "typescript": "catalog:",
+    "vite": "catalog:",
+    "webpack": "^5.103.0",
     "webpack-cli": "^6.0.1"
   }
 }

apps/electron/resources/tray.png

@@ -2,7 +2,7 @@ import type { Configuration } from 'electron-builder'
 import type { CopySyncOptions } from 'node:fs'
 import { cpSync } from 'node:fs'
 import path from 'node:path'
-import process, { exit, platform } from 'node:process'
+import process, { exit } from 'node:process'
 import { build, Platform } from 'electron-builder'
 
 const version = process.env.VITE_APP_VERSION
@@ -11,15 +11,15 @@ const appName = isDev ? 'ElectronAppDev' : 'ElectronApp'
 const appId = isDev ? 'com.electron.app' : 'com.electron-dev.app'
 const shortcutName = isDev ? 'Electron App Dev' : 'Electron App'
 
-console.log('是否是测试环境：', isDev, appName)
-console.log('APP 版本号：', version)
+console.log('Development environment:', isDev, appName)
+console.log('APP version:', version)
 
-const workDir = path.join(__dirname, '../')
+const workDir = path.join(import.meta.dirname, '../')
 
 const copySyncOptions: CopySyncOptions = {
   recursive: true,
   /**
-   * 过滤 source map 文件
+   * Filter out source map files
    */
   filter: src => !src.endsWith('.map') && !src.endsWith('.d.ts'),
 }
@@ -37,7 +37,7 @@ const options: Configuration = {
   extraMetadata: {
     version,
     name: appName,
-    main: 'dist/main.cjs',
+    main: 'dist/main.mjs',
   },
   directories: {
     output: '../../out',
@@ -111,24 +111,17 @@ const options: Configuration = {
   ],
 }
 
-// 要打包的目标平台
-const targetPlatform: Platform = {
-  darwin: Platform.MAC,
-  win32: Platform.WINDOWS,
-  linux: Platform.LINUX,
-}[platform]
-
 build({
-  targets: targetPlatform.createTarget(),
+  targets: Platform.current().createTarget(),
   config: options,
   publish: process.env.CI ? 'always' : 'never',
 })
   .then((result) => {
     console.log(JSON.stringify(result))
     const outDir = path.join(workDir, options.directories!.output!)
-    console.log('\x1B[32m', `打包完成🎉🎉🎉你要的都在 ${outDir} 目录里🤪🤪🤪`)
+    console.log('\x1B[32m', `Build complete! 🎉🎉🎉 Everything you need is in ${outDir}`)
   })
   .catch((error) => {
-    console.log('\x1B[31m', '打包失败，错误信息：', error)
+    console.log('\x1B[31m', 'Build failed with error:', error)
     exit(1)
   })