fix: resolve ipcRenderer no returns (#478)

electron/main/index.ts

@@ -3,14 +3,14 @@ import { release } from 'node:os'
 import { join, dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
-const __filename = fileURLToPath(import.meta.url)
+globalThis.__filename = fileURLToPath(import.meta.url)
-const __dirname = dirname(__filename)
+globalThis.__dirname = dirname(__filename)
 
 // The built directory structure
 //
 // ├─┬ dist-electron
 // │ ├─┬ main
-// │ │ └── index.mjs    > Electron-Main
+// │ │ └── index.js    > Electron-Main
 // │ └─┬ preload
 // │   └── index.mjs    > Preload-Scripts
 // ├─┬ dist
@@ -55,7 +55,7 @@ async function createWindow() {
 
       // Consider using contextBridge.exposeInMainWorld
       // Read more on https://www.electronjs.org/docs/latest/tutorial/context-isolation
-      contextIsolation: false,
+      // contextIsolation: false,
     },
   })
 

electron/preload/index.ts

@@ -1,3 +1,29 @@
+import { ipcRenderer, contextBridge } from 'electron'
+
+// --------- Expose some API to the Renderer process ---------
+contextBridge.exposeInMainWorld('ipcRenderer', {
+  on(...args: Parameters<typeof ipcRenderer.on>) {
+    const [channel, listener] = args
+    return ipcRenderer.on(channel, (event, ...args) => listener(event, ...args))
+  },
+  off(...args: Parameters<typeof ipcRenderer.off>) {
+    const [channel, ...omit] = args
+    return ipcRenderer.off(channel, ...omit)
+  },
+  send(...args: Parameters<typeof ipcRenderer.send>) {
+    const [channel, ...omit] = args
+    return ipcRenderer.send(channel, ...omit)
+  },
+  invoke(...args: Parameters<typeof ipcRenderer.invoke>) {
+    const [channel, ...omit] = args
+    return ipcRenderer.invoke(channel, ...omit)
+  },
+
+  // You can expose other APTs you need here.
+  // ...
+})
+
+// --------- Preload scripts loading ---------
 function domReady(condition: DocumentReadyState[] = ['complete', 'interactive']) {
   return new Promise((resolve) => {
     if (condition.includes(document.readyState)) {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "electron-vue-vite",
   "version": "28.0.0",
-  "main": "dist-electron/main/index.mjs",
+  "main": "dist-electron/main/index.js",
   "description": "Really simple Electron + Vue + Vite boilerplate.",
   "author": "草鞋没号 <308487730@qq.com>",
   "license": "MIT",
@@ -25,15 +25,14 @@
     "preview": "vite preview"
   },
   "devDependencies": {
-    "@vitejs/plugin-vue": "^5.0.1",
+    "@vitejs/plugin-vue": "^5.0.4",
-    "electron": "^28.1.0",
+    "electron": "^29.1.1",
-    "electron-builder": "^24.9.1",
+    "electron-builder": "^24.13.3",
-    "tree-kill": "^1.2.2",
+    "typescript": "^5.4.2",
-    "typescript": "^5.3.3",
+    "vite": "^5.1.5",
-    "vite": "^5.0.10",
+    "vite-plugin-electron": "^0.28.4",
-    "vite-plugin-electron": "^0.28.0-beta.1",
     "vite-plugin-electron-renderer": "^0.14.5",
-    "vue": "^3.4.1",
+    "vue": "^3.4.21",
-    "vue-tsc": "^1.8.27"
+    "vue-tsc": "^2.0.6"
   }
 }

src/demos/ipc.ts

@@ -1,5 +1,4 @@
-import { ipcRenderer } from 'electron'
 
-ipcRenderer.on('main-process-message', (_event, ...args) => {
+window.ipcRenderer.on('main-process-message', (_event, ...args) => {
   console.log('[Receive Main-process message]:', ...args)
 })

src/main.ts

@@ -3,9 +3,9 @@ import App from './App.vue'
 
 import './style.css'
 
-// `nodeIntegration` needs to be enabled in the Main process.
+import './demos/ipc'
+// If you want use Node.js, the`nodeIntegration` needs to be enabled in the Main process.
 // import './demos/node'
-// import './demos/ipc'
 
 createApp(App)
   .mount('#app')

src/vite-env.d.ts

@@ -5,3 +5,8 @@ declare module '*.vue' {
   const component: DefineComponent<{}, {}, any>
   export default component
 }
+
+interface Window {
+  // expose in the `electron/preload/index.ts`
+  ipcRenderer: import('electron').IpcRenderer
+}

vite.config.flat.txt

@@ -0,0 +1,76 @@
+import { rmSync } from 'node:fs'
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import electron from 'vite-plugin-electron'
+import renderer from 'vite-plugin-electron-renderer'
+import pkg from './package.json'
+
+// https://vitejs.dev/config/
+export default defineConfig(({ command }) => {
+  rmSync('dist-electron', { recursive: true, force: true })
+
+  const isServe = command === 'serve'
+  const isBuild = command === 'build'
+  const sourcemap = isServe || !!process.env.VSCODE_DEBUG
+
+  return {
+    plugins: [
+      vue(),
+      electron([
+        {
+          // Main process entry file of the Electron App.
+          entry: 'electron/main/index.ts',
+          onstart({ startup }) {
+            if (process.env.VSCODE_DEBUG) {
+              console.log(/* For `.vscode/.debug.script.mjs` */'[startup] Electron App')
+            } else {
+              startup()
+            }
+          },
+          vite: {
+            build: {
+              sourcemap,
+              minify: isBuild,
+              outDir: 'dist-electron/main',
+              rollupOptions: {
+                // Some third-party Node.js libraries may not be built correctly by Vite, especially `C/C++` addons, 
+                // we can use `external` to exclude them to ensure they work correctly.
+                // Others need to put them in `dependencies` to ensure they are collected into `app.asar` after the app is built.
+                // Of course, this is not absolute, just this way is relatively simple. :)
+                external: Object.keys('dependencies' in pkg ? pkg.dependencies : {}),
+              },
+            },
+          },
+        },
+        {
+          entry: 'electron/preload/index.ts',
+          onstart({ reload }) {
+            // Notify the Renderer process to reload the page when the Preload scripts build is complete, 
+            // instead of restarting the entire Electron App.
+            reload()
+          },
+          vite: {
+            build: {
+              sourcemap: sourcemap ? 'inline' : undefined, // #332
+              minify: isBuild,
+              outDir: 'dist-electron/preload',
+              rollupOptions: {
+                external: Object.keys('dependencies' in pkg ? pkg.dependencies : {}),
+              },
+            },
+          },
+        }
+      ]),
+      // Use Node.js API in the Renderer process
+      renderer(),
+    ],
+    server: process.env.VSCODE_DEBUG && (() => {
+      const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)
+      return {
+        host: url.hostname,
+        port: +url.port,
+      }
+    })(),
+    clearScreen: false,
+  }
+})

vite.config.ts

@@ -1,13 +1,12 @@
-import { rmSync } from 'node:fs'
+import fs from 'node:fs'
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
-import electron from 'vite-plugin-electron'
+import electron from 'vite-plugin-electron/simple'
-import renderer from 'vite-plugin-electron-renderer'
 import pkg from './package.json'
 
 // https://vitejs.dev/config/
 export default defineConfig(({ command }) => {
-  rmSync('dist-electron', { recursive: true, force: true })
+  fs.rmSync('dist-electron', { recursive: true, force: true })
 
   const isServe = command === 'serve'
   const isBuild = command === 'build'
@@ -16,9 +15,9 @@ export default defineConfig(({ command }) => {
   return {
     plugins: [
       vue(),
-      electron([
+      electron({
-        {
+        main: {
-          // Main process entry file of the Electron App.
+          // Shortcut of `build.lib.entry`
           entry: 'electron/main/index.ts',
           onstart({ startup }) {
             if (process.env.VSCODE_DEBUG) {
@@ -42,13 +41,10 @@ export default defineConfig(({ command }) => {
             },
           },
         },
-        {
+        preload: {
-          entry: 'electron/preload/index.ts',
+          // Shortcut of `build.rollupOptions.input`.
-          onstart({ reload }) {
+          // Preload scripts may contain Web assets, so use the `build.rollupOptions.input` instead `build.lib.entry`.
-            // Notify the Renderer process to reload the page when the Preload scripts build is complete, 
+          input: 'electron/preload/index.ts',
-            // instead of restarting the entire Electron App.
-            reload()
-          },
           vite: {
             build: {
               sourcemap: sourcemap ? 'inline' : undefined, // #332
@@ -59,10 +55,12 @@ export default defineConfig(({ command }) => {
               },
             },
           },
-        }
+        },
-      ]),
+        // Ployfill the Electron and Node.js API for Renderer process.
-      // Use Node.js API in the Renderer process
+        // If you want use Node.js in Renderer process, the `nodeIntegration` needs to be enabled in the Main process.
-      renderer(),
+        // See 👉 https://github.com/electron-vite/vite-plugin-electron-renderer
+        renderer: {},
+      }),
     ],
     server: process.env.VSCODE_DEBUG && (() => {
       const url = new URL(pkg.debug.env.VITE_DEV_SERVER_URL)