@tomjs/vite-plugin-electron 1.3.5 → 1.3.7

package/README.md

@@ -185,7 +185,8 @@ 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. |
+| 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. |
 
 **Notice**
 
@@ -260,7 +261,7 @@ app.whenReady().then(() => {
 
 Start code compilation through the following configuration or `ELECTRON_DEBUG=1 vite dev`
 
-- Enable by setting `APP_ELECTRON_DEBUG=1` in `.env` file
+- Enable by setting `APP_ELECTRON_DEBUG=1` in `.env.development` file
 - `vite.config.js` configures `electron({ debug: true })` to be turned on
 
 #### VSCODE
@@ -288,7 +289,3 @@ Run `Debug Main Process` through `vscode` to debug the main thread. For debuggin
   ]
 }
 ```
-
-**Notice**
-
-Although `Electron v28` supports `esm`, there may be problems with `VSCode Debug` sourcemap support and breakpoints cannot work properly. In this case, you can consider using `cjs` mode.

package/README.zh_CN.md

@@ -186,7 +186,8 @@ 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 |
+| 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)。 |
 
 `recommended` 选项用于设置默认配置和行为，几乎可以达到零配置使用，默认为 `true` 。如果你要自定义配置，请设置它为`false`。以下默认的前提条件是使用推荐的 [项目结构](#目录结构)。
 
@@ -259,7 +260,7 @@ app.whenReady().then(() => {
 
 通过如下配置或者 `ELECTRON_DEBUG=1 vite dev` 启动代码编译
 
-- 通过 `.env` 文件设置 `APP_ELECTRON_DEBUG=1` 开启
+- 通过 `.env.development` 文件设置 `APP_ELECTRON_DEBUG=1` 开启
 - `vite.config.js` 配置 `electron({ debug: true })` 开启
 
 #### VSCODE
@@ -287,7 +288,3 @@ app.whenReady().then(() => {
   ]
 }
 ```
-
-**说明**
-
-`Electron v28` 虽然支持了 `esm`，但是 `VSCode Debug` sourcemap支持可能有问题，断点无法正常工作，这时可以考虑使用 `cjs` 模式

package/dist/index.d.mts

@@ -79,6 +79,14 @@ interface PluginOptions {
      * @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.
+     * The default port is false.
+     * @see https://www.electronjs.org/docs/latest/tutorial/debugging-main-process
+     * @default false
+     */
+    inspect?: number | boolean;
 }
 
 declare function vitePluginElectron(options?: PluginOptions): Plugin;

package/dist/index.d.ts

@@ -79,6 +79,14 @@ interface PluginOptions {
      * @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.
+     * The default port is false.
+     * @see https://www.electronjs.org/docs/latest/tutorial/debugging-main-process
+     * @default false
+     */
+    inspect?: number | boolean;
 }
 
 declare function vitePluginElectron(options?: PluginOptions): Plugin;

package/dist/index.js

@@ -75,7 +75,15 @@ async function startup(options) {
     return;
   }
   await startup.exit();
