@j-o-r/sh 1.1.9 → 1.1.11

package/lib/SH.js

@@ -98,10 +98,22 @@ const SH = new Proxy(function(pieces, ...args) {
 	while (i < args.length) {
 		let s;
 		if (Array.isArray(args[i])) {
-			s = args[i].map((x) => x).join(' ');
-		}
-		else {
-			s = args[i];
+			s = args[i].map((x) => {
+				let str = String(x);
+				// If the string contains special characters, wrap in single quotes
+				if (str.match(/[ "'$`(){}[\]]/)) {
+					// Escape single quotes within the string
+					return `'${str.replace(/'/g, `'\\''`)}'`;
+				}
+				return str;
+			}).join(' ');
+		} else {
+			let str = String(args[i]);
+			if (str.match(/[ "'$`(){}[\]]/)) {
+				s = `'${str.replace(/'/g, `'\\''`)}'`;
+			} else {
+				s = str;
+			}
 		}
 		cmd += s + pieces[++i];
 	}
@@ -144,7 +156,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.

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.9",
+  "version": "1.1.11",
   "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": {
@@ -50,4 +51,4 @@
     "process-promise",
     "process-output"
   ]
-}
+}

package/types/SH.d.ts

@@ -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