2.0.30

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartshell",
   "private": false,
-  "version": "2.0.27",
+  "version": "2.0.30",
   "description": "shell actions designed as promises",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -24,17 +24,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartshell#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.17",
-    "@gitzone/tstest": "^1.0.54",
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsrun": "^1.2.18",
+    "@gitzone/tstest": "^1.0.60",
     "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^16.4.3",
+    "@types/node": "^16.11.10",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
     "@pushrocks/smartdelay": "^2.0.13",
-    "@pushrocks/smartexit": "^1.0.15",
+    "@pushrocks/smartexit": "^1.0.20",
     "@pushrocks/smartpromise": "^3.1.6",
     "@types/which": "^2.0.1",
     "tree-kill": "^1.2.2",

readme.md

@@ -0,0 +1,39 @@
+# @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)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](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.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

ts/index.ts

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

ts/smartshell.classes.shellenv.ts

@@ -82,7 +82,7 @@ export class ShellEnv {
       sourceString = sourceString + `source ${sourceFilePath} && `;
     }
 
-    // deal with avaiable path
+    // deal with available path
     let pathString = 'PATH=$PATH';
     for (const pathDir of this.pathDirArray) {
       pathString += `:${pathDir}`;

ts/smartshell.classes.smartshell.ts

@@ -21,7 +21,14 @@ export interface IExecResult {
 export interface IExecResultStreaming {
   childProcess: cp.ChildProcess;
   finalPromise: Promise<IExecResult>;
+  /**
+   * sends SIGKILL
+   */
   kill: () => void;
+  /**
+   * sends SIGTERM
+   */
+  terminate: () => void;
 }
 
 // -- SmartShell --
@@ -52,6 +59,7 @@ export class Smartshell {
     const spawnlogInstance = new ShellLog();
     const execChildProcess = cp.spawn(commandToExecute, [], {
       shell: true,
+      cwd: process.cwd(),
       env: process.env,
       detached: false,
     });
@@ -94,8 +102,13 @@ export class Smartshell {
         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);
+          console.log(`running tree kill with SIGKILL on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid, 'SIGKILL');
+        },
+        terminate: () => {
+          // this notation with the - kills the whole process group
+          console.log(`running tree kill with SIGTERM on process ${execChildProcess.pid}`);
+          plugins.treeKill(execChildProcess.pid, 'SIGTERM');
         },
       });
     }

ts/smartshell.plugins.ts

@@ -1,7 +1,7 @@
 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 { smartdelay, smartexit, smartpromise, which };