@tomjs/vite-plugin-electron 1.3.9-1 → 1.5.0

package/README.md

@@ -31,6 +31,19 @@ yarn add @tomjs/vite-plugin-electron -D
 npm i @tomjs/vite-plugin-electron --save-dev
 ```
 
+If you use `builder` to package your application, please install `electron-builder`
+
+```bash
+# pnpm
+pnpm add electron-builder -D
+
+# yarn
+yarn add electron-builder -D
+
+# npm
+npm i electron-builder --save-dev
+```
+
 ## Usage
 
 ### Recommended Agreement
@@ -41,11 +54,13 @@ npm i @tomjs/vite-plugin-electron --save-dev
 
 ```
 |--electron
-|  |--main
+|  |--main        // main process code
 |  |  |--index.ts
-|  |--preload
+|  |--preload     // preload process code
 |  |  |--index.ts
-|--src
+|  |--build       // electron-builder resources for electron package
+|  |  |--icons
+|--src            // front-end code
 |  |--App.vue
 |  |--main.ts
 ```
@@ -111,12 +126,14 @@ 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.
+
+When the suffix of Electron `main process` is `.mjs` or `.cjs`, vscode breakpoint debugging cannot work, so the suffix defaults to `.js`.
 
 ```json
 {
   "type": "module",
-  "main": "dist/main/index.mjs"
+  "main": "dist/main/index.js"
 }
 ```
 
@@ -187,6 +204,7 @@ export default defineConfig({
 | 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. |
+| 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.APP_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.APP_ELECTRON_INSPECT`. See [debugging-main-process](https://www.electronjs.org/docs/latest/tutorial/debugging-main-process) for more information. |
 
 **Notice**
@@ -232,7 +250,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) |

package/README.zh_CN.md

@@ -31,6 +31,19 @@ yarn add @tomjs/vite-plugin-electron -D
 npm i @tomjs/vite-plugin-electron --save-dev
 ```
 
+如果使用 `builder` 打包应用，请安装 `electron-builder`
+
+```bash
+# pnpm
+pnpm add electron-builder -D
+
+# yarn
+yarn add electron-builder -D
+
+# npm
+npm i electron-builder --save-dev
+```
+
 ## 使用说明
 
 ### 推荐约定
@@ -41,11 +54,13 @@ npm i @tomjs/vite-plugin-electron --save-dev
 
 ```
 |--electron
-|  |--main
+|  |--main        // main process code
 |  |  |--index.ts
-|  |--preload
+|  |--preload     // preload process code
 |  |  |--index.ts
-|--src
+|  |--build       // electron-builder resources for electron package
+|  |  |--icons
+|--src            // front-end code
 |  |--App.vue
 |  |--main.ts
 ```
@@ -111,12 +126,14 @@ 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` 后缀。
+
+当 Electron `main process` 的后缀为 `.mjs`或`.cjs` 时， vscode 断点调试无法起到作用，所以后缀默认为`.js`。
 
 ```json
 {
   "type": "module",
-  "main": "dist/main/index.mjs"
+  "main": "dist/main/index.js"
 }
 ```
 
@@ -188,6 +205,7 @@ export default defineConfig({
 | main | [MainOptions](#MainOptions) |  | electron main 进程选项 |
 | preload | [PreloadOptions](#PreloadOptions) |  | electron preload 进程选项 |
 | debug | `boolean` | `false` | Electron调试模式，不启动Electron。 您还可以使用 `process.env.APP_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.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`。以下默认的前提条件是使用推荐的 [项目结构](#目录结构)。
@@ -231,7 +249,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) |

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,7 +110,7 @@ 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.
      * @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,7 +110,7 @@ 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.
      * @default false

package/dist/index.js

@@ -71,7 +71,7 @@ function readJson(path3) {
 function writeJson(path3, data) {
   _fs2.default.writeFileSync(path3, JSON.stringify(data, null, 2), "utf8");
 }
-function exec(command, args, options) {
+function exec(command, args = [], options) {
   return _child_process.spawnSync.call(void 0, command, args, Object.assign({ encoding: "utf8" }, options));
 }
 
@@ -131,6 +131,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,6 +208,9 @@ 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"`);
@@ -335,12 +341,7 @@ function preMergeOptions(options) {
     format,
     clean: true,
     dts: false,
-    treeshake: !!isDev,
-    outExtension({ format: format2 }) {
-      return {
-        js: format2 === "esm" ? ".mjs" : `.js`
-      };
-    }
+    treeshake: !!isDev
   };
   const opts = _lodashmerge2.default.call(void 0, 
     {
@@ -351,8 +352,14 @@ function preMergeOptions(options) {
         ...electron2
       },
       preload: {
-        ...electron2
-      }
+        ...electron2,
+        outExtension({ format: format2 }) {
+          return {
+            js: format2 === "esm" ? ".mjs" : `.js`
+          };
+        }
+      },
+      builder: false
     },
     _lodashclonedeep2.default.call(void 0, options)
   );
@@ -454,12 +461,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

@@ -70,7 +70,7 @@ function readJson(path3) {
 function writeJson(path3, data) {
   fs.writeFileSync(path3, JSON.stringify(data, null, 2), "utf8");
 }
-function exec(command, args, options) {
+function exec(command, args = [], options) {
   return spawnSync(command, args, Object.assign({ encoding: "utf8" }, options));
 }
 
@@ -130,6 +130,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,6 +207,9 @@ 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"`);
@@ -334,12 +340,7 @@ function preMergeOptions(options) {
     format,
     clean: true,
     dts: false,
-    treeshake: !!isDev,
-    outExtension({ format: format2 }) {
-      return {
-        js: format2 === "esm" ? ".mjs" : `.js`
-      };
-    }
+    treeshake: !!isDev
   };
   const opts = merge2(
     {
@@ -350,8 +351,14 @@ function preMergeOptions(options) {
         ...electron2
       },
       preload: {
-        ...electron2
-      }
+        ...electron2,
+        outExtension({ format: format2 }) {
+          return {
+            js: format2 === "esm" ? ".mjs" : `.js`
+          };
+        }
+      },
+      builder: false
     },
     cloneDeep(options)
   );
@@ -453,12 +460,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.3.9-1",
+  "version": "1.5.0",
   "description": "A simple vite plugin for electron, supports esm/cjs, support esm in electron v28+",
   "keywords": [
     "vite",
@@ -73,7 +73,7 @@
     "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",