-  process.electronApp = _child_process.spawn.call(void 0, _electron2.default, ["."], {
+  const args = ["."];
+  if (options.inspect) {
+    if (typeof options.inspect === "number") {
+      args.push(`--inspect=${options.inspect}`);
+    } else {
+      args.push(`--inspect`);
+    }
+  }
+  process.electronApp = _child_process.spawn.call(void 0, _electron2.default, args, {
     stdio: "inherit"
   });
   process.electronApp.once("exit", process.exit);
@@ -151,6 +159,7 @@ function readJson(path2) {
 }
 
 // src/index.ts
+var isDev = process.env.NODE_ENV === "development";
 function getPkg() {
   const pkgFile = _path2.default.resolve(process.cwd(), "package.json");
   if (!_fs2.default.existsSync(pkgFile)) {
@@ -170,6 +179,7 @@ function preMergeOptions(options) {
     format,
     clean: true,
     dts: false,
+    treeshake: !!isDev,
     outExtension({ format: format2 }) {
       return {
         js: format2 === "esm" ? ".mjs" : `.js`
@@ -208,9 +218,18 @@ function preMergeOptions(options) {
   });
   return opts;
 }
+function geNumberBooleanValue(value) {
+  if (typeof value !== "string") {
+    return;
+  }
+  if (["true", "false"].includes(value)) {
+    return value === "true";
+  }
+  const v = Number(value);
+  return Number.isNaN(v) ? void 0 : v;
+}
 function vitePluginElectron(options) {
   const opts = preMergeOptions(options);
-  const isDev = process.env.NODE_ENV === "development";
   let isServer = false;
   return {
     name: PLUGIN_NAME,
@@ -253,6 +272,7 @@ function vitePluginElectron(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;
     },
     configureServer(server) {
       if (!server || !server.httpServer) {
@@ -278,7 +298,6 @@ function vitePluginElectron(options) {
         const env = Object.keys(process.env).filter((s) => s.startsWith("APP_") || s.startsWith("VITE_")).map((s) => `${s}=${process.env[s]}`).join("\n");
         _fs.writeFileSync.call(void 0, _path2.default.join(DEBUG_PATH, ".env"), `NODE_ENV=development
 ${env}`);
-        console.log("Server is running");
         await runServe(opts, server);
       });
     },

package/dist/index.mjs

@@ -75,7 +75,15 @@ async function startup(options) {
     return;
   }
   await startup.exit();
-  process.electronApp = spawn(electron, ["."], {
+  const args = ["."];
+  if (options.inspect) {
+    if (typeof options.inspect === "number") {
+      args.push(`--inspect=${options.inspect}`);
+    } else {
+      args.push(`--inspect`);
+    }
+  }
+  process.electronApp = spawn(electron, args, {
     stdio: "inherit"
   });
   process.electronApp.once("exit", process.exit);
@@ -150,6 +158,7 @@ function readJson(path2) {
 }
 
 // src/index.ts
+var isDev = process.env.NODE_ENV === "development";
 function getPkg() {
   const pkgFile = path.resolve(process.cwd(), "package.json");
   if (!fs2.existsSync(pkgFile)) {
@@ -169,6 +178,7 @@ function preMergeOptions(options) {
     format,
     clean: true,
     dts: false,
+    treeshake: !!isDev,
     outExtension({ format: format2 }) {
       return {
         js: format2 === "esm" ? ".mjs" : `.js`
@@ -207,9 +217,18 @@ function preMergeOptions(options) {
   });
   return opts;
 }
+function geNumberBooleanValue(value) {
+  if (typeof value !== "string") {
+    return;
+  }
+  if (["true", "false"].includes(value)) {
+    return value === "true";
+  }
+  const v = Number(value);
+  return Number.isNaN(v) ? void 0 : v;
+}
 function vitePluginElectron(options) {
   const opts = preMergeOptions(options);
-  const isDev = process.env.NODE_ENV === "development";
   let isServer = false;
   return {
     name: PLUGIN_NAME,
@@ -252,6 +271,7 @@ function vitePluginElectron(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;
     },
     configureServer(server) {
       if (!server || !server.httpServer) {
@@ -277,7 +297,6 @@ function vitePluginElectron(options) {
         const env = Object.keys(process.env).filter((s) => s.startsWith("APP_") || s.startsWith("VITE_")).map((s) => `${s}=${process.env[s]}`).join("\n");
         writeFileSync(path.join(DEBUG_PATH, ".env"), `NODE_ENV=development
 ${env}`);
-        console.log("Server is running");
         await runServe(opts, server);
       });
     },

package/env.d.ts

@@ -17,5 +17,9 @@ declare namespace NodeJS {
      * 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.3.5",
+  "version": "1.3.7",
   "description": "A simple vite plugin for electron, supports esm/cjs, support esm in electron v28+",
   "keywords": [
     "vite",