Merge pull request #228 from electron-vite/v0.28.5

V0.28.5

Author: caoxiemeihao

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.28.5 (2024-04-19)
+
+- f325403 chore: update comments
+- 5ebd3a6 Merge pull request #229 from ThatKawaiiSam/feat/custom-electron-fork
+- dbc85dc feat: allow custom electron forks in `startup` call
+- 8b076be chore: update deprecated API
+
+**Contributors:**
+
+- [#229](https://github.com/electron-vite/vite-plugin-electron/pull/229)@[ThatKawaiiSam](https://github.com/ThatKawaiiSam)
+
 ## 0.28.4 (2024-03-17)
 
 - 4f7748c chore: restore `vite-plugin-electron-renderer` in `peerDependencies`

README.md

@@ -146,6 +146,8 @@ export interface ElectronOptions {
      * Electron App startup function.
      * It will mount the Electron App child-process to `process.electronApp`.
      * @param argv default value `['.', '--no-sandbox']`
+     * @param options options for `child_process.spawn`
+     * @param customElectronPkg custom electron package name (default: 'electron')
      */
     startup: (argv?: string[], options?: import('node:child_process').SpawnOptions) => Promise<void>
     /** Reload Electron-Renderer */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-electron",
-  "version": "0.28.4",
+  "version": "0.28.5",
   "description": "Electron 🔗 Vite",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/index.ts

@@ -32,6 +32,8 @@ export interface ElectronOptions {
      * Electron App startup function.
      * It will mount the Electron App child-process to `process.electronApp`.
      * @param argv default value `['.', '--no-sandbox']`
+     * @param options options for `child_process.spawn`
+     * @param customElectronPkg custom electron package name (default: 'electron')
      */
     startup: (argv?: string[], options?: import('node:child_process').SpawnOptions) => Promise<void>
     /** Reload Electron-Renderer */
@@ -78,7 +80,7 @@ export default function electron(options: ElectronOptions | ElectronOptions[]):
                       startup,
                       reload() {
                         if (process.electronApp) {
-                          server.ws.send({ type: 'full-reload' })
+                          server.hot.send({ type: 'full-reload' })
                         } else {
                           startup()
                         }
@@ -118,14 +120,17 @@ export default function electron(options: ElectronOptions | ElectronOptions[]):
  * Electron App startup function.
  * It will mount the Electron App child-process to `process.electronApp`.
  * @param argv default value `['.', '--no-sandbox']`
+ * @param options options for `child_process.spawn`
+ * @param customElectronPkg custom electron package name (default: 'electron')
  */
 export async function startup(
   argv = ['.', '--no-sandbox'],
   options?: import('node:child_process').SpawnOptions,
+  customElectronPkg?: string,
 ) {
   const { spawn } = await import('node:child_process')
   // @ts-ignore
-  const electron = await import('electron')
+  const electron = await import(customElectronPkg ?? 'electron')
   const electronPath = <any>(electron.default ?? electron)
 
   await startup.exit()