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

package/README.md

@@ -16,6 +16,7 @@ Many thanks to [caoxiemeihao](https://github.com/caoxiemeihao)'s [vite-plugin-el
 - 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) supported by `vite`
+- Optional [electron-builder](https://www.electron.build/) Simple configuration
 
 ## Install
 
@@ -218,6 +219,63 @@ 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
+
+When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
+
+- 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.
+
+_Not suitable for everyone._
+
+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) |
+
+The default configuration is as follows:
+
+```ts
+const config = {
+  directories: {
+    buildResources: 'electron/build',
+    app: path.dirname(resolvedConfig.build.outDir),
+    output: 'release/${version}',
+  },
+  files: ['main', 'preload', 'renderer'],
+  artifactName: '${productName}-${version}-${os}-${arch}.${ext}',
+  electronDownload: {
+    // when npm registry mirror is 'registry.npmmirror.com'
+    mirror: 'https://npmmirror.com/mirrors/electron',
+  },
+  electronLanguages: ['zh-CN', 'en-US'],
+  win: {
+    target: [
+      {
+        target: 'nsis',
+        arch: ['x64'],
+      },
+    ],
+  },
+  mac: {
+    target: ['dmg'],
+  },
+  linux: {
+    target: ['zip'],
+  },
+  nsis: {
+    oneClick: false,
+    perMachine: false,
+    allowToChangeInstallationDirectory: true,
+    deleteAppDataOnUninstall: false,
+  },
+};
+```
+
 ### Additional Information
 
 - Default values for `main` and `preload` when the relevant parameters are not configured

package/README.zh_CN.md

