@j-o-r/sh 1.0.5 → 1.0.6

package/README.md

@@ -59,7 +59,7 @@ The `SH` method accepts a template literal string enclosed in backticks as its a
 ### Additional Utilities
 
 The module also provides additional utilities for common tasks:
-- `args(command)`: Parsing a command from a string into an arguments array 
+- `parseArgs(process.args)`: Transform an array of strings into an object 
 - `cd(dir)`: Change the working directory.
 - `sleep(duration)`: Pause execution for a specified duration.
 - `retry(count, interval, callback)`: Retry a command a specified number of times with an optional interval.

package/lib/SH.js

@@ -29,7 +29,6 @@
 import assert from 'node:assert';
 import SHDispatch from './SHDispatch.js';
 
-
 /**
  * Creates a new SHDispatch object that represents a command to be executed.
  *
@@ -211,6 +210,34 @@ function* expBackoff(max = '60s', rand = '100ms') {
 		yield Math.min(2 ** n++, maxMs) + ms;
 	}
 }
+/**
+* Parses command-line arguments into an object.
+*
+* The function recognizes arguments that start with two dashes (`--`) 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.
+* @returns {object} An object where:
+*   - Each key corresponds to an argument that starts with `--`,
+*   - 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 result = { _: [] }; // Initialize result with an empty array for unbound values
+	for (let i = 0; i < args.length; i++) {
+		if (args[i].startsWith('--')) {
+			const key = args[i].substring(2);
+			const value = args[i + 1] && !args[i + 1].startsWith('--') ? args[i + 1] : true;
+			result[key] = value;
+			if (value !== true) i++; // Skip the next element as it is a value
+		} else {
+			result._.push(args[i]); // Add unbound value to the array
+		}
+	}
+	return result;
+}
 export {
 	SH,
 	cd,
@@ -219,4 +246,5 @@ export {
 	readIn,
 	within,
 	expBackoff,
+	parseArgs
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@j-o-r/sh",
   "author": "Jorrit Duin <j-o-r@duin.work>",
   "type": "module",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",
@@ -46,4 +46,4 @@
     "process-promise",
     "process-output"
   ]
-}
+}

package/types/SH.d.ts

@@ -68,4 +68,19 @@ export function within(callback: Function): void;
  * @yields {number} The backoff time in milliseconds.
  */
 export function expBackoff(max?: string | undefined, rand?: string | undefined): Generator<number, void, unknown>;
+/**
+* Parses command-line arguments into an object.
+*
+* The function recognizes arguments that start with two dashes (`--`) 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.
+* @returns {object} An object where:
+*   - Each key corresponds to an argument that starts with `--`,
+*   - 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[]): object;
 import SHDispatch from './SHDispatch.js';