2.0.27

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,102 +18,115 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - docker
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +134,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.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,28 +0,0 @@
-# @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
-[![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/@pushrocks/smartshell.svg)](https://www.npmjs.com/package/@pushrocks/smartshell)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartshell/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartshell)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## 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)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -5,6 +5,7 @@
     "npmRegistryUrl": "registry.npmjs.org"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.18",
+  "version": "2.0.27",
   "description": "shell actions designed as promises",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -24,18 +24,35 @@
   },
   "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.25",
+    "@gitzone/tsrun": "^1.2.17",
+    "@gitzone/tstest": "^1.0.54",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.4.3",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartexit": "^1.0.11",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@types/which": "^1.3.1",
-    "which": "^1.3.1"
-  }
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartexit": "^1.0.15",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@types/which": "^2.0.1",
+    "tree-kill": "^1.2.2",
+    "which": "^2.0.2"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

test/test.ts

@@ -8,7 +8,7 @@ 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);
 });
@@ -26,7 +26,7 @@ tap.test('smartshell should run async and silent', async () => {
 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;
@@ -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/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') &&

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

@@ -53,35 +53,24 @@ export class Smartshell {
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
       env: process.env,
-      detached: true
+      detached: false,
     });
 
     this.smartexit.addProcess(execChildProcess);
 
-    execChildProcess.stdout.on('data', data => {
+    execChildProcess.stdout.on('data', (data) => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
-    execChildProcess.stderr.on('data', data => {
+    execChildProcess.stderr.on('data', (data) => {
       if (!silentArg) {
-        spawnlogInstance.logToConsole(data);
+        spawnlogInstance.writeToConsole(data);
       }
       spawnlogInstance.addToBuffer(data);
     });
 
-    if (streamingArg) {
-      done.resolve({
-        childProcess: execChildProcess,
-        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) {
@@ -90,7 +79,7 @@ export class Smartshell {
 
       const execResult = {
         exitCode: code,
-        stdout: spawnlogInstance.logStore.toString()
+        stdout: spawnlogInstance.logStore.toString(),
       };
 
       if (!streamingArg) {
@@ -99,11 +88,23 @@ export class Smartshell {
       childProcessEnded.resolve(execResult);
     });
 
+    if (streamingArg) {
+      done.resolve({
+        childProcess: execChildProcess,
+        finalPromise: childProcessEnded.promise,
+        kill: () => {
+          // this notation with the - kills the whole process group
+          console.log(`running tree kill on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid);
+        },
+      });
+    }
+
     const result = await done.promise;
     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 +112,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 +146,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 +161,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,11 @@
+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 };
+
+// third party
+import treeKill from 'tree-kill';
+
+export { treeKill };