@tomjs/vite-plugin-electron 1.2.0 → 1.2.2

package/README.md

@@ -6,7 +6,7 @@
 
 > A Simple [vite](https://vitejs.dev/) plugin for [electron](https://www.electronjs.org), supports `esm` and `cjs`.
 
-I learned [caoxiemeihao](https://github.com/caoxiemeihao)'s [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron) and [Doubleshotjs](https://github.com/Doubleshotjs)'s [doubleshot](https://github.com/Doubleshotjs/doubleshot) These two excellent works, combined with some of my own ideas, developed this plugin. I hope that using it can simplify the development configuration and only focus on business development.
+Many thanks to [caoxiemeihao](https://github.com/caoxiemeihao)'s [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron) and [Doubleshotjs](https://github.com/Doubleshotjs)'s [doubleshot](https://github.com/Doubleshotjs/doubleshot) These two excellent libraries inspired me. I hope to use it to simplify development configuration and focus only on business development.
 
 ## Features
 
@@ -15,33 +15,28 @@ I learned [caoxiemeihao](https://github.com/caoxiemeihao)'s [vite-plugin-electro
 - 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)
+- Support `vue` and `react` and other [frameworks](https://vitejs.dev/guide/#trying-vite-online) supported by `vite`
 
 ## Install
 
-With `pnpm`
-
 ```bash
+# pnpm
 pnpm add @tomjs/vite-plugin-electron -D
-```
-
-With `yarn`
 
-```bash
+# yarn
 yarn add @tomjs/vite-plugin-electron -D
-```
 
-With `npm`
-
-```bash
+# npm
 npm i @tomjs/vite-plugin-electron --save-dev
 ```
 
 ## Usage
 
-### Project structure
+### Recommended Agreement
 
-- Recommended `electron` front-end code directory structure
+#### Directory Structure
+
+- Recommend `electron` and page `src` code directory structure
 
 ```
 |--electron
@@ -54,7 +49,7 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |--main.ts
 ```
 
-- Use the default dist output directory of the plugin
+- Zero configuration, default dist output directory
 
 ```
 |--dist
@@ -68,6 +63,10 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |  |--index.html
 ```
 
+#### Default configuration and behavior
+
+See [PluginOptions](#pluginoptions) and `recommended` parameter descriptions in detail
+
 ### electron
 
 `electron/main/index.ts`
@@ -107,10 +106,12 @@ app.whenReady().then(createWindow);
 
 ### vue
 
-Support `ES modules`
+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.
+
 ```json
 {
   "type": "module",
@@ -128,14 +129,17 @@ import vue from '@vitejs/plugin-vue';
 export default defineConfig({
   plugins: [
     vue(),
-    electron({
-      main: {
-        entry: 'electron/main/index.ts',
-      },
-      preload: {
-        entry: 'electron/preload/index.ts',
-      },
-    }),
+    // If you use the agreed directory structure, no configuration is required
+    electron(),
+    // If the directory structure is customized, the value must be assigned according to the actual situation
+    // electron({
+    //   main: {
+    //     entry: 'electron/main/index.ts',
+    //   },
+    //   preload: {
+    //     entry: 'electron/preload/index.ts',
+    //   },
+    // }),
     // renderer(),
   ],
 });
@@ -143,7 +147,7 @@ export default defineConfig({
 
 ### react
 
-Support `CommonJS`
+Take using `cjs` as an example
 
 - `package.json`
 
@@ -158,23 +162,11 @@ Support `CommonJS`
 
 ```ts
 import { defineConfig } from 'vite';
-// import renderer from 'vite-plugin-electron-renderer'; // Enable nodeIntegration
 import electron from '@tomjs/vite-plugin-electron';
 import react from '@vitejs/plugin-react-swc';
 
 export default defineConfig({
-  plugins: [
-    react(),
-    electron({
-      main: {
-        entry: 'electron/main/index.ts',
-      },
-      preload: {
-        entry: 'electron/preload/index.ts',
-      },
-    }),
-    // renderer(),
-  ],
+  plugins: [react(), electron()],
 });
 ```
 
@@ -195,6 +187,14 @@ export default defineConfig({
 | preload | [PreloadOptions](#PreloadOptions) |  | Configuration options for the electron preload process. |
 | inspect | `boolean` | true | If set to true, electron will start with the `--inspect` flag. |
 
+**Notice**
+
+The `recommended` option is used to set the default configuration and behavior, which can be used with almost zero configuration. The default is `true`. If you want to customize the configuration, set it to `false`. The following default prerequisites are to use the recommended [project structure](#directory-structure).
+
+- Check whether `electron/main/index.ts` and `electron/main/index.ts` exist, and if so, assign values to `main.entry` and `preload.entry` respectively. If it does not exist, `main.entry` must be actively assigned, and an error will be reported.
+- The output directory is based on the `build.outDir` parameter of `vite`, and outputs `electron/main`, `electron/preload` and `src` to `dist/main`, `dist/preload` and `dist/renderer` respectively.
+- Other behaviors to be implemented
+
 ### MainOptions
 
 Based on [Options](https://paka.dev/npm/tsup) of [tsup](https://tsup.egoist.dev/), some default values are added for ease of use.

package/README.zh_CN.md

@@ -6,7 +6,7 @@
 
 > 一个简单的 [electron](https://www.electronjs.org/zh/) [vite](https://cn.vitejs.dev/) 插件，支持 `esm` 和 `cjs`
 
-学习了 [caoxiemeihao](https://github.com/caoxiemeihao) 的 [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron) 和 [Doubleshotjs](https://github.com/Doubleshotjs) 的 [doubleshot](https://github.com/Doubleshotjs/doubleshot) 这两个优秀的作品，结合自己的一些想法，开发了该插件。希望使用它能简化开发配置，只关注业务开发。
+非常感谢 [caoxiemeihao](https://github.com/caoxiemeihao) 的 [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron) 和 [Doubleshotjs](https://github.com/Doubleshotjs) 的 [doubleshot](https://github.com/Doubleshotjs/doubleshot) 这两个优秀库给了我启发。我希望使用它能简化开发配置，只关注业务开发。
 
 ## 特性
 
@@ -15,33 +15,28 @@
 - 支持 `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)
+- 支持 `vue` 和 `react` 等其他 `vite` 支持的[框架](https://cn.vitejs.dev/guide/#trying-vite-online)
 
 ## 安装
 
-使用 `pnpm`
-
 ```bash
+# pnpm
 pnpm add @tomjs/vite-plugin-electron -D
-```
-
-使用 `yarn`
 
-```bash
+# yarn
 yarn add @tomjs/vite-plugin-electron -D
-```
 
-使用 `npm`
-
-```bash
+# npm
 npm i @tomjs/vite-plugin-electron --save-dev
 ```
 
 ## 使用说明
 
-### 项目结构
+### 推荐约定
 
-- 推荐 `electron` 的 前端代码目录结构
+#### 目录结构
+
+- 推荐 `electron` 和 页面 `src` 代码目录结构
 
 ```
 |--electron
@@ -54,7 +49,7 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |--main.ts
 ```
 
-- 使用插件默认 dist 输出目录
+- 零配置，默认 dist 输出目录
 
 ```
 |--dist
@@ -68,6 +63,10 @@ npm i @tomjs/vite-plugin-electron --save-dev
 |  |  |--index.html
 ```
 
+#### 默认配置和行为
+
+详细查看 [PluginOptions](#pluginoptions) 和 `recommended` 参数说明
+
 ### electron
 
 `electron/main/index.ts`
@@ -107,10 +106,12 @@ app.whenReady().then(createWindow);
 
 ### vue
 
-支持 `ES modules`
+以使用 `esm` 为例，不过要求 `Electron>=28`
 
 - `package.json`
 
+Electron preload 必须使用 `mjs` 后缀，否则报错。所以 `esm` 也默认输出使用 `mjs` 后缀。
+
 ```json
 {
   "type": "module",
@@ -129,14 +130,17 @@ import vue from '@vitejs/plugin-vue';
 export default defineConfig({
   plugins: [
     vue(),
-    electron({
-      main: {
-        entry: 'electron/main/index.ts',
-      },
-      preload: {
-        entry: 'electron/preload/index.ts',
-      },
-    }),
+    // 如使用约定的目录结构，则不需要配置
+    electron(),
+    // 如果自定义了目录结构，则必须根据实际情况赋值
+    // electron({
+    //   main: {
+    //     entry: 'electron/main/index.ts',
+    //   },
+    //   preload: {
+    //     entry: 'electron/preload/index.ts',
+    //   },
+    // }),
     // renderer(),
   ],
 });
@@ -144,7 +148,7 @@ export default defineConfig({
 
 ### react
 
-支持 `CommonJS`
+以使用 `cjs` 为例
 
 - `package.json`
 
@@ -159,23 +163,11 @@ export default defineConfig({
 
 ```ts
 import { defineConfig } from 'vite';
-// import renderer from 'vite-plugin-electron-renderer'; // 启用 nodeIntegration
 import electron from '@tomjs/vite-plugin-electron';
 import react from '@vitejs/plugin-react-swc';
 
 export default defineConfig({
-  plugins: [
-    react(),
-    electron({
-      main: {
-        entry: 'electron/main/index.ts',
-      },
-      preload: {
-        entry: 'electron/preload/index.ts',
-      },
-    }),
-    // renderer(),
-  ],
+  plugins: [react(), electron()],
 });
 ```
 
@@ -192,10 +184,16 @@ export default defineConfig({
 | --- | --- | --- | --- |
 | recommended | `boolean` | `true` | 推荐开关，如果为true，将具有以下默认行为：将main/preload/renderer的outDir更改为并行的outDir；例如，如果vite build.outDir为'dist'，将main/preload/render更改为'dist/main'、'dist/preload'和'dist/renderer' |
 | external | `string[]` |  | 不打包这些模块 |
-| **main** | [MainOptions](#MainOptions) |  | electron main 进程选项 |
+| main | [MainOptions](#MainOptions) |  | electron main 进程选项 |
 | preload | [PreloadOptions](#PreloadOptions) |  | electron preload 进程选项 |
 | inspect | `boolean` | `true` | electron启动时使用`--inspect`参数 |
 
+`recommended` 选项用于设置默认配置和行为，几乎可以达到零配置使用，默认为 `true` 。如果你要自定义配置，请设置它为`false`。以下默认的前提条件是使用推荐的 [项目结构](#目录结构)。
+
+- 检查是否存在 `electron/main/index.ts` 和 `electron/main/index.ts`，如果有则分别给 `main.entry` 和 `preload.entry` 赋值。如果不存在，`main.entry` 必须主动赋值，负责会报错
+- 输出目录根据 `vite` 的 `build.outDir` 参数， 将 `electron/main`、`electron/preload`、`src` 分别输出到 `dist/main`、`dist/preload`、`dist/renderer`
+- 其他待实现的行为
+
 ### MainOptions
 
 继承自 [tsup](https://tsup.egoist.dev/) 的 [Options](https://paka.dev/npm/tsup)，添加了一些默认值，方便使用。

package/dist/index.d.mts

@@ -2,20 +2,15 @@ import { Plugin } from 'vite';
 import { Options } from 'tsup';
 
 /**
- * Electron main process options.
+ * Electron main process options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
  * @see https://paka.dev/npm/tsup
  * @see https://unpkg.com/browse/tsup/dist/index.d.ts
  */
-interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
-    /**
-     * The name of the electron main process.
-     * @default "main"
-     */
-    name?: string;
+interface MainOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The main process entry file.
      */
-    entry: string;
+    entry?: string;
     /**
      * The bundle format. If not specified, it will use the "type" field from package.json.
      */
@@ -31,16 +26,11 @@ interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDi
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
 }
 /**
- * Electron preload process options.
+ * Electron preload process options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
  * @see https://paka.dev/npm/tsup
  * @see https://unpkg.com/browse/tsup/dist/index.d.ts
  */
-interface PreloadOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
-    /**
-     * The name of the electron preload process.
-     * @default "preload"
-     */
-    name?: string;
+interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The preload process entry file
      */
@@ -78,7 +68,7 @@ interface PluginOptions {
     /**
      * electron main process options
      */
-    main: MainOptions;
+    main?: MainOptions;
     /**
      * electron preload process options
      */

package/dist/index.d.ts

@@ -2,20 +2,15 @@ import { Plugin } from 'vite';
 import { Options } from 'tsup';
 
 /**
- * Electron main process options.
+ * Electron main process options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
  * @see https://paka.dev/npm/tsup
  * @see https://unpkg.com/browse/tsup/dist/index.d.ts
  */
-interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
-    /**
-     * The name of the electron main process.
-     * @default "main"
-     */
-    name?: string;
+interface MainOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The main process entry file.
      */
-    entry: string;
+    entry?: string;
     /**
      * The bundle format. If not specified, it will use the "type" field from package.json.
      */
@@ -31,16 +26,11 @@ interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDi
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
 }
 /**
- * Electron preload process options.
+ * Electron preload process options. See [tsup](https://tsup.egoist.dev/) and [API Doc](https://paka.dev/npm/tsup) for more information.
  * @see https://paka.dev/npm/tsup
  * @see https://unpkg.com/browse/tsup/dist/index.d.ts
  */
-interface PreloadOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
-    /**
-     * The name of the electron preload process.
-     * @default "preload"
-     */
-    name?: string;
+interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The preload process entry file
      */
@@ -78,7 +68,7 @@ interface PluginOptions {
     /**
      * electron main process options
      */
-    main: MainOptions;
+    main?: MainOptions;
     /**
      * electron preload process options
      */

package/dist/index.js

@@ -172,11 +172,9 @@ function preMergeOptions(options) {
       recommended: true,
       external: ["electron"],
       main: {
-        name: "main",
         ...electron2
       },
       preload: {
-        name: "payload",
         ...electron2
       }
     },
@@ -187,7 +185,12 @@ function preMergeOptions(options) {
     const fmt = opt.format;
     opt.format = ["cjs", "esm"].includes(fmt) ? [fmt] : [format];
     const entry = opt.entry;
-    if (typeof entry === "string") {
+    if (entry == void 0) {
+      const filePath = `electron/${prop}/index.ts`;
+      if (_fs2.default.existsSync(_path2.default.join(process.cwd(), filePath))) {
+        opt.entry = [filePath];
+      }
+    } else if (typeof entry === "string") {
       opt.entry = [entry];
     }
     const external = opt.external || opts.external || ["electron"];
@@ -205,21 +208,22 @@ function vitePluginElectron(options) {
       var _a;
       isServer = env.command === "serve";
       let outDir = ((_a = config == null ? void 0 : config.build) == null ? void 0 : _a.outDir) || "dist";
-      opts.preload = opts.preload || {};
+      opts.main ||= {};
+      opts.preload ||= {};
       if (opts.recommended) {
         opts.main.outDir = _path2.default.join(outDir, "main");
         opts.preload.outDir = _path2.default.join(outDir, "preload");
         outDir = _path2.default.join(outDir, "renderer");
       } else {
-        opts.main.outDir = opts.main.outDir || _path2.default.join("dist-electron", "main");
-        opts.preload.outDir = opts.preload.outDir || _path2.default.join("dist-electron", "preload");
+        opts.main.outDir ||= _path2.default.join("dist-electron", "main");
+        opts.preload.outDir ||= _path2.default.join("dist-electron", "preload");
       }
       if (isDev) {
-        opts.main.sourcemap = _nullishCoalesce(opts.main.sourcemap, () => ( true));
-        opts.preload.sourcemap = _nullishCoalesce(opts.main.sourcemap, () => ( true));
+        opts.main.sourcemap ??= true;
+        opts.preload.sourcemap ??= true;
       } else {
-        opts.main.minify = _nullishCoalesce(opts.main.minify, () => ( true));
-        opts.preload.minify = _nullishCoalesce(opts.preload.minify, () => ( true));
+        opts.main.minify ??= true;
+        opts.preload.minify ??= true;
       }
       return {
         build: {

package/dist/index.mjs

@@ -171,11 +171,9 @@ function preMergeOptions(options) {
       recommended: true,
       external: ["electron"],
       main: {
-        name: "main",
         ...electron2
       },
       preload: {
-        name: "payload",
         ...electron2
       }
     },
@@ -186,7 +184,12 @@ function preMergeOptions(options) {
     const fmt = opt.format;
     opt.format = ["cjs", "esm"].includes(fmt) ? [fmt] : [format];
     const entry = opt.entry;
-    if (typeof entry === "string") {
+    if (entry == void 0) {
+      const filePath = `electron/${prop}/index.ts`;
+      if (fs2.existsSync(path.join(process.cwd(), filePath))) {
+        opt.entry = [filePath];
+      }
+    } else if (typeof entry === "string") {
       opt.entry = [entry];
     }
     const external = opt.external || opts.external || ["electron"];
@@ -204,21 +207,22 @@ function vitePluginElectron(options) {
       var _a;
       isServer = env.command === "serve";
       let outDir = ((_a = config == null ? void 0 : config.build) == null ? void 0 : _a.outDir) || "dist";
-      opts.preload = opts.preload || {};
+      opts.main ||= {};
+      opts.preload ||= {};
       if (opts.recommended) {
         opts.main.outDir = path.join(outDir, "main");
         opts.preload.outDir = path.join(outDir, "preload");
         outDir = path.join(outDir, "renderer");
       } else {
-        opts.main.outDir = opts.main.outDir || path.join("dist-electron", "main");
-        opts.preload.outDir = opts.preload.outDir || path.join("dist-electron", "preload");
+        opts.main.outDir ||= path.join("dist-electron", "main");
+        opts.preload.outDir ||= path.join("dist-electron", "preload");
       }
       if (isDev) {
-        opts.main.sourcemap = opts.main.sourcemap ?? true;
-        opts.preload.sourcemap = opts.main.sourcemap ?? true;
+        opts.main.sourcemap ??= true;
+        opts.preload.sourcemap ??= true;
       } else {
-        opts.main.minify = opts.main.minify ?? true;
-        opts.preload.minify = opts.preload.minify ?? true;
+        opts.main.minify ??= true;
+        opts.preload.minify ??= true;
       }
       return {
         build: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A simple vite plugin for electron, supports esm/cjs.",
   "keywords": [
     "vite",