2.0.24

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.19",
+  "version": "2.0.24",
   "description": "shell actions designed as promises",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -24,16 +24,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartshell#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.22",
-    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^12.0.2",
-    "tslint": "^5.16.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.2",
+    "tslint": "^5.19.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartexit": "^1.0.11",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartexit": "^1.0.15",
     "@pushrocks/smartpromise": "^3.0.2",
     "@types/which": "^1.3.1",
     "which": "^1.3.1"

test/test.ts

@@ -45,7 +45,11 @@ tap.test('smartshell should run async', async () => {
 });
 
 tap.test('should be able to find git', async () => {
-  testSmartshell.exec('git --version');
+  await testSmartshell.exec('git --version');
+});
+
+tap.test('should spawn an interactive cli', async () => {
+  await testSmartshell.execInteractive('echo "hi"');
 });
 
 tap.start({

ts/smartshell.classes.shelllog.ts

@@ -5,13 +5,13 @@ import * as plugins from './smartshell.plugins';
  * making sure the process doesn't run out of memory
  */
 export class ShellLog {
-  logStore = Buffer.from('');
+  public logStore = Buffer.from('');
 
   /**
    * log data to console
    * @param dataArg
    */
-  logToConsole(dataArg: string | Buffer): void {
+  public writeToConsole(dataArg: string | Buffer): void {
     // make sure we have the data as string
     process.stdout.write(dataArg);
   }
@@ -20,7 +20,7 @@ export class ShellLog {
    * add data to Buffer for later consumption
    * @param dataArg
    */
-  addToBuffer(dataArg: string | Buffer): void {
+  public addToBuffer(dataArg: string | Buffer): void {
     // make sure we have the data as Buffer
     const dataBuffer: Buffer = (() => {
       if (!Buffer.isBuffer(dataArg)) {
@@ -31,8 +31,8 @@ export class ShellLog {
     this.logStore = Buffer.concat([this.logStore, dataBuffer]);
   }
 
-  logAndAdd(dataArg: string | Buffer): void {
-    this.logToConsole(dataArg);
+  public logAndAdd(dataArg: string | Buffer): void {
+    this.writeToConsole(dataArg);
     this.addToBuffer(dataArg);
   }
 }

ts/smartshell.classes.smartshell.ts

@@ -60,13 +60,13 @@ export class Smartshell {
 
     execChildProcess.stdout.on('data', data => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
     execChildProcess.stderr.on('data', data => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
@@ -103,7 +103,7 @@ export class Smartshell {
     return result;
   }
 
-  async exec(commandStringArg: string): Promise<IExecResult> {
+  public async exec(commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, false)) as IExecResult;
   }
 
@@ -111,28 +111,32 @@ export class Smartshell {
    * executes a given command async and silent
    * @param commandStringArg
    */
-  async execSilent(commandStringArg: string): Promise<IExecResult> {
+  public async execSilent(commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, true)) as IExecResult;
   }
 
   /**
    * executes a command async and strict, meaning it rejects the promise if something happens
    */
-  async execStrict(commandStringArg: string): Promise<IExecResult> {
+  public async execStrict(commandStringArg: string): Promise<IExecResult> {
+    return (await this._exec(commandStringArg, false, true)) as IExecResult;
+  }
+
+  public async execStrictSilent (commandStringArg: string): Promise<IExecResult> {
     return (await this._exec(commandStringArg, true, true)) as IExecResult;
   }
 
   /**
    * executes a command and allows you to stream output
    */
-  async execStreaming(
+  public async execStreaming(
     commandStringArg: string,
     silentArg: boolean = false
   ): Promise<IExecResultStreaming> {
     return (await this._exec(commandStringArg, silentArg, false, true)) as IExecResultStreaming;
   }
 
-  async execStreamingSilent(commandStringArg: string) {
+  public async execStreamingSilent(commandStringArg: string) {
     return (await this.execStreaming(commandStringArg, true)) as IExecResultStreaming;
   }
 
@@ -141,7 +145,11 @@ export class Smartshell {
    * @param commandStringArg
    * @param regexArg
    */
-  async execAndWaitForLine(commandStringArg: string, regexArg: RegExp, silentArg: boolean = false) {
+  public async execAndWaitForLine(
+    commandStringArg: string,
+    regexArg: RegExp,
+    silentArg: boolean = false
+  ) {
     let done = plugins.smartpromise.defer();
     let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
     execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
@@ -152,7 +160,42 @@ export class Smartshell {
     return done.promise;
   }
 
-  async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
+  public async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
     this.execAndWaitForLine(commandStringArg, regexArg, true);
   }
+
+  /**
+   * execs an command and then enters interactive CLI
+   * @param commandStringArg
+   * @param regexArg
+   */
+  public async execInteractive(commandStringArg: string) {
+    if (process.env.CI) {
+      return;
+    }
+    const done = plugins.smartpromise.defer();
+    const shell = cp.spawn('sh', [], { stdio: 'pipe' });
+    this.smartexit.addProcess(shell);
+    const shellLog = new ShellLog();
+    const stdInStream = process.stdin.pipe(shell.stdin);
+    const stdOutStream = shell.stdout.pipe(process.stdout);
+    shell.on('close', code => {
+      console.log(`interactive shell terminated with code ${code}`);
+      stdInStream.removeAllListeners();
+      stdInStream.uncork();
+      stdOutStream.removeAllListeners();
+      stdOutStream.unpipe();
+      shell.kill('SIGTERM');
+      process.stdin.pause();
+      done.resolve();
+    });
+    let commandString = commandStringArg;
+    if (process.env.CI) {
+      commandString += ' && exit';
+    }
+    commandString += '\n';
+
+    shell.stdin.write(commandString);
+    await done.promise;
+  }
 }

ts/smartshell.plugins.ts

@@ -1,5 +1,6 @@
+import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartexit from '@pushrocks/smartexit';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as which from 'which';
 
-export { smartexit, smartpromise, which };
+export { smartdelay, smartexit, smartpromise, which };