@j-o-r/sh 1.1.8 → 1.1.10

package/lib/SH.js

@@ -31,7 +31,7 @@ import SHDispatch from './SHDispatch.js';
 import Test from './Test.js'
 
 /**
-* @typedef {Object.<string, string | string[]>} ArgsObject
+* @typedef {Object.<string, string>} ArgsObject
 * @property {string} [key: string] - Any string key maps to a string value
 * @property {string[]} _ - Array of strings, unnamed parameters
 * @description Parsed parameters result.
@@ -111,8 +111,6 @@ const SH = new Proxy(function(pieces, ...args) {
 /**
 * Create a async/sync context in new execution callstack
 * @param {function} callback - async/sync function
-* @param {ResolveCallback} [resolve] - optional resolve/result callback
-* @param {RejectCallback} [reject] - optional reject/error callback
 * @example
 * const p = within(async () => {
 *		const res = await Promise.all([
@@ -124,24 +122,8 @@ const SH = new Proxy(function(pieces, ...args) {
 *   return 'res';
 * });
 */
-const within = (callback, resolve, reject) => {
-	// optional, custom resolve/reject functions from an outside promise/function
-	const RCB = jsType(resolve) === 'Function';
-	const ECB = jsType(reject) === 'Function';
-	(async () => {
-		try {
-			const res = await Promise.resolve(callback());
-			if (RCB) {
-				resolve(res);
-			}
-		} catch (e) {
-			if (ECB) {
-				reject(e)
-			} else {
-				throw (e);
-			}
-		}
-	})()
+const within = async (callback) => {
+	return await callback();
 }
 
 /**
@@ -162,7 +144,7 @@ const readIn = async () => {
 * Retries a given asynchronous function a specified number of times with optional delays between attempts.
 *
 * @param {number} count - The number of retry attempts.
-* @param {string|expBackoff|Function} a - Either a delay duration as a string, a delay generator object, or the callback function.
+* @param {string|number|expBackoff|Function} a - Either a delay duration as a string, a delay generator object, or the callback function.
 * @param {Function} [b] - The callback function to retry, required if `a` is not a function.
 * @returns {Promise<*>} - The result of the callback function if it succeeds within the retry attempts.
 * @throws {Error} - The last error encountered if all retry attempts fail.
@@ -297,6 +279,7 @@ const parseArgs = (args) => {
 			result._.push(args[i]);
 		}
 	}
+	// @ts-ignore
 	return result;
 };
 

package/lib/Test.js

@@ -1,4 +1,6 @@
+import { nextTick } from 'process';
 import { jsType } from './SH.js'
+import AsyncTracker from '@j-o-r/asynctracker';
 /**
 * Valid jsTypes for test methods
 */
@@ -49,6 +51,8 @@ function getDuration(start) {
 }
 
 class Test {
+	/** @type {AsyncTracker} */
+	#promiseTracker;
 	#catchErrors = false;
 	#currentTest = -1;
 	/** @type {testDefinition[]} */
@@ -70,6 +74,9 @@ class Test {
 		if (quiet) {
 			this.#quite = true;
 		}
+		// Track for unresolved promises
+		this.#promiseTracker = new AsyncTracker();
+		this.#promiseTracker.enable('PROMISE');
 	}
 	/**
 	* Set the timeout when a synced function is called.
@@ -111,7 +118,7 @@ class Test {
 	* @returns {Test}
 	*/
 	add(description, callback) {
-		if (typeof(description) !== 'string') {
+		if (typeof (description) !== 'string') {
 			throw new Error(`'description' should be a string`)
 		}
 		if (!FNC.includes(jsType(callback))) {
@@ -191,12 +198,22 @@ class Test {
 
 		}
 		const errors = this.#errors.length;
-		if (tests !== executed) {
-			if (!this.#quite) console.log('** Not all tests have been executed **');
-		}
 		if (!this.#quite) {
 			console.log('--------------------------------------------------');
 			console.log(`Total: ${tests} tests, executed: ${executed} in ${duration} ms - errors: ${errors}`);
+			if (tests !== executed) {
+				if (!this.#quite) console.log('** Not all tests have been executed **');
+		    return { tests, executed, duration, errors };
+			}
+			// Report on unresolved promises when NOT quite
+			// This must be on a next tick because the current Promise (where this code is in) is not resolved yet
+			nextTick(() => {
+				const count = this.#promiseTracker.report(true);
+				if (count > 0) {
+					console.log('--------------------------------------------------');
+					console.log(`${count} Unresolved Promises detected.`);
+				}
+			});
 		}
 		return { tests, executed, duration, errors };
 	}
@@ -216,7 +233,7 @@ class Test {
 	*/
 	#handleError(err, outside = false) {
 		// A global error is an error catched outside the callstack of the test
-		const ERR = outside? 'GLOBAL_ERROR' : 'ERROR'
+		const ERR = outside ? 'GLOBAL_ERROR' : 'ERROR'
 		if (this.#currentTest > -1) {
 			if (!this.#quite) process.stdout.write(`\n`);
 			// Register this error

package/package.json

@@ -2,7 +2,7 @@
   "name": "@j-o-r/sh",
   "author": "Jorrit Duin <j-o-r@duin.work>",
   "type": "module",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",
@@ -23,6 +23,7 @@
   },
   "license": "Apache License, Version 2.0",
   "dependencies": {
+    "@j-o-r/asynctracker": "^0.0.8",
     "@types/node": "^22.10.10"
   },
   "bugs": {

package/types/SH.d.ts

@@ -1,5 +1,5 @@
 export type ArgsObject = {
-    [x: string]: string | string[];
+    [x: string]: string;
 };
 export type RejectCallback = Function;
 export type ResolveCallback = Function;
@@ -29,7 +29,7 @@ export function sleep(duration: string | number): Promise<any>;
 * Retries a given asynchronous function a specified number of times with optional delays between attempts.
 *
 * @param {number} count - The number of retry attempts.
-* @param {string|expBackoff|Function} a - Either a delay duration as a string, a delay generator object, or the callback function.
+* @param {string|number|expBackoff|Function} a - Either a delay duration as a string, a delay generator object, or the callback function.
 * @param {Function} [b] - The callback function to retry, required if `a` is not a function.
 * @returns {Promise<*>} - The result of the callback function if it succeeds within the retry attempts.
 * @throws {Error} - The last error encountered if all retry attempts fail.
@@ -44,7 +44,7 @@ export function sleep(duration: string | number): Promise<any>;
 * // Retry a command 3 times with irregular intervals using exponential backoff
 * const p = await retry(3, expBackoff(), () => SH`curl -s https://flipwrsi`);
 */
-export function retry(count: number, a: string | typeof expBackoff | Function, b?: Function): Promise<any>;
+export function retry(count: number, a: string | number | typeof expBackoff | Function, b?: Function): Promise<any>;
 /**
 * This function reads the standard input (stdin) from the current process.
 * @example
@@ -54,8 +54,6 @@ export function readIn(): Promise<string>;
 /**
 * Create a async/sync context in new execution callstack
 * @param {function} callback - async/sync function
-* @param {ResolveCallback} [resolve] - optional resolve/result callback
-* @param {RejectCallback} [reject] - optional reject/error callback
 * @example
 * const p = within(async () => {
 *		const res = await Promise.all([
@@ -67,7 +65,7 @@ export function readIn(): Promise<string>;
 *   return 'res';
 * });
 */
-export function within(callback: Function, resolve?: ResolveCallback, reject?: RejectCallback): void;
+export function within(callback: Function): Promise<any>;
 /**
  * Generates an exponential backoff time with a random jitter.
  *
@@ -94,7 +92,7 @@ export function expBackoff(max?: string, rand?: string): Generator<number, void,
 */
 export function parseArgs(args?: string[]): ArgsObject;
 /**
-* @typedef {Object.<string, string | string[]>} ArgsObject
+* @typedef {Object.<string, string>} ArgsObject
 * @property {string} [key: string] - Any string key maps to a string value
 * @property {string[]} _ - Array of strings, unnamed parameters
 * @description Parsed parameters result.