@tomjs/vite-plugin-electron 1.4.0 → 1.6.0

package/README.md

@@ -126,7 +126,7 @@ Take using `esm` as an example, but it requires Electron>=28
 
 - `package.json`
 
-Electron preload must use the `mjs` suffix, otherwise an error will be reported. So `esm` also uses the `mjs` suffix for output by default.
+Electron `preload process` must use the `.mjs` suffix, otherwise an error will be reported, see [official documentation](https://www.electronjs.org/zh/docs/latest/tutorial/esm). So the default output of `esm` of `preload` uses the `.mjs` suffix. For consistency, `main process` also ends with `.mjs`
 
 ```json
 {
@@ -201,8 +201,9 @@ export default defineConfig({
 | external | `string[]` |  | Don't bundle these modules, but dependencies and peerDependencies in your package.json are always excluded.[See more](https://tsup.egoist.dev/#excluding-packages) |
 | main | [MainOptions](#MainOptions) |  | Configuration options for the electron main process. |
 | preload | [PreloadOptions](#PreloadOptions) |  | Configuration options for the electron preload process. |
-| debug | `boolean` | `false` | Electron debug mode, don't startup electron. You can also use `process.env.APP_ELECTRON_DEBUG`. Default is false. |
-| inspect | `boolean` | `false` | Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port. You can also use `process.env.APP_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information. |
+| debug | `boolean` | `false` | Electron debug mode, don't startup electron. You can also use `process.env.VITE_ELECTRON_DEBUG`. Default is false. |
+| builder | `boolean` \| [BuilderOptions](#BuilderOptions) | `false` | If it is a `boolean` type, whether to enable [electron-builder](https://www.electron.build). If it is an object, it is the [configuration](https://www.electron.build/configuration/configuration) of [electron-builder](https://www.electron.build). You can also turn it on using `process.env.VITE_ELECTRON_DEBUG`. |
+| inspect | `boolean` | `false` | Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port. You can also use `process.env.VITE_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information. |
 
 **Notice**
 
@@ -234,7 +235,7 @@ Based on [Options](https://paka.dev/npm/tsup) of [tsup](https://tsup.egoist.dev/
 | outDir | `string` | "dist-electron/preload" | The output directory for the preload process files |
 | onSuccess | `() => Promise<void \| undefined \| (() => void \| Promise<void>)>` | `undefined` | A function that will be executed after the build succeeds. |
 
-# BuilderOptions
+### BuilderOptions
 
 When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
 
@@ -247,7 +248,6 @@ To use this function, you need to install additional `electron-builder`
 
 | Property | Type | Default | Description |
 | --- | --- | --- | --- |
-| enable | `boolean` | `false` | Whether to enable the [electron-builder](https://www.electron.build). |
 | appId | `string` | `"com.electron.${name}"` | The application id. [See More](https://www.electron.build/configuration/configuration#configuration) |
 | productName | `string` | `"com.electron.${name}"` | product name.[See More](https://www.electron.build/configuration/configuration#configuration) |
 | builderConfig | [Configuration](https://www.electron.build/configuration/configuration#configurationF) | `undefined` | [electron-builder](https://www.electron.build)'s [Configuration](https://www.electron.build/configuration/configuration#configuration) |
@@ -300,6 +300,24 @@ const config = {
 | sourcemap | `true`                   | `false`                 |
 | minify    | `false`                  | `true`                  |
 
+## Environment Variables
+
+### Vite plugin variables
+
+| Variable | Description |
+| --- | --- |
+| `VITE_ELECTRON_DEBUG` | Electron main process debug, don't startup electron. When value is true or 1 to enable, false or 0 to disable.Default is undefined. |
+| `VITE_ELECTRON_INSPECT` | Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port. When value is true, the default port is 5858. |
+| `VITE_ELECTRON_BUILDER` | Enable [electron-builder](https://www.electron.build) to package. When value is true or 1 to enable, false or 0 to disable. Default is undefined. |
+
+### Application variables
+
+Electron `main process` and `renderer process` use.
+
+| Variable           | Description                |
+| ------------------ | -------------------------- |
+| APP_DEV_SERVER_URL | The url of the dev server. |
+
 ## Debug
 
 ### Web debugging
@@ -328,16 +346,7 @@ app.whenReady().then(() => {
 });
 ```
 
-### Main thread debugging
-
-#### Turn on debugging
-
-Start code compilation through the following configuration or `ELECTRON_DEBUG=1 vite dev`
-
-- Enable by setting `APP_ELECTRON_DEBUG=1` in `.env.development` file
-- `vite.config.js` configures `electron({ debug: true })` to be turned on
-
-#### VSCODE
+### Main Process Debug
 
 Run `Debug Main Process` through `vscode` to debug the main thread. For debugging tools, refer to [Official Documentation](https://code.visualstudio.com/docs/editor/debugging)
 
@@ -349,6 +358,7 @@ Run `Debug Main Process` through `vscode` to debug the main thread. For debuggin
   "configurations": [
     {
       "name": "Debug Main Process",
+      "preLaunchTask": "npm:debug",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
@@ -357,8 +367,52 @@ Run `Debug Main Process` through `vscode` to debug the main thread. For debuggin
         "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
       },
       "args": ["."],
+      "outFiles": [
+        "${workspaceFolder}/**/*.js",
+        "${workspaceFolder}/**/*.cjs",
+        "${workspaceFolder}/**/*.mjs",
+        "!**/node_modules/**"
+      ],
       "envFile": "${workspaceFolder}/node_modules/@tomjs/vite-plugin-electron/debug/.env"
     }
   ]
 }
 ```
+
+`tasks.json` is configured as follows:
+
+```json
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "npm:debug",
+      "type": "npm",
+      "script": "debug",
+      "detail": "cross-env VITE_ELECTRON_DEBUG=1 vite",
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "typescript",
+        "fileLocation": "relative",
+        "pattern": {
+          "regexp": "^([a-zA-Z]\\:/?([\\w\\-]/?)+\\.\\w+):(\\d+):(\\d+): (ERROR|WARNING)\\: (.*)$",
+          "file": 1,
+          "line": 3,
+          "column": 4,
+          "code": 5,
+          "message": 6
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^.*VITE v.*  ready in \\d* ms.*$",
+          "endsPattern": "^.*\\[@tomjs:electron\\] startup electron*$"
+        }
+      }
+    }
+  ]
+}
+```
+
+### Preload process Debug
+
+Use `DevTools` to debug the `preload process`.

package/README.zh_CN.md

@@ -126,7 +126,7 @@ app.whenReady().then(createWindow);
 
 - `package.json`
 
-Electron preload 必须使用 `mjs` 后缀，否则报错。所以 `esm` 也默认输出使用 `mjs` 后缀。
+Electron `preload process` 必须使用 `.mjs` 后缀，否则报错，查看[官方文档](https://www.electronjs.org/zh/docs/latest/tutorial/esm)。所以 `preload` 的 `esm` 默认输出使用 `mjs` 后缀。为了保持一致性，`main process` 也以 `.mjs` 结尾。
 
 ```json
 {
@@ -202,8 +202,9 @@ export default defineConfig({
 | external | `string[]` |  | 不打包这些模块，但是 `dependencies` and `peerDependencies` 默认排除，[详见](https://tsup.egoist.dev/#excluding-packages) |
 | main | [MainOptions](#MainOptions) |  | electron main 进程选项 |
 | preload | [PreloadOptions](#PreloadOptions) |  | electron preload 进程选项 |
-| debug | `boolean` | `false` | Electron调试模式，不启动Electron。 您还可以使用 `process.env.APP_ELECTRON_DEBUG` |
-| inspect | `boolean` | `false` | Electron 将监听指定 port 上的 V8 调试协议消息， 外部调试器需要连接到此端口上。您还可以使用 `process.env.APP_ELECTRON_INSPECT`。 有关更多信息，请参阅[debugging-main-process](https://www.electronjs.org/zh/docs/latest/tutorial/debugging-main-process)。 |
+| debug | `boolean` | `false` | Electron调试模式，不启动Electron。 您还可以使用 `process.env.VITE_ELECTRON_DEBUG` |
+| builder | `boolean` | `false` | 如果是`boolean`类型，是否启用[electron-builder](https://www.electron.build)。如果是`Object`，则是[electron-builder](https://www.electron.build)的[配置](https://www.electron.build/configuration/configuration)。 您还可以使用 `process.env.VITE_ELECTRON_DEBUG` 开启它。 |
+| inspect | `boolean` | `false` | Electron 将监听指定 port 上的 V8 调试协议消息， 外部调试器需要连接到此端口上。您还可以使用 `process.env.VITE_ELECTRON_INSPECT`。 有关更多信息，请参阅[debugging-main-process](https://www.electronjs.org/zh/docs/latest/tutorial/debugging-main-process)。 |
 
 `recommended` 选项用于设置默认配置和行为，几乎可以达到零配置使用，默认为 `true` 。如果你要自定义配置，请设置它为`false`。以下默认的前提条件是使用推荐的 [项目结构](#目录结构)。
 
@@ -246,7 +247,6 @@ _不适合所有人使用。_
 
 | 参数名 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| enable | `boolean` | `false` | 是否启用 [electron-builder](https://www.electron.build) |
 | appId | `string` | `"com.electron.${name}"` | 应用程序 ID。[详细](https://www.electron.build/configuration/configuration#configuration) |
 | productName | `string` | `` | 应用程序名称。[详细](https://www.electron.build/configuration/configuration#configuration) |
 | builderConfig | [Configuration](https://www.electron.build/configuration/configuration#configurationF) | `undefined` | [electron-builder](https://www.electron.build) 的 [Configuration](https://www.electron.build/configuration/configuration#configuration) |
@@ -299,6 +299,24 @@ const config = {
 | sourcemap | `true`         | `false`        |
 | minify    | `false`        | `true`         |
 
+## 环境变量
+
+### vite 插件变量
+
+| 变量 | 描述 |
+| --- | --- |
+| `VITE_ELECTRON_DEBUG` | Electron主进程调试，不要启动Electron。 当值为 true 或 1 时启用，为 false 或 0 时禁用。默认值未定义。 |
+| `VITE_ELECTRON_INSPECT` | Electron 将在指定端口上侦听 V8 检查器协议消息，外部调试器需要连接到该端口。 当值为 true 时，默认端口为 5858。 |
+| `VITE_ELECTRON_BUILDER` | 启用 [ Electron-builder ](https://www.electron.build) 进行打包。 当值为 true 或 1 时启用，为 false 或 0 时禁用。 默认值未定义。 |
+
+### 应用变量
+
+Electron `main process` 和 `renderer process` 使用。
+
+| 变量               | 描述                  |
+| ------------------ | --------------------- |
+| APP_DEV_SERVER_URL | Vite 开发服务器的 URL |
+
 ## 调试
 
 ### Web调试
@@ -327,16 +345,7 @@ app.whenReady().then(() => {
 });
 ```
 
-### 主线程调试
-
-#### 开启调试
-
-通过如下配置或者 `ELECTRON_DEBUG=1 vite dev` 启动代码编译
-
-- 通过 `.env.development` 文件设置 `APP_ELECTRON_DEBUG=1` 开启
-- `vite.config.js` 配置 `electron({ debug: true })` 开启
-
-#### VSCODE
+### Main Process 调试
 
 通过 `vscode` 运行 `Debug Main Process` 调试主线程，调试工具参考 [官方文档](https://code.visualstudio.com/docs/editor/debugging)
 
@@ -348,6 +357,7 @@ app.whenReady().then(() => {
   "configurations": [
     {
       "name": "Debug Main Process",
+      "preLaunchTask": "npm:debug",
       "type": "node",
       "request": "launch",
       "cwd": "${workspaceFolder}",
@@ -356,8 +366,52 @@ app.whenReady().then(() => {
         "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
       },
       "args": ["."],
+      "outFiles": [
+        "${workspaceFolder}/**/*.js",
+        "${workspaceFolder}/**/*.cjs",
+        "${workspaceFolder}/**/*.mjs",
+        "!**/node_modules/**"
+      ],
       "envFile": "${workspaceFolder}/node_modules/@tomjs/vite-plugin-electron/debug/.env"
     }
   ]
 }
 ```
+
+`tasks.json` 配置如下：
+
+```json
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "npm:debug",
+      "type": "npm",
+      "script": "debug",
+      "detail": "cross-env VITE_ELECTRON_DEBUG=1 vite",
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "typescript",
+        "fileLocation": "relative",
+        "pattern": {
+          "regexp": "^([a-zA-Z]\\:/?([\\w\\-]/?)+\\.\\w+):(\\d+):(\\d+): (ERROR|WARNING)\\: (.*)$",
+          "file": 1,
+          "line": 3,
+          "column": 4,
+          "code": 5,
+          "message": 6
+        },
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^.*VITE v.*  ready in \\d* ms.*$",
+          "endsPattern": "^.*\\[@tomjs:electron\\] startup electron*$"
+        }
+      }
+    }
+  ]
+}
+```
+
+### Preload Process 调试
+
+使用 `DevTools` 调试 `preload process`.

package/dist/index.d.mts

@@ -59,7 +59,8 @@ interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | '
 interface BuilderOptions {
     /**
      * Whether to enable the [electron-builder](https://www.electron.build), the default is false.
-     * @default false
+     * @default true
+     * @deprecated
      */
     enable?: boolean;
     /**
@@ -109,15 +110,15 @@ interface PluginOptions {
      * * In the `build.outDir` directory configured in vite, generate a new package.json based on the configuration and package.json, excluding non-dependencies.
      * * Execute `npm install` and then package.
      */
-    builder?: BuilderOptions;
+    builder?: boolean | BuilderOptions;
     /**
-     * electron debug mode, don't startup electron. You can also use `process.env.APP_ELECTRON_DEBUG`. Default is false.
+     * electron debug mode, don't startup electron. You can also use `process.env.VITE_ELECTRON_DEBUG`. Default is false.
      * @default false
      */
     debug?: boolean;
     /**
      * Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port.
-     * You can also use `process.env.APP_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information.
+     * You can also use `process.env.VITE_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information.
      * The default port is false.
      * @see https://www.electronjs.org/docs/latest/tutorial/debugging-main-process
      * @default false

package/dist/index.d.ts

@@ -59,7 +59,8 @@ interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | '
 interface BuilderOptions {
     /**
      * Whether to enable the [electron-builder](https://www.electron.build), the default is false.
-     * @default false
+     * @default true
+     * @deprecated
      */
     enable?: boolean;
     /**
@@ -109,15 +110,15 @@ interface PluginOptions {
      * * In the `build.outDir` directory configured in vite, generate a new package.json based on the configuration and package.json, excluding non-dependencies.
      * * Execute `npm install` and then package.
      */
-    builder?: BuilderOptions;
+    builder?: boolean | BuilderOptions;
     /**
-     * electron debug mode, don't startup electron. You can also use `process.env.APP_ELECTRON_DEBUG`. Default is false.
+     * electron debug mode, don't startup electron. You can also use `process.env.VITE_ELECTRON_DEBUG`. Default is false.
      * @default false
      */
     debug?: boolean;
     /**
      * Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port.
-     * You can also use `process.env.APP_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information.
+     * You can also use `process.env.VITE_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information.
      * The default port is false.
      * @see https://www.electronjs.org/docs/latest/tutorial/debugging-main-process
      * @default false

package/dist/index.js

@@ -10,6 +10,7 @@ var _os = require('os'); var _os2 = _interopRequireDefault(_os);
 
 
 
+var _shelljs = require('shelljs'); var _shelljs2 = _interopRequireDefault(_shelljs);
 
 // src/logger.ts
 var _dayjs = require('dayjs'); var _dayjs2 = _interopRequireDefault(_dayjs);
@@ -60,7 +61,6 @@ var createLogger = (tag) => {
 };
 
 // src/utils.ts
-var _child_process = require('child_process');
 
 var _module = require('module');
 function readJson(path3) {
@@ -71,9 +71,6 @@ function readJson(path3) {
 function writeJson(path3, data) {
   _fs2.default.writeFileSync(path3, JSON.stringify(data, null, 2), "utf8");
 }
-function exec(command, args, options) {
-  return _child_process.spawnSync.call(void 0, command, args, Object.assign({ encoding: "utf8" }, options));
-}
 
 // src/builder.ts
 var logger = createLogger();
@@ -82,8 +79,8 @@ function getMirror() {
   if (mirror) {
     return mirror;
   }
-  const res = exec(_os2.default.platform() === "win32" ? "npm.cmd" : "npm", ["config", "get", "registry"]);
-  if (res.status === 0) {
+  const res = _shelljs2.default.exec("npm config get registry", { silent: true });
+  if (res.code === 0) {
     let registry = res.stdout;
     if (!registry) {
       return;
@@ -131,6 +128,9 @@ function getBuilderConfig(options, resolvedConfig) {
       deleteAppDataOnUninstall: false
     }
   };
+  if (typeof options.builder == "boolean") {
+    return config;
+  }
   const { appId, productName } = options.builder || {};
   return _lodashmerge2.default.call(void 0, config, { appId, productName }, (_a = options.builder) == null ? void 0 : _a.builderConfig);
 }
@@ -205,10 +205,13 @@ function createPkg(options, resolvedConfig) {
   return newPkg;
 }
 async function runElectronBuilder(options, resolvedConfig) {
+  if (typeof options.builder == "boolean" && options.builder == false) {
+    return;
+  }
   logger.info("building electron app...");
   const DIST_PATH = _path2.default.join(_process.cwd.call(void 0, ), _path2.default.dirname(resolvedConfig.build.outDir));
   logger.info(`create package.json and exec "npm install"`);
-  exec(`cd ${DIST_PATH} && npm run build`);
+  _shelljs2.default.exec(`cd ${DIST_PATH} && npm i`);
   logger.info(`run electron-builder to package app`);
   const config = getBuilderConfig(options, resolvedConfig);
   const { build } = await Promise.resolve().then(() => _interopRequireWildcard(require("electron-builder")));
@@ -218,7 +221,7 @@ async function runElectronBuilder(options, resolvedConfig) {
 }
 
 // src/main.ts
-
+var _child_process = require('child_process');
 var _electron = require('electron'); var _electron2 = _interopRequireDefault(_electron);
 var _treekill = require('tree-kill'); var _treekill2 = _interopRequireDefault(_treekill);
 var _tsup = require('tsup');
@@ -286,19 +289,19 @@ async function runServe(options, server) {
       }
       if (buildCounts[i] <= 0) {
         buildCounts[i]++;
-        logger2.info(`${name} build succeeded`);
+        logger2.info(`${name} build success`);
         if (buildCounts[0] == 1 && buildCounts[1] == 1) {
-          logger2.info("electron startup");
+          logger2.info("startup electron");
           await startup(options);
         }
         return;
       }
-      logger2.success(`${name} rebuild succeeded!`);
+      logger2.success(`${name} rebuild success`);
       if (name === "main") {
-        logger2.info("electron restart");
+        logger2.info("restart electron");
         await startup(options);
       } else {
-        logger2.info("page reload");
+        logger2.info("reload page");
         server.ws.send({
           type: "full-reload"
         });
@@ -352,7 +355,8 @@ function preMergeOptions(options) {
       },
       preload: {
         ...electron2
-      }
+      },
+      builder: false
     },
     _lodashclonedeep2.default.call(void 0, options)
   );
@@ -375,7 +379,7 @@ function preMergeOptions(options) {
   return opts;
 }
 function geNumberBooleanValue(value) {
-  if (typeof value !== "string") {
+  if (typeof value !== "string" || value.trim() === "") {
     return;
   }
   if (["true", "false"].includes(value)) {
@@ -384,6 +388,18 @@ function geNumberBooleanValue(value) {
   const v = Number(value);
   return Number.isNaN(v) ? void 0 : v;
 }
+function getBooleanValue(value) {
+  if (typeof value !== "string" || value.trim() === "") {
+    return;
+  }
+  if (["true", "false"].includes(value)) {
+    return value === "true";
+  }
+  if (["1", "0"].includes(value)) {
+    return value === "1";
+  }
+  return;
+}
 function useElectronPlugin(options) {
   const opts = preMergeOptions(options);
   let isServer = false;
@@ -428,8 +444,9 @@ function useElectronPlugin(options) {
       };
     },
     configResolved(config) {
-      opts.debug = config.env.APP_ELECTRON_DEBUG ? !!config.env.APP_ELECTRON_DEBUG : opts.debug;
-      opts.inspect = config.env.APP_ELECTRON_INSPECT ? geNumberBooleanValue(config.env.APP_ELECTRON_INSPECT) : opts.inspect;
+      opts.debug = _nullishCoalesce(getBooleanValue(config.env.VITE_ELECTRON_DEBUG), () => ( opts.debug));
+      opts.inspect = _nullishCoalesce(geNumberBooleanValue(config.env.VITE_ELECTRON_INSPECT), () => ( opts.inspect));
+      opts.builder = _nullishCoalesce(getBooleanValue(config.env.VITE_ELECTRON_BUILDER), () => ( opts.builder));
       resolvedConfig = config;
     },
     configureServer(server) {
@@ -454,12 +471,11 @@ ${env}`);
       });
     },
     async closeBundle() {
-      var _a;
       if (isServer) {
         return;
       }
       await runBuild(opts);
-      if (opts.recommended && ((_a = opts.builder) == null ? void 0 : _a.enable)) {
+      if (opts.recommended && opts.builder) {
         await runElectronBuilder(opts, resolvedConfig);
       }
     }

package/dist/index.mjs

@@ -10,6 +10,7 @@ import os from "os";
 import path from "path";
 import { cwd } from "process";
 import merge from "lodash.merge";
+import shell from "shelljs";
 
 // src/logger.ts
 import dayjs from "dayjs";
@@ -60,7 +61,6 @@ var createLogger = (tag) => {
 };
 
 // src/utils.ts
-import { spawnSync } from "child_process";
 import fs from "fs";
 function readJson(path3) {
   if (fs.existsSync(path3)) {
@@ -70,9 +70,6 @@ function readJson(path3) {
 function writeJson(path3, data) {
   fs.writeFileSync(path3, JSON.stringify(data, null, 2), "utf8");
 }
-function exec(command, args, options) {
-  return spawnSync(command, args, Object.assign({ encoding: "utf8" }, options));
-}
 
 // src/builder.ts
 var logger = createLogger();
@@ -81,8 +78,8 @@ function getMirror() {
   if (mirror) {
     return mirror;
   }
-  const res = exec(os.platform() === "win32" ? "npm.cmd" : "npm", ["config", "get", "registry"]);
-  if (res.status === 0) {
+  const res = shell.exec("npm config get registry", { silent: true });
+  if (res.code === 0) {
     let registry = res.stdout;
     if (!registry) {
       return;
@@ -130,6 +127,9 @@ function getBuilderConfig(options, resolvedConfig) {
       deleteAppDataOnUninstall: false
     }
   };
+  if (typeof options.builder == "boolean") {
+    return config;
+  }
   const { appId, productName } = options.builder || {};
   return merge(config, { appId, productName }, (_a = options.builder) == null ? void 0 : _a.builderConfig);
 }
@@ -204,10 +204,13 @@ function createPkg(options, resolvedConfig) {
   return newPkg;
 }
 async function runElectronBuilder(options, resolvedConfig) {
+  if (typeof options.builder == "boolean" && options.builder == false) {
+    return;
+  }
   logger.info("building electron app...");
   const DIST_PATH = path.join(cwd(), path.dirname(resolvedConfig.build.outDir));
   logger.info(`create package.json and exec "npm install"`);
-  exec(`cd ${DIST_PATH} && npm run build`);
+  shell.exec(`cd ${DIST_PATH} && npm i`);
   logger.info(`run electron-builder to package app`);
   const config = getBuilderConfig(options, resolvedConfig);
   const { build } = await import("electron-builder");
@@ -285,19 +288,19 @@ async function runServe(options, server) {
       }
       if (buildCounts[i] <= 0) {
         buildCounts[i]++;
-        logger2.info(`${name} build succeeded`);
+        logger2.info(`${name} build success`);
         if (buildCounts[0] == 1 && buildCounts[1] == 1) {
-          logger2.info("electron startup");
+          logger2.info("startup electron");
           await startup(options);
         }
         return;
       }
-      logger2.success(`${name} rebuild succeeded!`);
+      logger2.success(`${name} rebuild success`);
       if (name === "main") {
-        logger2.info("electron restart");
+        logger2.info("restart electron");
         await startup(options);
       } else {
-        logger2.info("page reload");
+        logger2.info("reload page");
         server.ws.send({
           type: "full-reload"
         });
@@ -351,7 +354,8 @@ function preMergeOptions(options) {
       },
       preload: {
         ...electron2
-      }
+      },
+      builder: false
     },
     cloneDeep(options)
   );
@@ -374,7 +378,7 @@ function preMergeOptions(options) {
   return opts;
 }
 function geNumberBooleanValue(value) {
-  if (typeof value !== "string") {
+  if (typeof value !== "string" || value.trim() === "") {
     return;
   }
   if (["true", "false"].includes(value)) {
@@ -383,6 +387,18 @@ function geNumberBooleanValue(value) {
   const v = Number(value);
   return Number.isNaN(v) ? void 0 : v;
 }
+function getBooleanValue(value) {
+  if (typeof value !== "string" || value.trim() === "") {
+    return;
+  }
+  if (["true", "false"].includes(value)) {
+    return value === "true";
+  }
+  if (["1", "0"].includes(value)) {
+    return value === "1";
+  }
+  return;
+}
 function useElectronPlugin(options) {
   const opts = preMergeOptions(options);
   let isServer = false;
@@ -427,8 +443,9 @@ function useElectronPlugin(options) {
       };
     },
     configResolved(config) {
-      opts.debug = config.env.APP_ELECTRON_DEBUG ? !!config.env.APP_ELECTRON_DEBUG : opts.debug;
-      opts.inspect = config.env.APP_ELECTRON_INSPECT ? geNumberBooleanValue(config.env.APP_ELECTRON_INSPECT) : opts.inspect;
+      opts.debug = getBooleanValue(config.env.VITE_ELECTRON_DEBUG) ?? opts.debug;
+      opts.inspect = geNumberBooleanValue(config.env.VITE_ELECTRON_INSPECT) ?? opts.inspect;
+      opts.builder = getBooleanValue(config.env.VITE_ELECTRON_BUILDER) ?? opts.builder;
       resolvedConfig = config;
     },
     configureServer(server) {
@@ -453,12 +470,11 @@ ${env}`);
       });
     },
     async closeBundle() {
-      var _a;
       if (isServer) {
         return;
       }
       await runBuild(opts);
-      if (opts.recommended && ((_a = opts.builder) == null ? void 0 : _a.enable)) {
+      if (opts.recommended && opts.builder) {
         await runElectronBuilder(opts, resolvedConfig);
       }
     }

package/env.d.ts

@@ -13,13 +13,5 @@ declare namespace NodeJS {
      * The url of the dev server.
      */
     APP_DEV_SERVER_URL?: string;
-    /**
-     * Electron main process debug, don't startup electron
-     */
-    APP_ELECTRON_DEBUG?: string;
-    /**
-     * Electron will listen for V8 inspector protocol messages on the specified port, an external debugger will need to connect on this port. The default port is 5858.
-     */
-    APP_ELECTRON_INSPECT?: string;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "A simple vite plugin for electron, supports esm/cjs, support esm in electron v28+",
   "keywords": [
     "vite",
@@ -40,21 +40,12 @@
     "type": "git",
     "url": "git+https://github.com/tomgao365/vite-plugin-electron.git"
   },
-  "scripts": {
-    "dev": "tsup --watch",
-    "build": "tsup",
-    "lint": "run-s lint:eslint lint:stylelint lint:prettier",
-    "lint:eslint": "eslint \"{src,examples}/**/*.{js,cjs,ts,tsx,vue}\" *.{js,cjs,ts} --fix --cache",
-    "lint:stylelint": "stylelint \"examples/**/*.{css,scss,less,vue,html}\" --fix --cache",
-    "lint:prettier": "prettier --write .",
-    "prepare": "husky install",
-    "prepublishOnly": "npm run build && np --any-branch --no-yarn --yolo --no-publish --message \"chore: release v%s\""
-  },
   "dependencies": {
     "dayjs": "^1.11.10",
     "kolorist": "^1.8.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
+    "shelljs": "^0.8.5",
     "tree-kill": "^1.2.2",
     "tsup": "7.2.0"
   },
@@ -68,12 +59,13 @@
     "@types/lodash.clonedeep": "^4.5.9",
     "@types/lodash.merge": "^4.6.9",
     "@types/node": "^18.19.3",
+    "@types/shelljs": "^0.8.15",
     "eslint": "^8.55.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",
     "np": "^9.2.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.1.0",
+    "prettier": "^3.1.1",
     "rimraf": "^5.0.5",
     "stylelint": "^15.11.0",
     "tsx": "^4.6.2",
@@ -88,5 +80,13 @@
     "electron-builder": {
       "optional": true
     }
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "lint": "run-s lint:eslint lint:stylelint lint:prettier",
+    "lint:eslint": "eslint \"{src,examples}/**/*.{js,cjs,ts,tsx,vue}\" *.{js,cjs,ts} --fix --cache",
+    "lint:stylelint": "stylelint \"examples/**/*.{css,scss,less,vue,html}\" --fix --cache",
+    "lint:prettier": "prettier --write ."
   }
-}
+}