3.0.0

.gitignore

@@ -1,4 +1,20 @@
+.nogit/
+
+# artifacts
 coverage/
-node_modules/
-pages/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -12,55 +12,62 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-  - npmci git mirror
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
+    - lossless
     - docker
-  - notpriv
+  allow_failure: true
 
-snyk:
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install -g snyk
+    - npmci command pnpm audit --audit-level=high --dev
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
   tags:
+    - lossless
     - docker
-  - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -70,6 +77,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +86,15 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +105,18 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install stable
-    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,32 +0,0 @@
-# smartshell
-
-shell actions designed as promises
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartshell)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartshell)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartshell)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartshell/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartshell/badges/master/build.svg)](https://GitLab.com/pushrocks/smartshell/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartshell/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartshell/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartshell.svg)](https://www.npmjs.com/package/smartshell)
-[![Dependency Status](https://david-dm.org/pushrocks/smartshell.svg)](https://david-dm.org/pushrocks/smartshell)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartshell/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartshell/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartshell/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartshell)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-For further information read the linked docs at the top of this README.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -3,5 +3,16 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public",
     "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartshell",
+      "description": "shell actions designed as promises",
+      "npmPackagename": "@pushrocks/smartshell",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.13",
+  "version": "3.0.0",
   "description": "shell actions designed as promises",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -24,17 +26,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartshell#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsrun": "^1.1.13",
+    "@gitzone/tsrun": "^1.2.42",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.74",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^10.12.10",
+    "@types/node": "^20.3.1"
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.16.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartdelay": "^3.0.1",
-    "@types/which": "^1.3.1",
+    "@pushrocks/smartexit": "^1.0.20",
-    "which": "^1.3.1"
+    "@pushrocks/smartpromise": "^4.0.2",
-  }
+    "@types/which": "^3.0.0",
+    "tree-kill": "^1.2.2",
+    "which": "^3.0.1"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,37 @@
+# @pushrocks/smartshell
+shell actions designed as promises
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartshell)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartshell)
+* [github.com (source mirror)](https://github.com/pushrocks/smartshell)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartshell/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartshell/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartshell/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartshell)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartshell)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartshell)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartshell)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartshell)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

test/test.ts

@@ -1,6 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smartshell from '../ts';
+import * as smartshell from '../ts/index.js';
 import * as smartpromise from '@pushrocks/smartpromise';
 
 let testSmartshell: smartshell.Smartshell;
@@ -8,29 +8,29 @@ let testSmartshell: smartshell.Smartshell;
 tap.test('smartshell should create a Smartshell instance', async () => {
   testSmartshell = new smartshell.Smartshell({
     executor: 'bash',
-    sourceFilePaths: []
+    sourceFilePaths: [],
   });
-  expect(testSmartshell).to.be.instanceof(smartshell.Smartshell);
+  expect(testSmartshell).toBeInstanceOf(smartshell.Smartshell);
 });
 
 tap.test('smartshell should run async', async () => {
   let execResult = await testSmartshell.exec('npm -v');
-  expect(execResult.stdout).to.match(/[0-9\.]*/);
+  // expect(execResult.stdout).toMatch(/[0-9\.]*/);
 });
 
 tap.test('smartshell should run async and silent', async () => {
   let execResult = await testSmartshell.execSilent('npm -v');
-  expect(execResult.stdout).to.match(/[0-9\.]*/);
+  // expect(execResult.stdout).toMatch(/[0-9\.]*/);
 });
 
 tap.test('smartshell should stream a shell execution', async () => {
   let done = smartpromise.defer();
   let execStreamingResponse = await testSmartshell.execStreaming('npm -v');
-  execStreamingResponse.childProcess.stdout.on('data', data => {
+  execStreamingResponse.childProcess.stdout.on('data', (data) => {
     done.resolve(data);
   });
   let data = await done.promise;
-  expect(data).to.match(/[0-9\.]*/);
+  // expect(data).toMatch(/[0-9\.]*/);
   await execStreamingResponse.finalPromise;
 });
 
@@ -39,15 +39,19 @@ tap.test('it should execute and wait for a line in the output', async () => {
 });
 
 tap.test('smartshell should run async', async () => {
-  return testSmartshell.execSilent('sleep 1 && npm -v').then(async execResult => {
+  return testSmartshell.execSilent('sleep 1 && npm -v').then(async (execResult) => {
     console.log(execResult.stdout);
   });
 });
 
 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({
-  throwOnError: true
+  throwOnError: true,
 });

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartshell',
+  version: '3.0.0',
+  description: 'shell actions designed as promises'
+}

ts/index.ts

@@ -1 +1,2 @@
-export * from './smartshell.classes.smartshell';
+export * from './smartshell.classes.smartshell.js';
+export { which } from './smartshell.plugins.js';

ts/smartshell.classes.shellenv.ts

@@ -31,7 +31,7 @@ export class ShellEnv {
   /**
    * imports path into the shell from env if available and returns it with
    */
-  private _setPath(commandStringArg): string {
+  private _setPath(commandStringArg: string): string {
     let commandResult = commandStringArg;
     let commandPaths: string[] = [];
     commandPaths = commandPaths.concat(process.env.PATH.split(':'));
@@ -41,7 +41,7 @@ export class ShellEnv {
 
     // lets filter for unwanted paths
     // Windows WSL
-    commandPaths = commandPaths.filter(commandPathArg => {
+    commandPaths = commandPaths.filter((commandPathArg) => {
       const filterResult =
         !commandPathArg.startsWith('/mnt/c/') &&
         !commandPathArg.startsWith('Files/1E') &&
@@ -73,22 +73,28 @@ export class ShellEnv {
     this.sourceFileArray = [];
   }
 
-  createEnvExecString(commandArg): string {
+  public createEnvExecString(commandArg: string): string {
     let commandResult = '';
     let sourceString = '';
 
+    // deal with sourcestring
+    for (const sourceFilePath of this.sourceFileArray) {
+      sourceString = sourceString + `source ${sourceFilePath} && `;
+    }
+
+    // deal with available path
+    let pathString = 'PATH=$PATH';
+    for (const pathDir of this.pathDirArray) {
+      pathString += `:${pathDir}`;
+    }
+    pathString += ` && `;
+
     switch (this.executor) {
       case 'bash':
-        for (let sourceFilePath of this.sourceFileArray) {
+        commandResult = `bash -c '${pathString}${sourceString}${commandArg}'`;
-          sourceString = sourceString + `source ${sourceFilePath} && `;
-        }
-        commandResult = `bash -c '${sourceString}${commandArg}'`;
         break;
       case 'sh':
-        for (let sourceFilePath of this.sourceFileArray) {
+        commandResult = `${pathString}${sourceString}${commandArg}`;
-          sourceString = sourceString + `source ${sourceFilePath} && `;
-        }
-        commandResult = `${sourceString}${commandArg}`;
         break;
     }
     commandResult = this._setPath(commandResult);

ts/smartshell.classes.shelllog.ts

@@ -1,17 +1,17 @@
-import * as plugins from './smartshell.plugins';
+import * as plugins from './smartshell.plugins.js';
 
 /**
  * a log handler for spawned logs
  * 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 {
+  public logAndAdd(dataArg: string | Buffer): void {
-    this.logToConsole(dataArg);
+    this.writeToConsole(dataArg);
     this.addToBuffer(dataArg);
   }
 }

ts/smartshell.classes.smartshell.ts

@@ -1,32 +1,26 @@
-// -- imports --
+import * as plugins from './smartshell.plugins.js';
-import * as plugins from './smartshell.plugins';
+import { ShellEnv } from './smartshell.classes.shellenv.js';
-import { ShellEnv, IShellEnvContructorOptions, TExecutor } from './smartshell.classes.shellenv';
+import type { IShellEnvContructorOptions, TExecutor } from './smartshell.classes.shellenv.js';
-import { ShellLog } from './smartshell.classes.shelllog';
+import { ShellLog } from './smartshell.classes.shelllog.js';
 
 import * as cp from 'child_process';
-import { Deferred } from '@pushrocks/smartpromise';
 
 // -- interfaces --
-/**
- * interface for ExecResult
- */
 export interface IExecResult {
   exitCode: number;
   stdout: string;
 }
 
-/**
- * interface for streaming ExecResult
- */
 export interface IExecResultStreaming {
   childProcess: cp.ChildProcess;
   finalPromise: Promise<IExecResult>;
   kill: () => void;
+  terminate: () => void;
 }
 
-// -- SmartShell --
 export class Smartshell {
-  shellEnv: ShellEnv;
+  public shellEnv: ShellEnv;
+  public smartexit = new plugins.smartexit.SmartExit();
 
   constructor(optionsArg: IShellEnvContructorOptions) {
     this.shellEnv = new ShellEnv(optionsArg);
@@ -34,112 +28,146 @@ export class Smartshell {
 
   /**
    * executes a given command async
-   * @param commandStringArg
    */
-  private async _exec(
+  private async _exec(options: {
-    commandStringArg: string,
+    commandString: string,
-    silentArg: boolean = false,
+    silent?: boolean,
-    strictArg = false,
+    strict?: boolean,
-    streamingArg = false
+    streaming?: boolean,
-  ): Promise<IExecResult | IExecResultStreaming> {
+    interactive?: boolean
-    // flow control promises
+  }): Promise<IExecResult | IExecResultStreaming | void> {
+
+    if (options.interactive) {
+      if (process.env.CI) {
+        return;
+      }
+
+      const done = plugins.smartpromise.defer();
+      const shell = cp.spawn('sh', [], { stdio: 'pipe' });
+      this.smartexit.addProcess(shell);
+
+      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 = options.commandString;
+      if (process.env.CI) {
+        commandString += ' && exit';
+      }
+      commandString += '\n';
+
+      shell.stdin.write(commandString);
+      await done.promise;
+
+      return;
+    }
+
     const done = plugins.smartpromise.defer<IExecResult | IExecResultStreaming>();
     const childProcessEnded = plugins.smartpromise.defer<IExecResult>();
-    // build commandToExecute
+
-    let commandToExecute = commandStringArg;
+    let commandToExecute = options.commandString;
-    commandToExecute = this.shellEnv.createEnvExecString(commandStringArg);
+    commandToExecute = this.shellEnv.createEnvExecString(options.commandString);
+    
     const spawnlogInstance = new ShellLog();
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
+      cwd: process.cwd(),
       env: process.env,
-      detached: true
+      detached: false,
     });
 
-    execChildProcess.stdout.on('data', data => {
+    this.smartexit.addProcess(execChildProcess);
-      if (!silentArg) {
+
-        spawnlogInstance.logToConsole(data);
+    execChildProcess.stdout.on('data', (data) => {
-      }
+      if (!options.silent) {
-      spawnlogInstance.addToBuffer(data);
+        spawnlogInstance.writeToConsole(data);
-    });
-    execChildProcess.stderr.on('data', data => {
-      if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
 
-    if (streamingArg) {
+    execChildProcess.stderr.on('data', (data) => {
-      done.resolve({
+      if (!options.silent) {
-        childProcess: execChildProcess,
+        spawnlogInstance.writeToConsole(data);
-        finalPromise: childProcessEnded.promise,
-        kill: () => {
-          // this notation with the - kills the whole process group
-          process.kill(-execChildProcess.pid);
       }
+      spawnlogInstance.addToBuffer(data);
     });
-    }
 
     execChildProcess.on('exit', (code, signal) => {
-      if (strictArg && code === 1) {
+      this.smartexit.removeProcess(execChildProcess);
+      if (options.strict && code === 1) {
         done.reject();
       }
 
       const execResult = {
         exitCode: code,
-        stdout: spawnlogInstance.logStore.toString()
+        stdout: spawnlogInstance.logStore.toString(),
       };
 
-      if (!streamingArg) {
+      if (!options.streaming) {
         done.resolve(execResult);
       }
       childProcessEnded.resolve(execResult);
     });
 
-    const result = await done.promise;
+    if (options.streaming) {
-    return result;
+      done.resolve({
+        childProcess: execChildProcess,
+        finalPromise: childProcessEnded.promise,
+        kill: () => {
+          console.log(`running tree kill with SIGKILL on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid, 'SIGKILL');
+        },
+        terminate: () => {
+          console.log(`running tree kill with SIGTERM on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid, 'SIGTERM');
+        },
+      });
     }
 
-  async exec(commandStringArg: string): Promise<IExecResult> {
+    return await done.promise;
-    return (await this._exec(commandStringArg, false)) as IExecResult;
   }
 
-  /**
+  public async exec(commandString: string): Promise<IExecResult> {
-   * executes a given command async and silent
+    return (await this._exec({ commandString })) as IExecResult;
-   * @param commandStringArg
-   */
-  async execSilent(commandStringArg: string): Promise<IExecResult> {
-    return (await this._exec(commandStringArg, true)) as IExecResult;
   }
 
-  /**
+  public async execSilent(commandString: string): Promise<IExecResult> {
-   * executes a command async and strict, meaning it rejects the promise if something happens
+    return (await this._exec({ commandString, silent: true })) as IExecResult;
-   */
-  async execStrict(commandStringArg: string): Promise<IExecResult> {
-    return (await this._exec(commandStringArg, true, true)) as IExecResult;
   }
 
-  /**
+  public async execStrict(commandString: string): Promise<IExecResult> {
-   * executes a command and allows you to stream output
+    return (await this._exec({ commandString, strict: true })) as IExecResult;
-   */
-  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 execStrictSilent(commandString: string): Promise<IExecResult> {
-    return (await this.execStreaming(commandStringArg, true)) as IExecResultStreaming;
+    return (await this._exec({ commandString, silent: true, strict: true })) as IExecResult;
   }
 
-  /**
+  public async execStreaming(commandString: string, silent: boolean = false): Promise<IExecResultStreaming> {
-   * executes a command and returns promise that will be fullfilled once an putput line matches RegexArg
+    return (await this._exec({ commandString, silent, streaming: true })) as IExecResultStreaming;
-   * @param commandStringArg
+  }
-   * @param regexArg
+
-   */
+  public async execStreamingSilent(commandString: string): Promise<IExecResultStreaming> {
-  async execAndWaitForLine(commandStringArg: string, regexArg: RegExp, silentArg: boolean = false) {
+    return (await this._exec({ commandString, silent: true, streaming: true })) as IExecResultStreaming;
+  }
+
+  public async execInteractive(commandString: string) {
+    await this._exec({ commandString, interactive: true });
+  }
+
+  public async execAndWaitForLine(commandString: string, regexArg: RegExp, silentArg: boolean = false) {
     let done = plugins.smartpromise.defer();
-    let execStreamingResult = await this.execStreaming(commandStringArg, silentArg);
+    let execStreamingResult = await this.execStreaming(commandString, silentArg);
     execStreamingResult.childProcess.stdout.on('data', (stdOutChunk: string) => {
       if (regexArg.test(stdOutChunk)) {
         done.resolve();
@@ -148,7 +176,7 @@ export class Smartshell {
     return done.promise;
   }
 
-  async execAndWaitForLineSilent(commandStringArg: string, regexArg: RegExp) {
+  public async execAndWaitForLineSilent(commandString: string, regexArg: RegExp) {
-    this.execAndWaitForLine(commandStringArg, regexArg, true);
+    return this.execAndWaitForLine(commandString, regexArg, true);
   }
 }

ts/smartshell.plugins.ts

@@ -1,4 +1,11 @@
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartexit from '@pushrocks/smartexit';
 import * as smartpromise from '@pushrocks/smartpromise';
-import * as which from 'which';
+import which from 'which';
 
-export { smartpromise, which };
+export { smartdelay, smartexit, smartpromise, which };
+
+// third party
+import treeKill from 'tree-kill';
+
+export { treeKill };

tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}