@tomjs/vite-plugin-electron 1.1.0 → 1.1.2

package/README.md

@@ -66,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
 
@@ -164,7 +199,6 @@ Based on [Options](https://paka.dev/npm/tsup) of [tsup](https://tsup.egoist.dev/
 
 | Property | Type | Default | Description |
 | --- | --- | --- | --- |
-| name | `string` | "main" | The name of the electron main process. |
 | entry | `string` | `-` | The main process entry file. |
 | format | `'cjs' \| 'esm'` | `-` | The bundle format. If not specified, it will use the "type" field from package.json. |
 | outDir | `string` | "dist-electron/main" | The output directory for the main process files |
@@ -176,7 +210,6 @@ Based on [Options](https://paka.dev/npm/tsup) of [tsup](https://tsup.egoist.dev/
 
 | Property | Type | Default | Description |
 | --- | --- | --- | --- |
-| name | `string` | "preload" | The name of the electron preload process. |
 | entry | `string` | `-` | The preload process entry file. |
 | format | `'cjs' \| 'esm'` | `-` | The bundle format. If not specified, it will use the "type" field from package.json. |
 | outDir | `string` | "dist-electron/preload" | The output directory for the preload process files |

package/README.zh_CN.md

@@ -66,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
 
@@ -165,7 +200,6 @@ export default defineConfig({
 
 | 参数名 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| name | `string` | "main" | main 名称 |
 | **entry** | `string` | `-` | main 入口文件 |
 | format | `'cjs' \| 'esm'` | `-` | 打包格式。如果未指定，将使用 package.json 中的 "type" 字段 |
 | outDir | `string` | `"dist-electron/main"` | main 输出文件夹 |
@@ -177,7 +211,6 @@ export default defineConfig({
 
 | 参数名 | 类型 | 默认值 | 说明 |
 | --- | --- | --- | --- |
-| name | `string` | "preload" | preload 名称 |
 | **entry** | `string` | `-` | preload 入口文件 |
 | format | `'cjs' \| 'esm'` | `-` | 打包格式。如果未指定，将使用 package.json 中的 "type" 字段 |
 | outDir | `string` | `"dist-electron/preload"` | preload 输出文件夹 |

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import { Options } from 'tsup';
 /**
  * Electron main process options
  */
-type MainOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> & {
+interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The name of the electron main process.
      * @default "main"
@@ -27,11 +27,11 @@ type MainOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch
      * A function that will be executed after the build succeeds.
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-};
+}
 /**
  * Electron preload process options
  */
-type PreloadOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> & {
+interface PreloadOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The name of the electron preload process.
      * @default "preload"
@@ -54,7 +54,7 @@ type PreloadOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'wa
      * A function that will be executed after the build succeeds.
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-};
+}
 /**
  * vite plugin options
  */
@@ -84,7 +84,28 @@ interface PluginOptions {
      */
     inspect?: boolean;
 }
+/**
+ * Only used internally
+ */
+interface InnerOptions {
+    /**
+     * whether is vite server
+     */
+    isServer?: boolean;
+    /**
+     * vite server url, will be passed to electron
+     */
+    serverUrl?: string;
+    /**
+     * renderer outDir
+     */
+    rendererOutDir?: string;
+    /**
+     * electron main entry file
+     */
+    mainFile?: string;
+}
 
 declare function vitePluginElectron(options?: PluginOptions): Plugin;
 
-export { vitePluginElectron as default, vitePluginElectron };
+export { InnerOptions, MainOptions, PluginOptions, PreloadOptions, vitePluginElectron as default, vitePluginElectron };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { Options } from 'tsup';
 /**
  * Electron main process options
  */
-type MainOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> & {
+interface MainOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The name of the electron main process.
      * @default "main"
@@ -27,11 +27,11 @@ type MainOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch
      * A function that will be executed after the build succeeds.
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-};
+}
 /**
  * Electron preload process options
  */
-type PreloadOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> & {
+interface PreloadOptions extends Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'watch' | 'onSuccess'> {
     /**
      * The name of the electron preload process.
      * @default "preload"
@@ -54,7 +54,7 @@ type PreloadOptions = Omit<Options, 'name' | 'entry' | 'format' | 'outDir' | 'wa
      * A function that will be executed after the build succeeds.
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
-};
+}
 /**
  * vite plugin options
  */
@@ -84,7 +84,28 @@ interface PluginOptions {
      */
     inspect?: boolean;
 }
+/**
+ * Only used internally
+ */
+interface InnerOptions {
+    /**
+     * whether is vite server
+     */
+    isServer?: boolean;
+    /**
+     * vite server url, will be passed to electron
+     */
+    serverUrl?: string;
+    /**
+     * renderer outDir
+     */
+    rendererOutDir?: string;
+    /**
+     * electron main entry file
+     */
+    mainFile?: string;
+}
 
 declare function vitePluginElectron(options?: PluginOptions): Plugin;
 
-export { vitePluginElectron as default, vitePluginElectron };
+export { InnerOptions, MainOptions, PluginOptions, PreloadOptions, vitePluginElectron as default, vitePluginElectron };

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.1.0",
+  "version": "1.1.2",
   "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"