@@ -16,6 +16,7 @@
 - 支持 `preload` 的 `热重载`
 - 支持 `esm` 和 `cjs` ，你可以在 [electron v28+](https://www.electronjs.org/zh/blog/electron-28-0) 中使用 `esm`
 - 支持 `vue` 和 `react` 等其他 `vite` 支持的[框架](https://cn.vitejs.dev/guide/#trying-vite-online)
+- 可选 [electron-builder](https://www.electron.build/) 简单配置打包
 
 ## 安装
 
@@ -217,6 +218,63 @@ export default defineConfig({
 | outDir | `string` | `"dist-electron/preload"` | preload 输出文件夹 |
 | onSuccess | `() => Promise<void \| undefined \| (() => void \| Promise<void>)>` | `undefined` | 构建成功后运行的回调函数 |
 
+### BuilderOptions
+
+当 `recommended` 和 `builder.enable` 都为 `true` 时，使用 [electron-builder](https://www.electron.build) 打包 Electron 应用程序。
+
+- 在vite中配置的`build.outDir`目录中，根据配置和package.json生成新的package.json，排除非依赖项。
+- 执行`npm install`然后打包。
+
+_不适合所有人使用。_
+
+使用该功能，需要额外安装 `electron-builder`
+
+| 参数名 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| 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) |
+
+默认配置如下
+
+```ts
+const config = {
+  directories: {
+    buildResources: 'electron/build',
+    app: path.dirname(resolvedConfig.build.outDir),
+    output: 'release/${version}',
+  },
+  files: ['main', 'preload', 'renderer'],
+  artifactName: '${productName}-${version}-${os}-${arch}.${ext}',
+  electronDownload: {
+    // when npm registry mirror is 'registry.npmmirror.com'
+    mirror: 'https://npmmirror.com/mirrors/electron',
+  },
+  electronLanguages: ['zh-CN', 'en-US'],
+  win: {
+    target: [
+      {
+        target: 'nsis',
+        arch: ['x64'],
+      },
+    ],
+  },
+  mac: {
+    target: ['dmg'],
+  },
+  linux: {
+    target: ['zip'],
+  },
+  nsis: {
+    oneClick: false,
+    perMachine: false,
+    allowToChangeInstallationDirectory: true,
+    deleteAppDataOnUninstall: false,
+  },
+};
+```
+
 ### 补充说明
 
 - `main` 和 `preload` 未配置相关参数时的默认值

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { Plugin } from 'vite';
+import { Configuration } from 'electron-builder';
 import { Options } from 'tsup';
 
 /**
@@ -49,6 +50,34 @@ interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | '
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
 }
+/**
+ * When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
+ *
+ * * 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.
+ */
+interface BuilderOptions {
+    /**
+     * Whether to enable the [electron-builder](https://www.electron.build), the default is false.
+     * @default false
+     */
+    enable?: boolean;
+    /**
+     * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
+     * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.
+     * @default com.electron.${name}
+     */
+    appId?: string | null;
+    /**
+     * As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).
+     * If not specified inside of the `build` configuration, `productName` property defined at the top level of `package.json` is used. If not specified at the top level of `package.json`, [name property](https://docs.npmjs.com/files/package.json#name) is used.
+     */
+    productName?: string | null;
+    /**
+     * The [electron-builder](https://www.electron.build/configuration/configuration) configuration.
+     */
+    builderConfig?: Configuration;
+}
 /**
  * vite plugin options
  */
@@ -65,7 +94,7 @@ interface PluginOptions {
      * Don't bundle these modules, but dependencies and peerDependencies in your package.json are always excluded. [See more](https://tsup.egoist.dev/#excluding-packages)
      * @see https://tsup.egoist.dev/#excluding-packages
      */
-    external?: string[];
+    external?: (string | RegExp)[];
     /**
      * electron main process options
      */
@@ -74,6 +103,13 @@ interface PluginOptions {
      * electron preload process options
      */
     preload?: PreloadOptions;
+    /**
+     * When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
+     *
+     * * 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;
     /**
      * electron debug mode, don't startup electron. You can also use `process.env.APP_ELECTRON_DEBUG`. Default is false.
      * @default false
@@ -89,6 +125,10 @@ interface PluginOptions {
     inspect?: number | boolean;
 }
 
-declare function vitePluginElectron(options?: PluginOptions): Plugin;
+/**
+ * A simple vite plugin for electron
+ * @param options
+ */
+declare function useElectronPlugin(options?: PluginOptions): Plugin;
 
-export { MainOptions, PluginOptions, PreloadOptions, vitePluginElectron as default, vitePluginElectron };
+export { BuilderOptions, MainOptions, PluginOptions, PreloadOptions, useElectronPlugin as default, useElectronPlugin };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Plugin } from 'vite';
+import { Configuration } from 'electron-builder';
 import { Options } from 'tsup';
 
 /**
@@ -49,6 +50,34 @@ interface PreloadOptions extends Omit<Options, 'entry' | 'format' | 'outDir' | '
      */
     onSuccess?: () => Promise<void | undefined | (() => void | Promise<void>)>;
 }
+/**
+ * When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
+ *
+ * * 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.
+ */
+interface BuilderOptions {
+    /**
+     * Whether to enable the [electron-builder](https://www.electron.build), the default is false.
+     * @default false
+     */
+    enable?: boolean;
+    /**
+     * The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
+     * [Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.
+     * @default com.electron.${name}
+     */
+    appId?: string | null;
+    /**
+     * As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).
+     * If not specified inside of the `build` configuration, `productName` property defined at the top level of `package.json` is used. If not specified at the top level of `package.json`, [name property](https://docs.npmjs.com/files/package.json#name) is used.
+     */
+    productName?: string | null;
+    /**
+     * The [electron-builder](https://www.electron.build/configuration/configuration) configuration.
+     */
+    builderConfig?: Configuration;
+}
 /**
  * vite plugin options
  */
@@ -65,7 +94,7 @@ interface PluginOptions {
      * Don't bundle these modules, but dependencies and peerDependencies in your package.json are always excluded. [See more](https://tsup.egoist.dev/#excluding-packages)
      * @see https://tsup.egoist.dev/#excluding-packages
      */
-    external?: string[];
+    external?: (string | RegExp)[];
     /**
      * electron main process options
      */
@@ -74,6 +103,13 @@ interface PluginOptions {
      * electron preload process options
      */
     preload?: PreloadOptions;
+    /**
+     * When `recommended` and `builder.enable` are both `true`, use [electron-builder](https://www.electron.build) to package Electron applications.
+     *
+     * * 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;
     /**
      * electron debug mode, don't startup electron. You can also use `process.env.APP_ELECTRON_DEBUG`. Default is false.
      * @default false
@@ -89,6 +125,10 @@ interface PluginOptions {
     inspect?: number | boolean;
 }
 
-declare function vitePluginElectron(options?: PluginOptions): Plugin;
+/**
+ * A simple vite plugin for electron
+ * @param options
+ */
+declare function useElectronPlugin(options?: PluginOptions): Plugin;
 
-export { MainOptions, PluginOptions, PreloadOptions, vitePluginElectron as default, vitePluginElectron };
+export { BuilderOptions, MainOptions, PluginOptions, PreloadOptions, useElectronPlugin as default, useElectronPlugin };

package/dist/index.js

@@ -1,22 +1,25 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/index.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } } function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }// src/index.ts
 var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
 var _process = require('process');
 var _lodashclonedeep = require('lodash.clonedeep'); var _lodashclonedeep2 = _interopRequireDefault(_lodashclonedeep);
 var _lodashmerge = require('lodash.merge'); var _lodashmerge2 = _interopRequireDefault(_lodashmerge);
 var _path = require('path'); var _path2 = _interopRequireDefault(_path);
 
-// src/constants.ts
-var PLUGIN_NAME = "@tomjs:electron";
+// src/builder.ts
+var _os = require('os'); var _os2 = _interopRequireDefault(_os);
+
+
 
-// 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');
 
 // src/logger.ts
 var _dayjs = require('dayjs'); var _dayjs2 = _interopRequireDefault(_dayjs);
 var _kolorist = require('kolorist');
+
+// src/constants.ts
+var PLUGIN_NAME = "@tomjs:electron";
+var PACKAGE_NAME = "@tomjs/vite-plugin-electron";
+
+// src/logger.ts
 var Logger = class {
   constructor(tag, withTime) {
     this.tag = PLUGIN_NAME;
@@ -56,8 +59,170 @@ var createLogger = (tag) => {
   return new Logger(tag || PLUGIN_NAME, true);
 };
 
-// src/main.ts
+// src/utils.ts
+var _child_process = require('child_process');
+
+var _module = require('module');
+function readJson(path3) {
+  if (_fs2.default.existsSync(path3)) {
+    return JSON.parse(_fs2.default.readFileSync(path3, "utf8"));
+  }
+}
+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();
+function getMirror() {
+  let mirror = process.env.ELECTRON_MIRROR;
+  if (mirror) {
+    return mirror;
+  }
+  const res = exec(_os2.default.platform() === "win32" ? "npm.cmd" : "npm", ["config", "get", "registry"]);
+  if (res.status === 0) {
+    let registry = res.stdout;
+    if (!registry) {
+      return;
+    }
+    registry = registry.trim();
+    if (registry && ["registry.npmmirror.com", "registry.npm.taobao.org"].find((s) => registry.includes(s))) {
+      mirror = "https://npmmirror.com/mirrors/electron";
+    }
+  }
+  return mirror;
+}
+function getBuilderConfig(options, resolvedConfig) {
+  var _a;
+  createPkg(options, resolvedConfig);
+  const config = {
+    directories: {
+      buildResources: "electron/build",
+      app: _path2.default.dirname(resolvedConfig.build.outDir),
+      output: "release/${version}"
+    },
+    files: ["main", "preload", "renderer"],
+    artifactName: "${productName}-${version}-${os}-${arch}.${ext}",
+    electronDownload: {
+      mirror: getMirror()
+    },
+    electronLanguages: ["zh-CN", "en-US"],
+    win: {
+      target: [
+        {
+          target: "nsis",
+          arch: ["x64"]
+        }
+      ]
+    },
+    mac: {
+      target: ["dmg"]
+    },
+    linux: {
+      target: ["zip"]
+    },
+    nsis: {
+      oneClick: false,
+      perMachine: false,
+      allowToChangeInstallationDirectory: true,
+      deleteAppDataOnUninstall: false
+    }
+  };
+  const { appId, productName } = options.builder || {};
+  return _lodashmerge2.default.call(void 0, config, { appId, productName }, (_a = options.builder) == null ? void 0 : _a.builderConfig);
+}
+function createPkg(options, resolvedConfig) {
+  var _a, _b;
+  const externals = options.external || [];
+  const viteExternals = (_a = resolvedConfig.build.rollupOptions) == null ? void 0 : _a.external;
+  if (Array.isArray(viteExternals)) {
+    externals.push(...viteExternals);
+  } else if (typeof viteExternals === "string") {
+    externals.push(viteExternals);
+  }
+  const pkg = readJson(_path2.default.join(process.cwd(), "package.json"));
+  if (!pkg) {
+    throw new Error(`package.json not found in ${process.cwd()}`);
+  }
+  const outDir = _path2.default.dirname(resolvedConfig.build.outDir);
+  let main = pkg.main;
+  if (main) {
+    main = main.replace("./", "");
+    main = main.substring(main.indexOf(outDir) + outDir.length);
+    if (main.startsWith("/")) {
+      main = main.substring(1);
+    }
+  } else {
+    main = `main/index.${((_b = options == null ? void 0 : options.main) == null ? void 0 : _b.format) === "esm" ? "" : "m"}js`;
+  }
+  const newPkg = {
+    name: pkg.name,
+    version: pkg.version,
+    description: pkg.description,
+    type: pkg.type || "commonjs",
+    author: getAuthor(pkg.author),
+    main,
+    dependencies: getDeps()
+  };
+  writeJson(_path2.default.join(outDir, "package.json"), newPkg);
+  function getAuthor(author) {
+    const uname = _os2.default.userInfo().username;
+    if (!author) {
+      return uname;
+    } else if (typeof author === "string") {
+      return author;
+    } else if (typeof author === "object") {
+      if (!author.name) {
+        return uname;
+      }
+      const email = author.email ? ` <${author.email}>` : "";
+      return `${author.name}${email}`;
+    }
+    return uname;
+  }
+  function checkDepName(rules, name) {
+    return !!rules.find((s) => {
+      if (typeof s === "string") {
+        return s.includes(name);
+      } else {
+        return s.test(name);
+      }
+    });
+  }
+  function getDeps() {
+    const deps = pkg.dependencies || {};
+    const newDeps = {};
+    Object.keys(deps).forEach((name) => {
+      if (checkDepName(externals, name)) {
+        newDeps[name] = deps[name];
+      }
+    });
+    return newDeps;
+  }
+  return newPkg;
+}
+async function runElectronBuilder(options, resolvedConfig) {
+  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`);
+  logger.info(`run electron-builder to package app`);
+  const config = getBuilderConfig(options, resolvedConfig);
+  const { build } = await Promise.resolve().then(() => _interopRequireWildcard(require("electron-builder")));
+  await build({
+    config
+  });
+}
+
+// src/main.ts
+
+var _electron = require('electron'); var _electron2 = _interopRequireDefault(_electron);
+var _treekill = require('tree-kill'); var _treekill2 = _interopRequireDefault(_treekill);
+var _tsup = require('tsup');
+var logger2 = createLogger();
 function getBuildOptions(options) {
   return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
     options[s].__NAME__ = s;
@@ -108,32 +273,32 @@ startup.exit = async () => {
   });
 };
 async function runServe(options, server) {
-  options.debug && logger.warn(`debug mode`);
+  options.debug && logger2.warn(`debug mode`);
   const buildOptions = getBuildOptions(options);
   const buildCounts = [0, buildOptions.length > 1 ? 0 : 1];
   for (let i = 0; i < buildOptions.length; i++) {
     const tsOpts = buildOptions[i];
     const { __NAME__: name, onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
-    logger.info(`${name} build`);
+    logger2.info(`${name} build`);
     const onSuccess = async () => {
       if (typeof _onSuccess === "function") {
         await _onSuccess();
       }
       if (buildCounts[i] <= 0) {
         buildCounts[i]++;
-        logger.info(`${name} build succeeded`);
+        logger2.info(`${name} build succeeded`);
         if (buildCounts[0] == 1 && buildCounts[1] == 1) {
-          logger.info("electron startup");
+          logger2.info("electron startup");
           await startup(options);
         }
         return;
       }
-      logger.success(`${name} rebuild succeeded!`);
+      logger2.success(`${name} rebuild succeeded!`);
       if (name === "main") {
-        logger.info("electron restart");
+        logger2.info("electron restart");
         await startup(options);
       } else {
-        logger.info("page reload");
+        logger2.info("page reload");
         server.ws.send({
           type: "full-reload"
         });
@@ -149,15 +314,6 @@ async function runBuild(options) {
   }
 }
 
-// src/utils.ts
-
-var _module = require('module');
-function readJson(path2) {
-  if (_fs2.default.existsSync(path2)) {
-    return JSON.parse(_fs2.default.readFileSync(path2, "utf8"));
-  }
-}
-
 // src/index.ts
 var isDev = process.env.NODE_ENV === "development";
 function getPkg() {
@@ -228,9 +384,10 @@ function geNumberBooleanValue(value) {
   const v = Number(value);
   return Number.isNaN(v) ? void 0 : v;
 }
-function vitePluginElectron(options) {
+function useElectronPlugin(options) {
   const opts = preMergeOptions(options);
   let isServer = false;
+  let resolvedConfig;
   return {
     name: PLUGIN_NAME,
     config(config, env) {
@@ -273,6 +430,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;
+      resolvedConfig = config;
     },
     configureServer(server) {
       if (!server || !server.httpServer) {
@@ -285,13 +443,7 @@ function vitePluginElectron(options) {
         const hostname = family === "IPv6" ? `[${address}]` : address;
         const protocol = server.config.server.https ? "https" : "http";
         process.env.APP_DEV_SERVER_URL = `${protocol}://${hostname}:${port}`;
-        const DEBUG_PATH = _path2.default.resolve(
-          _process.cwd.call(void 0, ),
-          "node_modules",
-          "@tomjs",
-          "vite-plugin-electron",
-          "debug"
-        );
+        const DEBUG_PATH = _path2.default.resolve(_process.cwd.call(void 0, ), "node_modules", PACKAGE_NAME, "debug");
         if (!_fs2.default.existsSync(DEBUG_PATH)) {
           _fs.mkdirSync.call(void 0, DEBUG_PATH, { recursive: true });
         }
@@ -302,15 +454,19 @@ ${env}`);
       });
     },
     async closeBundle() {
+      var _a;
       if (isServer) {
         return;
       }
       await runBuild(opts);
+      if (opts.recommended && ((_a = opts.builder) == null ? void 0 : _a.enable)) {
+        await runElectronBuilder(opts, resolvedConfig);
+      }
     }
   };
 }
-var src_default = vitePluginElectron;
+var src_default = useElectronPlugin;
 
 
 
-exports.default = src_default; exports.vitePluginElectron = vitePluginElectron;
+exports.default = src_default; exports.useElectronPlugin = useElectronPlugin;

package/dist/index.mjs

@@ -1,22 +1,25 @@
 // src/index.ts
 import fs2, { mkdirSync, writeFileSync } from "fs";
-import { cwd } from "process";
+import { cwd as cwd2 } from "process";
 import cloneDeep from "lodash.clonedeep";
-import merge from "lodash.merge";
+import merge2 from "lodash.merge";
+import path2 from "path";
+
+// src/builder.ts
+import os from "os";
 import path from "path";
+import { cwd } from "process";
+import merge from "lodash.merge";
+
+// src/logger.ts
+import dayjs from "dayjs";
+import { blue, gray, green, red, yellow } from "kolorist";
 
 // src/constants.ts
 var PLUGIN_NAME = "@tomjs:electron";
-
-// src/main.ts
-import { spawn } from "child_process";
-import electron from "electron";
-import treeKill from "tree-kill";
-import { build as tsupBuild } from "tsup";
+var PACKAGE_NAME = "@tomjs/vite-plugin-electron";
 
 // src/logger.ts
-import dayjs from "dayjs";
-import { blue, gray, green, red, yellow } from "kolorist";
 var Logger = class {
   constructor(tag, withTime) {
     this.tag = PLUGIN_NAME;
@@ -56,8 +59,169 @@ var createLogger = (tag) => {
   return new Logger(tag || PLUGIN_NAME, true);
 };
 
-// src/main.ts
+// src/utils.ts
+import { spawnSync } from "child_process";
+import fs from "fs";
+function readJson(path3) {
+  if (fs.existsSync(path3)) {
+    return JSON.parse(fs.readFileSync(path3, "utf8"));
+  }
+}
+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();
+function getMirror() {
+  let mirror = process.env.ELECTRON_MIRROR;
+  if (mirror) {
+    return mirror;
+  }
+  const res = exec(os.platform() === "win32" ? "npm.cmd" : "npm", ["config", "get", "registry"]);
+  if (res.status === 0) {
+    let registry = res.stdout;
+    if (!registry) {
+      return;
+    }
+    registry = registry.trim();
+    if (registry && ["registry.npmmirror.com", "registry.npm.taobao.org"].find((s) => registry.includes(s))) {
+      mirror = "https://npmmirror.com/mirrors/electron";
+    }
+  }
+  return mirror;
+}
+function getBuilderConfig(options, resolvedConfig) {
+  var _a;
+  createPkg(options, resolvedConfig);
+  const config = {
+    directories: {
+      buildResources: "electron/build",
+      app: path.dirname(resolvedConfig.build.outDir),
+      output: "release/${version}"
+    },
+    files: ["main", "preload", "renderer"],
+    artifactName: "${productName}-${version}-${os}-${arch}.${ext}",
+    electronDownload: {
+      mirror: getMirror()
+    },
+    electronLanguages: ["zh-CN", "en-US"],
+    win: {
+      target: [
+        {
+          target: "nsis",
+          arch: ["x64"]
+        }
+      ]
+    },
+    mac: {
+      target: ["dmg"]
+    },
+    linux: {
+      target: ["zip"]
+    },
+    nsis: {
+      oneClick: false,
+      perMachine: false,
+      allowToChangeInstallationDirectory: true,
+      deleteAppDataOnUninstall: false
+    }
+  };
+  const { appId, productName } = options.builder || {};
+  return merge(config, { appId, productName }, (_a = options.builder) == null ? void 0 : _a.builderConfig);
+}
+function createPkg(options, resolvedConfig) {
+  var _a, _b;
+  const externals = options.external || [];
+  const viteExternals = (_a = resolvedConfig.build.rollupOptions) == null ? void 0 : _a.external;
+  if (Array.isArray(viteExternals)) {
+    externals.push(...viteExternals);
+  } else if (typeof viteExternals === "string") {
+    externals.push(viteExternals);
+  }
+  const pkg = readJson(path.join(process.cwd(), "package.json"));
+  if (!pkg) {
+    throw new Error(`package.json not found in ${process.cwd()}`);
+  }
+  const outDir = path.dirname(resolvedConfig.build.outDir);
+  let main = pkg.main;
+  if (main) {
+    main = main.replace("./", "");
+    main = main.substring(main.indexOf(outDir) + outDir.length);
+    if (main.startsWith("/")) {
+      main = main.substring(1);
+    }
+  } else {
+    main = `main/index.${((_b = options == null ? void 0 : options.main) == null ? void 0 : _b.format) === "esm" ? "" : "m"}js`;
+  }
+  const newPkg = {
+    name: pkg.name,
+    version: pkg.version,
+    description: pkg.description,
+    type: pkg.type || "commonjs",
+    author: getAuthor(pkg.author),
+    main,
+    dependencies: getDeps()
+  };
+  writeJson(path.join(outDir, "package.json"), newPkg);
+  function getAuthor(author) {
+    const uname = os.userInfo().username;
+    if (!author) {
+      return uname;
+    } else if (typeof author === "string") {
+      return author;
+    } else if (typeof author === "object") {
+      if (!author.name) {
+        return uname;
+      }
+      const email = author.email ? ` <${author.email}>` : "";
+      return `${author.name}${email}`;
+    }
+    return uname;
+  }
+  function checkDepName(rules, name) {
+    return !!rules.find((s) => {
+      if (typeof s === "string") {
+        return s.includes(name);
+      } else {
+        return s.test(name);
+      }
+    });
+  }
+  function getDeps() {
+    const deps = pkg.dependencies || {};
+    const newDeps = {};
+    Object.keys(deps).forEach((name) => {
+      if (checkDepName(externals, name)) {
+        newDeps[name] = deps[name];
+      }
+    });
+    return newDeps;
+  }
+  return newPkg;
+}
+async function runElectronBuilder(options, resolvedConfig) {
+  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`);
+  logger.info(`run electron-builder to package app`);
+  const config = getBuilderConfig(options, resolvedConfig);
+  const { build } = await import("electron-builder");
+  await build({
+    config
+  });
+}
+
+// src/main.ts
+import { spawn } from "child_process";
+import electron from "electron";
+import treeKill from "tree-kill";
+import { build as tsupBuild } from "tsup";
+var logger2 = createLogger();
 function getBuildOptions(options) {
   return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
     options[s].__NAME__ = s;
@@ -108,32 +272,32 @@ startup.exit = async () => {
   });
 };
 async function runServe(options, server) {
-  options.debug && logger.warn(`debug mode`);
+  options.debug && logger2.warn(`debug mode`);
   const buildOptions = getBuildOptions(options);
   const buildCounts = [0, buildOptions.length > 1 ? 0 : 1];
   for (let i = 0; i < buildOptions.length; i++) {
     const tsOpts = buildOptions[i];
     const { __NAME__: name, onSuccess: _onSuccess, watch, ...tsupOptions } = tsOpts;
-    logger.info(`${name} build`);
+    logger2.info(`${name} build`);
     const onSuccess = async () => {
       if (typeof _onSuccess === "function") {
         await _onSuccess();
       }
       if (buildCounts[i] <= 0) {
         buildCounts[i]++;
-        logger.info(`${name} build succeeded`);
+        logger2.info(`${name} build succeeded`);
         if (buildCounts[0] == 1 && buildCounts[1] == 1) {
-          logger.info("electron startup");
+          logger2.info("electron startup");
           await startup(options);
         }
         return;
       }
-      logger.success(`${name} rebuild succeeded!`);
+      logger2.success(`${name} rebuild succeeded!`);
       if (name === "main") {
-        logger.info("electron restart");
+        logger2.info("electron restart");
         await startup(options);
       } else {
-        logger.info("page reload");
+        logger2.info("page reload");
         server.ws.send({
           type: "full-reload"
         });
@@ -149,18 +313,10 @@ async function runBuild(options) {
   }
 }
 
-// src/utils.ts
-import fs from "fs";
-function readJson(path2) {
-  if (fs.existsSync(path2)) {
-    return JSON.parse(fs.readFileSync(path2, "utf8"));
-  }
-}
-
 // src/index.ts
 var isDev = process.env.NODE_ENV === "development";
 function getPkg() {
-  const pkgFile = path.resolve(process.cwd(), "package.json");
+  const pkgFile = path2.resolve(process.cwd(), "package.json");
   if (!fs2.existsSync(pkgFile)) {
     throw new Error("Main file is not specified, and no package.json found");
   }
@@ -185,7 +341,7 @@ function preMergeOptions(options) {
       };
     }
   };
-  const opts = merge(
+  const opts = merge2(
     {
       recommended: true,
       debug: false,
@@ -206,7 +362,7 @@ function preMergeOptions(options) {
     const entry = opt.entry;
     if (entry == void 0) {
       const filePath = `electron/${prop}/index.ts`;
-      if (fs2.existsSync(path.join(process.cwd(), filePath))) {
+      if (fs2.existsSync(path2.join(process.cwd(), filePath))) {
         opt.entry = [filePath];
       }
     } else if (typeof entry === "string") {
@@ -227,9 +383,10 @@ function geNumberBooleanValue(value) {
   const v = Number(value);
   return Number.isNaN(v) ? void 0 : v;
 }
-function vitePluginElectron(options) {
+function useElectronPlugin(options) {
   const opts = preMergeOptions(options);
   let isServer = false;
+  let resolvedConfig;
   return {
     name: PLUGIN_NAME,
     config(config, env) {
@@ -239,12 +396,12 @@ function vitePluginElectron(options) {
       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");
+        opts.main.outDir = path2.join(outDir, "main");
+        opts.preload.outDir = path2.join(outDir, "preload");
+        outDir = path2.join(outDir, "renderer");
       } else {
-        opts.main.outDir ||= path.join("dist-electron", "main");
-        opts.preload.outDir ||= path.join("dist-electron", "preload");
+        opts.main.outDir ||= path2.join("dist-electron", "main");
+        opts.preload.outDir ||= path2.join("dist-electron", "preload");
       }
       if (isDev) {
         opts.main.sourcemap ??= true;
@@ -272,6 +429,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;
+      resolvedConfig = config;
     },
     configureServer(server) {
       if (!server || !server.httpServer) {
@@ -284,32 +442,30 @@ function vitePluginElectron(options) {
         const hostname = family === "IPv6" ? `[${address}]` : address;
         const protocol = server.config.server.https ? "https" : "http";
         process.env.APP_DEV_SERVER_URL = `${protocol}://${hostname}:${port}`;
-        const DEBUG_PATH = path.resolve(
-          cwd(),
-          "node_modules",
-          "@tomjs",
-          "vite-plugin-electron",
-          "debug"
-        );
+        const DEBUG_PATH = path2.resolve(cwd2(), "node_modules", PACKAGE_NAME, "debug");
         if (!fs2.existsSync(DEBUG_PATH)) {
           mkdirSync(DEBUG_PATH, { recursive: true });
         }
         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
+        writeFileSync(path2.join(DEBUG_PATH, ".env"), `NODE_ENV=development
 ${env}`);
         await runServe(opts, server);
       });
     },
     async closeBundle() {
+      var _a;
       if (isServer) {
         return;
       }
       await runBuild(opts);
+      if (opts.recommended && ((_a = opts.builder) == null ? void 0 : _a.enable)) {
+        await runElectronBuilder(opts, resolvedConfig);
+      }
     }
   };
 }
-var src_default = vitePluginElectron;
+var src_default = useElectronPlugin;
 export {
   src_default as default,
-  vitePluginElectron
+  useElectronPlugin
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.3.8",
+  "version": "1.3.9-1",
   "description": "A simple vite plugin for electron, supports esm/cjs, support esm in electron v28+",
   "keywords": [
     "vite",
@@ -40,6 +40,16 @@
     "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",
@@ -58,7 +68,6 @@
     "@types/lodash.clonedeep": "^4.5.9",
     "@types/lodash.merge": "^4.6.9",
     "@types/node": "^18.19.3",
-    "electron": "^28.0.0",
     "eslint": "^8.55.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",
@@ -68,19 +77,16 @@
     "rimraf": "^5.0.5",
     "stylelint": "^15.11.0",
     "tsx": "^4.6.2",
-    "typescript": "~5.2.2",
-    "vite": "^5.0.7"
+    "typescript": "~5.2.2"
   },
   "peerDependencies": {
     "electron": ">=12.0.0",
-    "vite": ">=2"
+    "electron-builder": ">=24.2.0",
+    "vite": ">=2.9.0"
   },
-  "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 ."
+  "peerDependenciesMeta": {
+    "electron-builder": {
+      "optional": true
+    }
   }
-}
+}