@tomjs/vite-plugin-electron 1.0.1 → 1.1.1

package/README.md

@@ -10,6 +10,8 @@
 
 - Fast build `main` and `preload` with [tsup](https://github.com/egoist/tsup)
 - Little configuration, focus on business
+- Support `main`'s `Hot Restart`
+- Support `preload`'s `Hot Reload`
 - Support `esm` and `cjs`, you can use `esm` in [electron v28+](https://www.electronjs.org/blog/electron-28-0)
 - Support `vue` and `react` and [other frameworks](https://vitejs.dev/guide/#trying-vite-online)
 
@@ -64,7 +66,42 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |  |--index.html
 ```
 
-For example, for vue/react projects, `vite.config.ts` configuration.
+### electron
+
+`electron/main/index.ts`
+
+```ts
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { app, BrowserWindow } from 'electron';
+
+// when package.json "type": module"
+global.__dirname = dirname(fileURLToPath(import.meta.url));
+
+const preload = join(__dirname, '../preload/index.mjs');
+const url = process.env.APP_DEV_SERVER_URL;
+
+async function createWindow() {
+  win = new BrowserWindow({
+    title: 'Main window',
+    width: 800,
+    height: 700,
+    webPreferences: {
+      preload,
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  if (isDev) {
+    win.loadURL(url);
+  } else {
+    win.loadFile(indexHtml);
+  }
+}
+
+app.whenReady().then(createWindow);
+```
 
 ### vue
 

package/README.zh_CN.md

@@ -10,6 +10,8 @@
 
 - 使用 [tsup](https://github.com/egoist/tsup) 快速构建 `main` 和 `preload`
 - 配置简单，专注业务
+- 支持 `main` 的 `热重启`
+- 支持 `preload` 的 `热重载`
 - 支持 `esm` 和 `cjs` ，你可以在 [electron v28+](https://www.electronjs.org/zh/blog/electron-28-0) 中使用 `esm`
 - 支持 `vue` 和 `react` 以及 [其他框架](https://cn.vitejs.dev/guide/#trying-vite-online)
 
@@ -64,7 +66,42 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |  |--index.html
 ```
 
-以 vue/react 项目为例，`vite.config.ts` 配置。
+### electron
+
+`electron/main/index.ts`
+
+```ts
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { app, BrowserWindow } from 'electron';
+
+// when package.json "type": module"
+global.__dirname = dirname(fileURLToPath(import.meta.url));
+
+const preload = join(__dirname, '../preload/index.mjs');
+const url = process.env.APP_DEV_SERVER_URL;
+
+async function createWindow() {
+  win = new BrowserWindow({
+    title: 'Main window',
+    width: 800,
+    height: 700,
+    webPreferences: {
+      preload,
+      nodeIntegration: true,
+      contextIsolation: false,
+    },
+  });
+
+  if (isDev) {
+    win.loadURL(url);
+  } else {
+    win.loadFile(indexHtml);
+  }
+}
+
+app.whenReady().then(createWindow);
+```
 
 ### vue
 

package/dist/index.js

@@ -73,7 +73,10 @@ function getBuildOptions(options, innerOpts) {
       delete env[key];
     }
   });
-  return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => options[s]).map((cfg) => {
+  return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
+    options[s].__NAME__ = s;
+    return options[s];
+  }).map((cfg) => {
     return {
       ...cfg,
       env,
@@ -93,40 +96,45 @@ function runMainProcess(options, innerOpts) {
     stdio: "inherit"
   }).on("exit", exitMainProcess);
 }
-async function runServe(options, innerOpts) {
-  let electronProcess;
+async function runServe(options, innerOpts, server) {
+  let mainProcess;
   const killProcess = () => {
-    if (electronProcess) {
-      electronProcess.off("exit", exitMainProcess);
-      electronProcess.kill();
+    if (mainProcess) {
+      mainProcess.off("exit", exitMainProcess);
+      mainProcess.kill();
     }
   };
   process.on("exit", () => {
     killProcess();
   });
-  logger.info(`electron server start`);
   const buildOptions = getBuildOptions(options, innerOpts);
   for (let i = 0; i < buildOptions.length; i++) {
     let isFirstBuild = true;
     const tsOpts = buildOptions[i];
-    const { onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
-    logger.info(`electron ${tsOpts.name} process build`);
+    const { __NAME__: name, onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
+    logger.info(`${name} build`);
     const onSuccess = async () => {
-      logger.info(`electron ${tsOpts.name} process build success`);
       if (typeof _onSuccess === "function") {
         await _onSuccess();
       }
-      logger.success("rebuild succeeded!");
       if (isFirstBuild) {
+        logger.info(`${name} build succeeded`);
         isFirstBuild = false;
         return;
       }
-      killProcess();
-      electronProcess = runMainProcess(options, innerOpts);
+      logger.success(`${name} rebuild succeeded!`);
+      if (name === "main") {
+        killProcess();
+        mainProcess = runMainProcess(options, innerOpts);
+      } else {
+        server.ws.send({
+          type: "full-reload"
+        });
+      }
     };
     await _tsup.build.call(void 0, { onSuccess, watch: true, ...tsupOptions });
   }
-  electronProcess = runMainProcess(options, innerOpts);
+  mainProcess = runMainProcess(options, innerOpts);
   return {
     kill: killProcess
   };
@@ -224,7 +232,6 @@ function vitePluginElectron(options) {
       if (isDev) {
         opts.main.sourcemap = _nullishCoalesce(opts.main.sourcemap, () => ( true));
         opts.preload.sourcemap = _nullishCoalesce(opts.main.sourcemap, () => ( true));
-        opts.inspect = _nullishCoalesce(opts.inspect, () => ( true));
       } else {
         opts.main.minify = _nullishCoalesce(opts.main.minify, () => ( true));
         opts.preload.minify = _nullishCoalesce(opts.preload.minify, () => ( true));
@@ -251,7 +258,7 @@ function vitePluginElectron(options) {
           }
         }
         (_a = process.__tomjs_electron_serve__) == null ? void 0 : _a.kill();
-        process.__tomjs_electron_serve__ = await runServe(opts, innerOpts);
+        process.__tomjs_electron_serve__ = await runServe(opts, innerOpts, server);
       });
     },
     async closeBundle() {

package/dist/index.mjs

@@ -73,7 +73,10 @@ function getBuildOptions(options, innerOpts) {
       delete env[key];
     }
   });
-  return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => options[s]).map((cfg) => {
+  return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
+    options[s].__NAME__ = s;
+    return options[s];
+  }).map((cfg) => {
     return {
       ...cfg,
       env,
@@ -93,40 +96,45 @@ function runMainProcess(options, innerOpts) {
     stdio: "inherit"
   }).on("exit", exitMainProcess);
 }
-async function runServe(options, innerOpts) {
-  let electronProcess;
+async function runServe(options, innerOpts, server) {
+  let mainProcess;
   const killProcess = () => {
-    if (electronProcess) {
-      electronProcess.off("exit", exitMainProcess);
-      electronProcess.kill();
+    if (mainProcess) {
+      mainProcess.off("exit", exitMainProcess);
+      mainProcess.kill();
     }
   };
   process.on("exit", () => {
     killProcess();
   });
-  logger.info(`electron server start`);
   const buildOptions = getBuildOptions(options, innerOpts);
   for (let i = 0; i < buildOptions.length; i++) {
     let isFirstBuild = true;
     const tsOpts = buildOptions[i];
-    const { onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
-    logger.info(`electron ${tsOpts.name} process build`);
+    const { __NAME__: name, onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
+    logger.info(`${name} build`);
     const onSuccess = async () => {
-      logger.info(`electron ${tsOpts.name} process build success`);
       if (typeof _onSuccess === "function") {
         await _onSuccess();
       }
-      logger.success("rebuild succeeded!");
       if (isFirstBuild) {
+        logger.info(`${name} build succeeded`);
         isFirstBuild = false;
         return;
       }
-      killProcess();
-      electronProcess = runMainProcess(options, innerOpts);
+      logger.success(`${name} rebuild succeeded!`);
+      if (name === "main") {
+        killProcess();
+        mainProcess = runMainProcess(options, innerOpts);
+      } else {
+        server.ws.send({
+          type: "full-reload"
+        });
+      }
     };
     await tsupBuild({ onSuccess, watch: true, ...tsupOptions });
   }
-  electronProcess = runMainProcess(options, innerOpts);
+  mainProcess = runMainProcess(options, innerOpts);
   return {
     kill: killProcess
   };
@@ -223,7 +231,6 @@ function vitePluginElectron(options) {
       if (isDev) {
         opts.main.sourcemap = opts.main.sourcemap ?? true;
         opts.preload.sourcemap = opts.main.sourcemap ?? true;
-        opts.inspect = opts.inspect ?? true;
       } else {
         opts.main.minify = opts.main.minify ?? true;
         opts.preload.minify = opts.preload.minify ?? true;
@@ -250,7 +257,7 @@ function vitePluginElectron(options) {
           }
         }
         (_a = process.__tomjs_electron_serve__) == null ? void 0 : _a.kill();
-        process.__tomjs_electron_serve__ = await runServe(opts, innerOpts);
+        process.__tomjs_electron_serve__ = await runServe(opts, innerOpts, server);
       });
     },
     async closeBundle() {

package/env.d.ts

@@ -0,0 +1,17 @@
+/**
+ * fix code hint
+ */
+type UnionType<T> = T | (string & {});
+
+declare namespace NodeJS {
+  interface ProcessEnv {
+    /**
+     * Node.js environment
+     */
+    NODE_ENV: UnionType<'development' | 'test' | 'production'>;
+    /**
+     * The url of the dev server.
+     */
+    readonly APP_DEV_SERVER_URL: string;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "A simple vite plugin for electron, supports esm/cjs.",
   "keywords": [
     "vite",
@@ -24,7 +24,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "env.d.ts"
   ],
   "engines": {
     "node": ">=16"