@tomjs/vite-plugin-electron 1.3.9-0 → 1.4.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
 ```

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
 ```

package/dist/index.js

@@ -10,7 +10,54 @@ var _os = require('os'); var _os2 = _interopRequireDefault(_os);
 
 
 
-var _shelljs = require('shelljs'); var _shelljs2 = _interopRequireDefault(_shelljs);
+
+// 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;
+    this.withTime = true;
+    this.tag = `[${tag}]`;
+    this.withTime = _nullishCoalesce(withTime, () => ( true));
+  }
+  getTime() {
+    return `${this.withTime ? _dayjs2.default.call(void 0, ).format("HH:mm:ss") : ""} `;
+  }
+  /**
+   * 调试
+   */
+  debug(msg, ...rest) {
+    console.log(`${this.getTime()}${_kolorist.gray.call(void 0, this.tag)}`, msg, ...rest);
+  }
+  /**
+   *  调试日志 等同 debug
+   */
+  log(msg, ...rest) {
+    this.debug(msg, ...rest);
+  }
+  info(msg, ...rest) {
+    console.log(`${this.getTime()}${_kolorist.blue.call(void 0, this.tag)}`, msg, ...rest);
+  }
+  warn(msg, ...rest) {
+    console.log(`${this.getTime()}${_kolorist.yellow.call(void 0, this.tag)}`, msg, ...rest);
+  }
+  error(msg, ...rest) {
+    console.log(`${this.getTime()}${_kolorist.red.call(void 0, this.tag)}`, msg, ...rest);
+  }
+  success(msg, ...rest) {
+    console.log(`${this.getTime()}${_kolorist.green.call(void 0, this.tag)}`, msg, ...rest);
+  }
+};
+var createLogger = (tag) => {
+  return new Logger(tag || PLUGIN_NAME, true);
+};
 
 // src/utils.ts
 var _child_process = require('child_process');
@@ -29,6 +76,7 @@ function exec(command, args, options) {
 }
 
 // src/builder.ts
+var logger = createLogger();
 function getMirror() {
   let mirror = process.env.ELECTRON_MIRROR;
   if (mirror) {
@@ -100,13 +148,23 @@ function createPkg(options, resolvedConfig) {
     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: pkg.main ? pkg.main.replace("./", "").substring(pkg.main.indexOf(outDir) + outDir.length - 1) : `main/index.${((_b = options == null ? void 0 : options.main) == null ? void 0 : _b.format) === "esm" ? "" : "m"}js`,
+    main,
     dependencies: getDeps()
   };
   writeJson(_path2.default.join(outDir, "package.json"), newPkg);
@@ -147,8 +205,11 @@ function createPkg(options, resolvedConfig) {
   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));
-  _shelljs2.default.exec(`cd ${DIST_PATH} && npm install`);
+  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({
@@ -156,60 +217,12 @@ async function runElectronBuilder(options, resolvedConfig) {
   });
 }
 
-// src/constants.ts
-var PLUGIN_NAME = "@tomjs:electron";
-var PACKAGE_NAME = "@tomjs/vite-plugin-electron";
-
 // src/main.ts
 
 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');
-var Logger = class {
-  constructor(tag, withTime) {
-    this.tag = PLUGIN_NAME;
-    this.withTime = true;
-    this.tag = `[${tag}]`;
-    this.withTime = _nullishCoalesce(withTime, () => ( true));
-  }
-  getTime() {
-    return `${this.withTime ? _dayjs2.default.call(void 0, ).format("HH:mm:ss") : ""} `;
-  }
-  /**
-   * 调试
-   */
-  debug(msg, ...rest) {
-    console.log(`${this.getTime()}${_kolorist.gray.call(void 0, this.tag)}`, msg, ...rest);
-  }
-  /**
-   *  调试日志 等同 debug
-   */
-  log(msg, ...rest) {
-    this.debug(msg, ...rest);
-  }
-  info(msg, ...rest) {
-    console.log(`${this.getTime()}${_kolorist.blue.call(void 0, this.tag)}`, msg, ...rest);
-  }
-  warn(msg, ...rest) {
-    console.log(`${this.getTime()}${_kolorist.yellow.call(void 0, this.tag)}`, msg, ...rest);
-  }
-  error(msg, ...rest) {
-    console.log(`${this.getTime()}${_kolorist.red.call(void 0, this.tag)}`, msg, ...rest);
-  }
-  success(msg, ...rest) {
-    console.log(`${this.getTime()}${_kolorist.green.call(void 0, this.tag)}`, msg, ...rest);
-  }
-};
-var createLogger = (tag) => {
-  return new Logger(tag || PLUGIN_NAME, true);
-};
-
-// src/main.ts
-var logger = createLogger();
+var logger2 = createLogger();
 function getBuildOptions(options) {
   return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
     options[s].__NAME__ = s;
@@ -260,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"
         });

package/dist/index.mjs

@@ -10,7 +10,54 @@ import os from "os";
 import path from "path";
 import { cwd } from "process";
 import merge from "lodash.merge";
