2.0.16

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,21 +37,11 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +53,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -118,6 +110,7 @@ pages:
   stage: metadata
   script:
     - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
@@ -130,13 +123,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

npmextra.json

@@ -1,6 +1,7 @@
 {
   "npmci": {
     "npmGlobalTools": [],
-    "npmAccessLevel": "public"
+    "npmAccessLevel": "public",
+    "npmRegistryUrl": "registry.npmjs.org"
   }
 }

package.json

@@ -1,12 +1,12 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.3",
+  "version": "2.0.16",
   "description": "shell actions designed as promises",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
+    "test": "(tstest test/)",
     "build": "(tsbuild)"
   },
   "repository": {
@@ -24,13 +24,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartshell#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.21",
-    "@gitzone/tsrun": "^1.1.9",
-    "@pushrocks/tapbundle": "^3.0.1",
-    "@types/node": "^10.5.2"
+    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tstest": "^1.0.20",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^12.0.2",
+    "tslint": "^5.16.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartexit": "^1.0.8",
+    "@pushrocks/smartpromise": "^3.0.2",
     "@types/which": "^1.3.1",
     "which": "^1.3.1"
   }

ts/smartshell.classes.shellenv.ts

@@ -2,21 +2,58 @@ export type TExecutor = 'sh' | 'bash';
 
 export interface IShellEnvContructorOptions {
   executor: TExecutor;
-  sourceFilePaths: string[];
+  sourceFilePaths?: string[];
+  pathDirectories?: string[];
 }
 
 export class ShellEnv {
   executor: TExecutor;
   sourceFileArray: string[] = [];
+  pathDirArray: string[] = [];
 
   /**
    * constructor for the shellenv
    */
   constructor(optionsArg: IShellEnvContructorOptions) {
     this.executor = optionsArg.executor;
-    for (let sourceFilePath of optionsArg.sourceFilePaths) {
-      this.sourceFileArray.push(sourceFilePath);
+
+    // add sourcefiles
+    if (optionsArg.sourceFilePaths) {
+      this.sourceFileArray = this.sourceFileArray.concat(optionsArg.sourceFilePaths);
     }
+
+    // add pathDirectories
+    if (optionsArg.pathDirectories) {
+      this.pathDirArray = this.pathDirArray.concat(optionsArg.pathDirectories);
+    }
+  }
+
+  /**
+   * imports path into the shell from env if available and returns it with
+   */
+  private _setPath(commandStringArg): string {
+    let commandResult = commandStringArg;
+    let commandPaths: string[] = [];
+    commandPaths = commandPaths.concat(process.env.PATH.split(':'));
+    if (process.env.SMARTSHELL_PATH) {
+      commandPaths = commandPaths.concat(process.env.SMARTSHELL_PATH.split(':'));
+    }
+
+    // lets filter for unwanted paths
+    // Windows WSL
+    commandPaths = commandPaths.filter(commandPathArg => {
+      const filterResult =
+        !commandPathArg.startsWith('/mnt/c/') &&
+        !commandPathArg.startsWith('Files/1E') &&
+        !commandPathArg.includes(' ');
+      if (!filterResult) {
+        // console.log(`${commandPathArg} will be filtered!`);
+      }
+      return filterResult;
+    });
+
+    commandResult = `PATH=${commandPaths.join(':')} && ${commandStringArg}`;
+    return commandResult;
   }
 
   /**
@@ -36,15 +73,31 @@ export class ShellEnv {
     this.sourceFileArray = [];
   }
 
-  createEnvExecString(commandArg): string {
-    if (this.executor === 'bash') {
-      let sourceString = '';
-      for (let sourceFilePath of this.sourceFileArray) {
-        sourceString = sourceString + `source ${sourceFilePath} && `;
-      }
-      return `bash -c '${sourceString} ${commandArg}'`;
-    } else {
-      return commandArg;
+  public createEnvExecString(commandArg: string): string {
+    let commandResult = '';
+    let sourceString = '';
+
+    // deal with sourcestring
+    for (const sourceFilePath of this.sourceFileArray) {
+      sourceString = sourceString + `source ${sourceFilePath} && `;
     }
+
+    // deal with avaiable path
+    let pathString = 'PATH=$PATH';
+    for (const pathDir of this.pathDirArray) {
+      pathString += `:${pathDir}`;
+    }
+    pathString += ` && `;
+
+    switch (this.executor) {
+      case 'bash':
+        commandResult = `bash -c '${pathString}${sourceString}${commandArg}'`;
+        break;
+      case 'sh':
+        commandResult = `${pathString}${sourceString}${commandArg}`;
+        break;
+    }
+    commandResult = this._setPath(commandResult);
+    return commandResult;
   }
 }

ts/smartshell.classes.shelllog.ts

@@ -13,13 +13,7 @@ export class ShellLog {
    */
   logToConsole(dataArg: string | Buffer): void {
     // make sure we have the data as string
-    const dataString: string = (() => {
-      if (Buffer.isBuffer(dataArg)) {
-        return dataArg.toString();
-      }
-      return dataArg;
-    })();
-    console.log(dataString);
+    process.stdout.write(dataArg);
   }
 
   /**

ts/smartshell.classes.smartshell.ts

@@ -21,29 +21,18 @@ export interface IExecResult {
 export interface IExecResultStreaming {
   childProcess: cp.ChildProcess;
   finalPromise: Promise<IExecResult>;
+  kill: () => void;
 }
 
 // -- SmartShell --
 export class Smartshell {
-  shellEnv: ShellEnv;
+  public shellEnv: ShellEnv;
+  public smartexit = new plugins.smartexit.SmartExit();
 
   constructor(optionsArg: IShellEnvContructorOptions) {
     this.shellEnv = new ShellEnv(optionsArg);
   }
 
-  /**
-   * imports path into the shell from env if available and returns it with
-   */
-  private _importEnvVarPath(stringArg): string {
-    if (process.env.SMARTSHELL_PATH) {
-      let commandResult = `PATH=${process.env.SMARTSHELL_PATH} && ${stringArg}`;
-      // console.log(commandResult)
-      return commandResult;
-    } else {
-      return stringArg;
-    }
-  }
-
   /**
    * executes a given command async
    * @param commandStringArg
@@ -60,13 +49,15 @@ export class Smartshell {
     // build commandToExecute
     let commandToExecute = commandStringArg;
     commandToExecute = this.shellEnv.createEnvExecString(commandStringArg);
-    commandToExecute = this._importEnvVarPath(commandToExecute);
     const spawnlogInstance = new ShellLog();
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
-      env: process.env
+      env: process.env,
+      detached: true
     });
 
+    this.smartexit.addProcess(execChildProcess);
+
     execChildProcess.stdout.on('data', data => {
       if (!silentArg) {
         spawnlogInstance.logToConsole(data);
@@ -83,11 +74,16 @@ export class Smartshell {
     if (streamingArg) {
       done.resolve({
         childProcess: execChildProcess,
-        finalPromise: childProcessEnded.promise
+        finalPromise: childProcessEnded.promise,
+        kill: () => {
+          // this notation with the - kills the whole process group
+          process.kill(-execChildProcess.pid);
+        }
       });
     }
 
     execChildProcess.on('exit', (code, signal) => {
+      this.smartexit.removeProcess(execChildProcess);
       if (strictArg && code === 1) {
         done.reject();
       }

ts/smartshell.plugins.ts

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

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }