ee-bin 4.1.4 → 4.1.6-beta.1

package/config/bin_default.js

@@ -22,7 +22,7 @@ module.exports = {
     electron: {
       directory: './',
       cmd: 'electron',
-      args: ['.', '--env=local'],
+      args: ['.', '--env=local', '--debugger=false'],
       loadingPage: '/public/html/loading.html',
       watch: false,
       sync: false,

package/lib/utils.js

@@ -144,11 +144,11 @@ function getPackage () {
   return content;
 }
 
-function readJsonSync (filepath) {
+function readJsonSync (filepath, encoding = 'utf8') {
   if (!fs.existsSync(filepath)) {
     throw new Error(filepath + ' is not found');
   }
-  return JSON.parse(fs.readFileSync(filepath));
+  return JSON.parse(fs.readFileSync(filepath, { encoding }));
 }
 
 function writeJsonSync (filepath, str, options) {
@@ -191,6 +191,20 @@ function getPlatform(delimiter = "_", isDiffArch = false) {
   return os;
 }
 
+// Get cmd parameter by name
+function getArgumentByName(args, name) {
+  if (!args) {
+    args = process.argv;
+  }
+  for (let i = 0; i < args.length; i++) {
+    const item = args[i];
+    const prefixKey = `--${name}=`;
+    if (item.indexOf(prefixKey) !== -1) {
+      return item.substring(prefixKey.length);
+    }
+  }
+}
+
 module.exports = {
   loadConfig,
   getElectronProgram,
@@ -205,5 +219,6 @@ module.exports = {
   rm,
   getPackage,
   readJsonSync,
-  writeJsonSync
+  writeJsonSync,
+  getArgumentByName
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ee-bin",
-  "version": "4.1.4",
+  "version": "4.1.6-beta.1",
   "description": "ee bin",
   "main": "index.js",
   "scripts": {

package/tools/serve.js

@@ -3,13 +3,14 @@
 const debug = require('debug')('ee-bin:serve');
 const path = require('path');
 const fsPro = require('fs-extra');
-const { loadConfig } = require('../lib/utils');
+const { loadConfig, isWindows, getArgumentByName, readJsonSync, writeJsonSync } = require('../lib/utils');
 const is = require('is-type-of');
 const chalk = require('chalk');
 const crossSpawn = require('cross-spawn');
 const { buildSync } = require('esbuild');
 const chokidar = require('chokidar');
 const kill = require('tree-kill');
+const process = require("process");
 
 class ServeProcess {
 
@@ -17,14 +18,57 @@ class ServeProcess {
     process.env.NODE_ENV = 'prod'; // dev / prod
     this.execProcess = {};
     this.electronDir = './electron';
-    this.defaultBundleDir = './public/electron';
+    this.bundleDir = './public/electron';
+    this.pkgPath = './package.json';
+    this._init();
   }
 
   /**
-   * 启动前端、主进程服务
+   * init 
+   */  
+  _init() {
+    // process manager
+    // Monitor SIGINT signal（Ctrl + C）
+    process.on('SIGINT', () => {
+      console.log(chalk.blue('[ee-bin] ') + `Received SIGINT. Closing processes...`);
+      this._closeProcess();
+    });
+
+    // Monitor SIGTERM signal
+    process.on('SIGTERM', () => {
+      console.log(chalk.blue('[ee-bin] ') + `Received SIGTERM. Closing processes...`);
+      this._closeProcess();
+    });
+  }  
+
+  // Close process
+  async _closeProcess() {
+    const currentProcess = [];
+    const keys = Object.keys(this.execProcess);
+    const len = keys.length;
+    for (let i = 0; i < len; i++) {
+      const key = keys[i];
+      const p = this.execProcess[key];
+      currentProcess.push({
+        name: key,
+        pid: p.pid,
+      });
+    }
+
+    // Cleaning work before the end of the process
+    await this.sleep(500);
+    currentProcess.forEach((p) => {
+      kill(p.pid);
+      debug(`Kill ${chalk.blue(p.name)} server, pid: ${p.pid}`);
+    });
+    process.exit(0);
+  }
+
+  /**
+   * Start frontend and main process services
    */
   dev(options = {}) {
-    // 设置一个环境变量
+    // Set an environment variable
     process.env.NODE_ENV = 'dev';
     const { config, serve } = options;
     const binCfg = loadConfig(config);
@@ -44,8 +88,13 @@ class ServeProcess {
     // build electron main code 
     const cmds = this._formatCmds(command);
     if (cmds.indexOf("electron") !== -1) {
-      // watche electron main code
       const electronConfig = binCmdConfig.electron;
+
+      // Debugging source code
+      const debugging = getArgumentByName(electronConfig.args, 'debuger') == 'true'? true : false;
+      this._switchPkgMain(debugging);
+
+      // watche electron main code
       if (electronConfig.watch) {
         let debounceTimer = null;
         const cmd = 'electron';
@@ -53,7 +102,8 @@ class ServeProcess {
           persistent: true
         });
         watcher.on('change', async (f) => {
-          console.log(chalk.blue('[ee-bin] [dev] ') + `File ${f} has been changed`);
+          //console.log(chalk.blue('[ee-bin] [dev] ') + 'File ' + chalk.cyan(`[${f}]`) + 'has been changed');
+          console.log(chalk.blue('[ee-bin] [dev] ') + `File [${chalk.cyan(f)}] has been changed`);
 
           // 防抖
           if (debounceTimer) {
@@ -91,7 +141,7 @@ class ServeProcess {
   }
 
   /**
-   * 启动主进程服务
+   * Start the main process service
    */
   start(options = {}) {
     const { config } = options;
@@ -114,10 +164,11 @@ class ServeProcess {
   }
 
   /**
-   * 构建
+   * build
    */
   build(options = {}) {
-    const { config, cmds, env } = options;
+    const { config, env } = options;
+    let { cmds } = options;
     process.env.NODE_ENV = env;
     const binCfg = loadConfig(config);
     const binCmd = 'build';
@@ -129,9 +180,18 @@ class ServeProcess {
       return
     }
 
-    if (cmds.indexOf("electron") !== -1) {
+    // [todo] If there is 'electron' , then execute 'electron' first and recycle other commands
+    // should it be placed in multiExec() and maintain the execution order
+    const commands = this._formatCmds(cmds);
+    if (commands.indexOf("electron") !== -1) {
       this.bundle(binCmdConfig.electron);
-      return;
+      // Remove electron cmd and execute others 
+      const index = commands.indexOf("electron");
+      commands.splice(index, 1);
+      cmds = commands.join(); 
+
+      // switch pkg.main
+      this._switchPkgMain(false)
     }
 
     const opt = {
@@ -143,7 +203,7 @@ class ServeProcess {
   }
 
   /**
-   * 执行自定义命令
+   * Execute custom commands
    */
   exec(options = {}) {
     const { config, cmds } = options;
@@ -160,19 +220,20 @@ class ServeProcess {
   }
 
   /**
-   * 支持多个命令
+   * Support multiple commands
    */
   multiExec(opt = {}) {
     //console.log('multiExec opt:', opt)
     const { binCmd, binCmdConfig, command } = opt;
-    const cmds = this._formatCmds(command);
+    const commands = this._formatCmds(command);
 
-    for (let i = 0; i < cmds.length; i++) {
-      let cmd = cmds[i];
+    for (let i = 0; i < commands.length; i++) {
+      let cmd = commands[i];
       const cfg = binCmdConfig[cmd];
 
       if (!cfg) {
-        console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.red(`Error: [${binCmd} ${cmd}] config does not exist` ));
+        // Running the build electron code separately may be empty
+        //console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.yellow(`Warning: [${cmd}] config does not exist` ));
         continue;
       }
 
@@ -181,8 +242,8 @@ class ServeProcess {
         continue;
       }
 
-      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + "Run " + chalk.green(`[${binCmd} ${cmd}]` + " command"));
-      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.green('config:'), JSON.stringify(cfg));
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + `Run ${chalk.green(cmd)} command`);
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.magenta('Config:'), JSON.stringify(cfg));
 
       const execDir = path.join(process.cwd(), cfg.directory);
       const execArgs = is.string(cfg.args) ? [cfg.args] : cfg.args;
@@ -195,15 +256,18 @@ class ServeProcess {
         execArgs,
         { stdio: stdio, cwd: execDir, maxBuffer: 1024 * 1024 * 1024 },
       );
-      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + 'The ' + chalk.green(`[${binCmd} ${cmd}]`) + ` command is ${cfg.sync ? 'run completed' : 'running'}`);
+      console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + 'The ' + chalk.green(`${cmd}`) + ` command is ${cfg.sync ? 'run completed' : 'running'}`);
 
       if(!cfg.sync) {
         this.execProcess[cmd].on('exit', () => {
-          if (cmd == 'electron') {
-            console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.green('Press "CTRL+C" to exit'));
+          if (binCmd == 'dev') {
+            console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + `The ${chalk.green(cmd)} process is exiting`);
+            if (isWindows() && cmd == 'electron') {
+              console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + chalk.green('Press "CTRL+C" to exit'));
+            }
             return
           }
-          console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + 'The ' + chalk.green(`[${binCmd} ${cmd}]`) + ' command has been executed and exited');
+          console.log(chalk.blue(`[ee-bin] [${binCmd}] `) + `The ${chalk.green(cmd)} command has been executed and exited`);
         });
       }
     }
@@ -214,7 +278,7 @@ class ServeProcess {
     const { bundleType } = bundleConfig;
     if (bundleType == 'copy') {
       const srcResource = path.join(process.cwd(), this.electronDir);
-      const destResource = path.join(process.cwd(), this.defaultBundleDir);
+      const destResource = path.join(process.cwd(), this.bundleDir);
       fsPro.removeSync(destResource);
       fsPro.copySync(srcResource, destResource);
     } else {
@@ -240,6 +304,32 @@ class ServeProcess {
 
     return cmds;
   }
+
+  // Modify the main attribute in package.json
+  _switchPkgMain(isDebugger = false) {
+    let mainFile = 'main.js';
+    const pkgPath = path.join(process.cwd(), this.pkgPath);
+    const pkg = readJsonSync(pkgPath);
+    const maints = path.join(process.cwd(), this.electronDir, 'main.ts');
+    if (fsPro.existsSync(maints)) {
+      mainFile = 'main.ts'
+    }
+
+    // [todo] Currently only supports JS
+    if (isDebugger && mainFile == 'main.js') {
+      pkg.main = path.join(this.electronDir, mainFile);
+      //console.log("debugger:", pkg.main)
+      writeJsonSync(pkgPath, pkg);
+    } else {
+      // Modify when the path is incorrect to reduce unnecessary operations
+      const bundleMainPath = path.join(this.bundleDir, 'main.js');
+      //console.log("build:", bundleMainPath)
+      if (pkg.main != bundleMainPath) {
+        pkg.main = bundleMainPath;
+        writeJsonSync(pkgPath, pkg);
+      }
+    }
+  }
   
   // env
   isDev() {