@j-o-r/sh 1.1.6 → 1.1.7

package/lib/SH.js

@@ -31,12 +31,11 @@ import SHDispatch from './SHDispatch.js';
 import Test from './Test.js'
 
 /**
-* @typedef {Object.<string, string>} ArgsObject
-* @property {string} [key: string] - Any string key maps to an object
+* @typedef {Object.<string, 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.
 */
-
 /**
 * @typedef {Function} RejectCallback
 * @param {Error} error - The error object passed to the callback.
@@ -271,7 +270,7 @@ function* expBackoff(max = '60s', rand = '100ms') {
 *   - The value is either the next argument or `true` if no value is provided,
 *   - The `_` property contains an array of unbound arguments.
 */
-const parseArgs = (args) => {
+const parseArgsOld = (args) => {
 	const result = { _: [] }; // Initialize result with an empty array for unbound values
 	for (let i = 0; i < args.length; i++) {
 		if (args[i].startsWith('--')) {
@@ -285,7 +284,49 @@ const parseArgs = (args) => {
 	}
 	return result;
 }
-
+/**
+* Parses command-line arguments into an object.
+*
+* The function recognizes arguments that start with two dashes (`--`) or one dash (`-`) as keys,
+* and the subsequent value (if not another key) as the corresponding value.
+* If a key does not have a value, it defaults to `true`.
+* All unrecognized arguments are collected in an array under the `_` property.
+*
+* @param {string[]} [args] -  An array of command-line arguments (process.argv.slice(2)).
+* @returns {ArgsObject} An object where:
+*   - If args is not passed, process.argv.slice(2) will be the default
+*   - Each key corresponds to an argument that starts with `--` or `-`,
+*   - The value is either the next argument or `true` if no value is provided,
+*   - The `_` property contains an array of unbound arguments.
+*/
+const parseArgs = (args) => {
+	if (!args) args = process.argv.slice(2);
+	const result = { _: [] };
+	const seenKeys = new Set();
+	for (let i = 0; i < args.length; i++) {
+		if (args[i].startsWith('--') || args[i].startsWith('-')) {
+			if (args[i].startsWith('-') && !args[i].startsWith('--') && args[i].length > 2) {
+				throw new Error(`Invalid argument: ${args[i]}. Use '--' for long options.`);
+			}
+			const key = args[i].startsWith('--') ? args[i].substring(2) : args[i].substring(1);
+			if (seenKeys.has(key)) {
+				throw new Error(`Duplicate argument: ${args[i]}`);
+			}
+			seenKeys.add(key);
+			let value;
+			if (args[i + 1] && !args[i + 1].startsWith('-')) {
+				value = args[i + 1];
+				i++; // Skip next element as it is a value
+			} else {
+				value = true;
+			}
+			result[key] = value;
+		} else {
+			result._.push(args[i]);
+		}
+	}
+	return result;
+};
 
 export {
 	SH,

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.6",
+  "version": "1.1.7",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",

package/types/SH.d.ts

@@ -1,5 +1,5 @@
 export type ArgsObject = {
-    [x: string]: string;
+    [x: string]: string | string[];
 };
 export type RejectCallback = Function;
 export type ResolveCallback = Function;
@@ -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 | undefined): Promise<any>;
+export function retry(count: number, a: string | typeof expBackoff | Function, b?: Function): Promise<any>;
 /**
 * This function reads the standard input (stdin) from the current process.
 * @example
@@ -67,7 +67,7 @@ export function readIn(): Promise<string>;
 *   return 'res';
 * });
 */
-export function within(callback: Function, resolve?: Function | undefined, reject?: Function | undefined): void;
+export function within(callback: Function, resolve?: ResolveCallback, reject?: RejectCallback): void;
 /**
  * Generates an exponential backoff time with a random jitter.
  *
@@ -76,25 +76,26 @@ export function within(callback: Function, resolve?: Function | undefined, rejec
  * @param {string} [rand='100ms'] - The maximum random jitter time in a human-readable format (e.g., '100ms' for 100 milliseconds).
  * @yields {number} The backoff time in milliseconds.
  */
-export function expBackoff(max?: string | undefined, rand?: string | undefined): Generator<number, void, unknown>;
+export function expBackoff(max?: string, rand?: string): Generator<number, void, unknown>;
 /**
 * Parses command-line arguments into an object.
 *
-* The function recognizes arguments that start with two dashes (`--`) as keys,
+* The function recognizes arguments that start with two dashes (`--`) or one dash (`-`) as keys,
 * and the subsequent value (if not another key) as the corresponding value.
 * If a key does not have a value, it defaults to `true`.
 * All unrecognized arguments are collected in an array under the `_` property.
 *
-* @param {string[]} args - An array of command-line arguments.
+* @param {string[]} [args] -  An array of command-line arguments (process.argv.slice(2)).
 * @returns {ArgsObject} An object where:
-*   - Each key corresponds to an argument that starts with `--`,
+*   - If args is not passed, process.argv.slice(2) will be the default
+*   - Each key corresponds to an argument that starts with `--` or `-`,
 *   - The value is either the next argument or `true` if no value is provided,
 *   - The `_` property contains an array of unbound arguments.
 */
-export function parseArgs(args: string[]): ArgsObject;
+export function parseArgs(args?: string[]): ArgsObject;
 /**
-* @typedef {Object.<string, string>} ArgsObject
-* @property {string} [key: string] - Any string key maps to an object
+* @typedef {Object.<string, 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.
 */

package/types/SHDispatch.d.ts

@@ -62,18 +62,18 @@ declare class SHDispatch {
     * @param {string} [prefix] - command prefix e.g (default) '/usr/bin/env'
     * @returns {SHDispatch}
     */
-    options(options: import("child_process").SpawnOptions | import("child_process").SpawnSyncOptions, prefix?: string | undefined): SHDispatch;
+    options(options: import("child_process").SpawnOptions | import("child_process").SpawnSyncOptions, prefix?: string): SHDispatch;
     /**
     * @param {string} [payload]
     * @returns {Promise<string>}
     */
-    run(payload?: string | undefined): Promise<string>;
+    run(payload?: string): Promise<string>;
     /**
     * Works for screen takeovers like editors
     * @param {string} [payload]
     * @returns {import('child_process').SpawnSyncReturns}
     */
-    runSync(payload?: string | undefined): import("child_process").SpawnSyncReturns<any>;
+    runSync(payload?: string): import("child_process").SpawnSyncReturns<any>;
     kill(signal?: string): Promise<number[]>;
     #private;
 }

package/types/SHExecute.d.ts

@@ -10,12 +10,12 @@ declare class SHExecute {
     * @param {string} [payload] - data to write
     * @retuns {Promise<object>}
     */
-    runSync(payload?: string | undefined): import("child_process").SpawnSyncReturns<string | Buffer>;
+    runSync(payload?: string): import("child_process").SpawnSyncReturns<string | Buffer<ArrayBufferLike>>;
     /**
     * @param {string} [payload] - data to write
     * @retuns {Promise<string>}
     */
-    run(payload?: string | undefined): Promise<any>;
+    run(payload?: string): Promise<any>;
     /**
     * Kill this process and possible child processes
     * @param {number | string} signal - kill signal

package/types/Test.d.ts

@@ -37,7 +37,7 @@ declare class Test {
     /**
     * @param {boolean} [quiet] - does not output a report when true, default `false`
     */
-    constructor(quiet?: boolean | undefined);
+    constructor(quiet?: boolean);
     /**
     * Set the timeout when a synced function is called.
     * This settles async code used in a sync function
@@ -58,7 +58,7 @@ declare class Test {
     * @param {number[]} [execute] - limit the execution tests
     * @returns {Promise<Report>}
     */
-    run(execute?: number[] | undefined): Promise<Report>;
+    run(execute?: number[]): Promise<Report>;
     /**
     * Empty tests
     */