-import shell from "shelljs";
+
+// src/logger.ts
+import dayjs from "dayjs";
+import { blue, gray, green, red, yellow } from "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;
+    this.withTime = true;
+    this.tag = `[${tag}]`;
+    this.withTime = withTime ?? true;
+  }
+  getTime() {
+    return `${this.withTime ? dayjs().format("HH:mm:ss") : ""} `;
+  }
+  /**
+   * 调试
+   */
+  debug(msg, ...rest) {
+    console.log(`${this.getTime()}${gray(this.tag)}`, msg, ...rest);
+  }
+  /**
+   *  调试日志 等同 debug
+   */
+  log(msg, ...rest) {
+    this.debug(msg, ...rest);
+  }
+  info(msg, ...rest) {
+    console.log(`${this.getTime()}${blue(this.tag)}`, msg, ...rest);
+  }
+  warn(msg, ...rest) {
+    console.log(`${this.getTime()}${yellow(this.tag)}`, msg, ...rest);
+  }
+  error(msg, ...rest) {
+    console.log(`${this.getTime()}${red(this.tag)}`, msg, ...rest);
+  }
+  success(msg, ...rest) {
+    console.log(`${this.getTime()}${green(this.tag)}`, msg, ...rest);
+  }
+};
+var createLogger = (tag) => {
+  return new Logger(tag || PLUGIN_NAME, true);
+};
 
 // src/utils.ts
 import { spawnSync } from "child_process";
@@ -28,6 +75,7 @@ function exec(command, args, options) {
 }
 
 // src/builder.ts
+var logger = createLogger();
 function getMirror() {
   let mirror = process.env.ELECTRON_MIRROR;
   if (mirror) {
@@ -99,13 +147,23 @@ function createPkg(options, resolvedConfig) {
     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: pkg.main ? pkg.main.replace("./", "").substring(pkg.main.indexOf(outDir) + outDir.length - 1) : `main/index.${((_b = options == null ? void 0 : options.main) == null ? void 0 : _b.format) === "esm" ? "" : "m"}js`,
+    main,
     dependencies: getDeps()
   };
   writeJson(path.join(outDir, "package.json"), newPkg);
@@ -146,8 +204,11 @@ function createPkg(options, resolvedConfig) {
   return newPkg;
 }
 async function runElectronBuilder(options, resolvedConfig) {
+  logger.info("building electron app...");
   const DIST_PATH = path.join(cwd(), path.dirname(resolvedConfig.build.outDir));
-  shell.exec(`cd ${DIST_PATH} && npm install`);
+  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({
@@ -155,60 +216,12 @@ async function runElectronBuilder(options, resolvedConfig) {
   });
 }
 
-// src/constants.ts
-var PLUGIN_NAME = "@tomjs:electron";
-var PACKAGE_NAME = "@tomjs/vite-plugin-electron";
-
 // src/main.ts
 import { spawn } from "child_process";
 import electron from "electron";
 import treeKill from "tree-kill";
 import { build as tsupBuild } from "tsup";
-
-// 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;
-    this.withTime = true;
-    this.tag = `[${tag}]`;
-    this.withTime = withTime ?? true;
-  }
-  getTime() {
-    return `${this.withTime ? dayjs().format("HH:mm:ss") : ""} `;
-  }
-  /**
-   * 调试
-   */
-  debug(msg, ...rest) {
-    console.log(`${this.getTime()}${gray(this.tag)}`, msg, ...rest);
-  }
-  /**
-   *  调试日志 等同 debug
-   */
-  log(msg, ...rest) {
-    this.debug(msg, ...rest);
-  }
-  info(msg, ...rest) {
-    console.log(`${this.getTime()}${blue(this.tag)}`, msg, ...rest);
-  }
-  warn(msg, ...rest) {
-    console.log(`${this.getTime()}${yellow(this.tag)}`, msg, ...rest);
-  }
-  error(msg, ...rest) {
-    console.log(`${this.getTime()}${red(this.tag)}`, msg, ...rest);
-  }
-  success(msg, ...rest) {
-    console.log(`${this.getTime()}${green(this.tag)}`, msg, ...rest);
-  }
-};
-var createLogger = (tag) => {
-  return new Logger(tag || PLUGIN_NAME, true);
-};
-
-// src/main.ts
-var logger = createLogger();
+var logger2 = createLogger();
 function getBuildOptions(options) {
   return ["main", "preload"].filter((s) => options[s] && options[s].entry).map((s) => {
     options[s].__NAME__ = s;
@@ -259,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"
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomjs/vite-plugin-electron",
-  "version": "1.3.9-0",
+  "version": "1.4.0",
   "description": "A simple vite plugin for electron, supports esm/cjs, support esm in electron v28+",
   "keywords": [
     "vite",
@@ -55,7 +55,6 @@
     "kolorist": "^1.8.0",
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
-    "shelljs": "^0.8.5",
     "tree-kill": "^1.2.2",
     "tsup": "7.2.0"
   },
@@ -69,7 +68,6 @@
     "@types/lodash.clonedeep": "^4.5.9",
     "@types/lodash.merge": "^4.6.9",
     "@types/node": "^18.19.3",
-    "@types/shelljs": "^0.8.15",
     "eslint": "^8.55.0",
     "husky": "^8.0.3",
     "lint-staged": "^15.2.0",