3.2.3

changelog.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 2025-02-20 - 3.2.3 - fix(core)
+Refactor Smartshell class for improved code clarity and performance
+
+- Refactored `_exec` method to improve code clarity.
+- Introduced `IExecOptions` interface for better type handling.
+- Replaced promise defer with native promises in command execution methods.
+- Improved logging and error handling in child process execution.
+- Ensured robust process management with signals handling.
+
+## 2024-12-13 - 3.2.2 - fix(core)
+Fix minor code style and formatting issues
+
+
 ## 2024-12-13 - 3.2.1 - fix(dependencies)
 Update @types/node dependency version
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartshell",
   "private": false,
-  "version": "3.2.1",
+  "version": "3.2.3",
   "description": "A library for executing shell commands using promises.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartshell',
-  version: '3.2.1',
+  version: '3.2.3',
   description: 'A library for executing shell commands using promises.'
 }

ts/classes.smartshell.ts

@@ -2,7 +2,6 @@ import * as plugins from './plugins.js';
 import { ShellEnv } from './classes.shellenv.js';
 import type { IShellEnvContructorOptions, TExecutor } from './classes.shellenv.js';
 import { ShellLog } from './classes.shelllog.js';
-
 import * as cp from 'child_process';
 
 // -- interfaces --
@@ -17,7 +16,15 @@ export interface IExecResultStreaming {
   kill: () => Promise<void>;
   terminate: () => Promise<void>;
   keyboardInterrupt: () => Promise<void>;
-  customSignal: (signalArg: plugins.smartexit.TProcessSignal) => Promise<void>;
+  customSignal: (signal: plugins.smartexit.TProcessSignal) => Promise<void>;
+}
+
+interface IExecOptions {
+  commandString: string;
+  silent?: boolean;
+  strict?: boolean;
+  streaming?: boolean;
+  interactive?: boolean;
 }
 
 export class Smartshell {
@@ -29,61 +36,48 @@ export class Smartshell {
   }
 
   /**
-   * executes a given command async
+   * Executes a given command asynchronously.
    */
-  private async _exec(options: {
+  private async _exec(options: IExecOptions): Promise<IExecResult | IExecResultStreaming | void> {
-    commandString: string;
-    silent?: boolean;
-    strict?: boolean;
-    streaming?: boolean;
-    interactive?: boolean;
-  }): Promise<IExecResult | IExecResultStreaming | void> {
     if (options.interactive) {
-      return await this._execInteractive(options);
+      return await this._execInteractive({ commandString: options.commandString });
     }
-
     return await this._execCommand(options);
   }
 
-  private async _execInteractive(options: {
+  /**
-    commandString: string;
+   * Executes an interactive command.
-    interactive?: boolean;
+   */
-  }): Promise<void> {
+  private async _execInteractive(options: Pick<IExecOptions, 'commandString'>): Promise<void> {
+    // Skip interactive execution in CI environments.
     if (process.env.CI) {
       return;
     }
 
-    const done = plugins.smartpromise.defer();
+    return new Promise<void>((resolve) => {
+      const shell = cp.spawn(options.commandString, {
+        stdio: 'inherit',
+        shell: true,
+        detached: true,
+      });
 
-    const shell = cp.spawn(options.commandString, {
+      this.smartexit.addProcess(shell);
-      stdio: 'inherit',
+
-      shell: true,
+      shell.on('close', (code) => {
-      detached: true
+        console.log(`Interactive shell terminated with code ${code}`);
+        this.smartexit.removeProcess(shell);
+        resolve();
+      });
     });
-
-    this.smartexit.addProcess(shell);
-
-    shell.on('close', (code) => {
-      console.log(`interactive shell terminated with code ${code}`);
-      this.smartexit.removeProcess(shell);
-      done.resolve();
-    });
-
-    await done.promise;
   }
 
-  private async _execCommand(options: {
+  /**
-    commandString: string;
+   * Executes a command and returns either a non-streaming result or a streaming interface.
-    silent?: boolean;
+   */
-    strict?: boolean;
+  private async _execCommand(options: IExecOptions): Promise<IExecResult | IExecResultStreaming> {
-    streaming?: boolean;
-  }): Promise<IExecResult | IExecResultStreaming> {
-    const done = plugins.smartpromise.defer<IExecResult | IExecResultStreaming>();
-    const childProcessEnded = plugins.smartpromise.defer<IExecResult>();
-
     const commandToExecute = this.shellEnv.createEnvExecString(options.commandString);
-
     const shellLogInstance = new ShellLog();
+
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
       cwd: process.cwd(),
@@ -93,6 +87,7 @@ export class Smartshell {
 
     this.smartexit.addProcess(execChildProcess);
 
+    // Capture stdout and stderr output.
     execChildProcess.stdout.on('data', (data) => {
       if (!options.silent) {
         shellLogInstance.writeToConsole(data);
@@ -107,47 +102,55 @@ export class Smartshell {
       shellLogInstance.addToBuffer(data);
     });
 
-    execChildProcess.on('exit', (code, signal) => {
+    // Wrap child process termination into a Promise.
-      this.smartexit.removeProcess(execChildProcess);
+    const childProcessEnded: Promise<IExecResult> = new Promise((resolve, reject) => {
-      if (options.strict && code === 1) {
+      execChildProcess.on('exit', (code, signal) => {
-        done.reject();
+        this.smartexit.removeProcess(execChildProcess);
-      }
 
-      const execResult = {
+        const execResult: IExecResult = {
-        exitCode: code,
+          exitCode: typeof code === 'number' ? code : (signal ? 1 : 0),
-        stdout: shellLogInstance.logStore.toString(),
+          stdout: shellLogInstance.logStore.toString(),
-      };
+        };
 
-      if (!options.streaming) {
+        if (options.strict && code !== 0) {
-        done.resolve(execResult);
+          reject(new Error(`Command "${options.commandString}" exited with code ${code}`));
-      }
+        } else {
-      childProcessEnded.resolve(execResult);
+          resolve(execResult);
+        }
+      });
+
+      execChildProcess.on('error', (error) => {
+        this.smartexit.removeProcess(execChildProcess);
+        reject(error);
+      });
     });
 
+    // If streaming mode is enabled, return a streaming interface immediately.
     if (options.streaming) {
-      done.resolve({
+      return {
         childProcess: execChildProcess,
-        finalPromise: childProcessEnded.promise,
+        finalPromise: childProcessEnded,
         kill: async () => {
-          console.log(`running tree kill with SIGKILL on process ${execChildProcess.pid}`);
+          console.log(`Running tree kill with SIGKILL on process ${execChildProcess.pid}`);
           await plugins.smartexit.SmartExit.killTreeByPid(execChildProcess.pid, 'SIGKILL');
         },
         terminate: async () => {
-          console.log(`running tree kill with SIGTERM on process ${execChildProcess.pid}`);
+          console.log(`Running tree kill with SIGTERM on process ${execChildProcess.pid}`);
           await plugins.smartexit.SmartExit.killTreeByPid(execChildProcess.pid, 'SIGTERM');
         },
         keyboardInterrupt: async () => {
-          console.log(`running tree kill with SIGINT on process ${execChildProcess.pid}`);
+          console.log(`Running tree kill with SIGINT on process ${execChildProcess.pid}`);
           await plugins.smartexit.SmartExit.killTreeByPid(execChildProcess.pid, 'SIGINT');
         },
-        customSignal: async (signalArg: plugins.smartexit.TProcessSignal) => {
+        customSignal: async (signal: plugins.smartexit.TProcessSignal) => {
-          console.log(`running tree kill with custom signal ${signalArg} on process ${execChildProcess.pid}`);
+          console.log(`Running tree kill with custom signal ${signal} on process ${execChildProcess.pid}`);
-          await plugins.smartexit.SmartExit.killTreeByPid(execChildProcess.pid, signalArg);
+          await plugins.smartexit.SmartExit.killTreeByPid(execChildProcess.pid, signal);
         },
-      });
+      } as IExecResultStreaming;
     }
 
-    return await done.promise;
+    // For non-streaming mode, wait for the process to complete.
+    return await childProcessEnded;
   }
 
   public async exec(commandString: string): Promise<IExecResult> {
@@ -166,41 +169,35 @@ export class Smartshell {
     return (await this._exec({ commandString, silent: true, strict: true })) as IExecResult;
   }
 
-  public async execStreaming(
+  public async execStreaming(commandString: string, silent: boolean = false): Promise<IExecResultStreaming> {
-    commandString: string,
-    silent: boolean = false
-  ): Promise<IExecResultStreaming> {
     return (await this._exec({ commandString, silent, streaming: true })) as IExecResultStreaming;
   }
 
   public async execStreamingSilent(commandString: string): Promise<IExecResultStreaming> {
-    return (await this._exec({
+    return (await this._exec({ commandString, silent: true, streaming: true })) as IExecResultStreaming;
-      commandString,
-      silent: true,
-      streaming: true,
-    })) as IExecResultStreaming;
   }
 
-  public async execInteractive(commandString: string) {
+  public async execInteractive(commandString: string): Promise<void> {
     await this._exec({ commandString, interactive: true });
   }
 
   public async execAndWaitForLine(
     commandString: string,
-    regexArg: RegExp,
+    regex: RegExp,
-    silentArg: boolean = false
+    silent: boolean = false
-  ) {
+  ): Promise<void> {
-    let done = plugins.smartpromise.defer();
+    const execStreamingResult = await this.execStreaming(commandString, silent);
-    let execStreamingResult = await this.execStreaming(commandString, silentArg);
+    return new Promise<void>((resolve) => {
-    execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
+      execStreamingResult.childProcess.stdout.on('data', (chunk: Buffer | string) => {
-      if (regexArg.test(stdOutChunk)) {
+        const data = typeof chunk === 'string' ? chunk : chunk.toString();
-        done.resolve();
+        if (regex.test(data)) {
-      }
+          resolve();
+        }
+      });
     });
-    return done.promise;
   }
 
-  public async execAndWaitForLineSilent(commandString: string, regexArg: RegExp) {
+  public async execAndWaitForLineSilent(commandString: string, regex: RegExp): Promise<void> {
-    return this.execAndWaitForLine(commandString, regexArg, true);
+    return this.execAndWaitForLine(commandString, regex, true);
   }
 }