document spawning(), better catch handle all errors, additional tests,

Author: TheTechsTech

README.md

@@ -10,6 +10,8 @@ This is mainly focused on initial installation of an Node JS packages that needs
 
 `node-sys` will try to find which system packaging is installed for the given `process.platform`. If no system package manager is found, `'No package manager found!'` is returned.
 
+A `spawning` cross-platform version of Node's child_process.`spawn` that returns a **Promise**.
+
 ## Install
 
 ```sh
@@ -54,6 +56,23 @@ installer('vim')
 });
 ```
 
+## API - spawning(command, arguments, progress, options)
+
+`spawning` takes an additional argument, `progress`, its [`options`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) are the same as those of `child_process.spawn`.
+
+* `progress`: callback handler for `stdout.on('data')` events.
+
+It returns a promise whose result will be any output or any data return in the progress callback.
+*The progress callback will receive an object with these properties:*
+
+* `handle:` *Object* - Spawned child process instance handler.
+  * Access the child process object.
+
+* `output:` *String* - Output from stdout.
+  * Output can be altered and if returned will replace the otherwise resolved result.
+
+If there's an error running the child process, received data on stderr, or errors in progress callback, `spawning` rejects the returned promise.
+
 ### CLI Usage
 
 ```s

index.js

@@ -164,6 +164,10 @@ export const spawning = Sys.spawning = function (cmd, argument = [], progress =
   return new Promise((resolve, reject) => {
     let output = null;
     const child = spawn(cmd, argument, options);
+    child.on('error', (data) => {
+      return reject(data);
+    });
+
     child.on('close', () => {
       return resolve(output);
     });
@@ -175,13 +179,17 @@ export const spawning = Sys.spawning = function (cmd, argument = [], progress =
     child.stdout.on('data', (data) => {
       let input = data.toString();
       let onProgress = null
-      if (progress) {
-        onProgress = progress({ handle: child, output: input });
+      try {
+        if (progress) {
+          onProgress = progress({ handle: child, output: input });
+        }
+      } catch (e) {
+        return reject(e.toString());
       }
 
-      if (onProgress) {
+      if (onProgress && onProgress != null) {
         output = onProgress;
-      } else {
+      } else if (input != null) {
         output += input;
       }
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-sys",
   "version": "1.0.4",
-  "description": "Universal package installer, get the command for managing packages, or auto install any package, using one command for all platforms. Automate the installation of macOS Brew, and Windows Chocolatey package managers.",
+  "description": "Universal package installer, get the command for managing packages, or auto install any package, using one command for all platforms. Automate the installation of macOS Brew, and Windows Chocolatey package managers. A promisify child process of spawn.",
   "type": "module",
   "main": "index.js",
   "bin": {
@@ -36,15 +36,17 @@
     "emerge",
     "zypper",
     "nix",
-    "cross",
-    "platform",
     "cross-platform",
     "package",
     "manager",
     "installer",
     "macOS",
     "windows",
-    "linux"
+    "linux",
+    "spawn",
+    "spawning",
+    "child_process",
+    "promisify"
   ],
   "author": "l. stubbs <[email protected]>",
   "contributors": [

test/test.js

@@ -1,6 +1,6 @@
 import chai from 'chai';
 import Sys from '../index.js';
-import { packager, installer, where } from '../index.js';
+import { packager, installer, where, spawning } from '../index.js';
 
 const expect = chai.expect;
 
@@ -181,7 +181,7 @@ describe('Method: `installer` install packages `unzip`, platform set to `shell`'
   });
 });
 
-describe('Method: `spawning`', function () {
+describe('Method: `installer` and progress callback, platform set to `win64`', function () {
   // save original process.platform
   before(function () {
     this.originalPlatform = Object.getOwnPropertyDescriptor(process, 'platform');
@@ -215,6 +215,44 @@ describe('Method: `spawning`', function () {
   });
 });
 
+describe('Method: `spawning`', function () {
+  it('should return on successful install with output from `progress`', function (done) {
+    spawning('echo', [''], (object) => {
+      expect(object).to.be.a('object');
+      expect(object.handle).to.be.instanceOf(Object);
+      expect(object.output).to.be.a('string');
+      return 'hello';
+    }, { stdio: 'pipe', shell: true })
+      .then(function (data) {
+        expect(data).to.be.a('string');
+        expect(data).to.equal('hello');
+        done();
+      })
+      .catch(function (err) {
+        expect(err).to.be.empty;
+        done();
+      });
+  });
+
+  it('should catch error on throw from `progress`', function (done) {
+    spawning('echo', [''], () => {
+      throw 'hello';
+    }, { stdio: 'pipe', shell: true })
+      .catch(function (err) {
+        expect(err).to.equal('hello');
+        done();
+      });
+  });
+
+  it('should catch and instant of `Error` on any spawn exceptions', function (done) {
+    spawning('xxxxx', [''], null, { stdio: 'pipe', })
+      .catch(function (err) {
+        expect(err).to.be.instanceof(Error);
+        done();
+      });
+  });
+});
+
 describe('Method: `where`', function () {
   it('should return null/empty for executable not found', function (done) {
     let found = where('fake-js');