@j-o-r/sh 1.0.4 → 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.
@@ -94,7 +94,7 @@ This class is returned by the `SH` function. Here's a summary of its methods and
 
 - Create a command from a string
   ```javascript
-	const command = args("uname -r");
+	const command = "uname -r";
 	const content = await SH`${command}`.run();
 	console.log(content);
   ```

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.
  *
@@ -45,37 +44,6 @@ import SHDispatch from './SHDispatch.js';
  * const command = await SH`echo 'Hello, world!'`.run();
  */
 
-/**
-* escape paramater commands
-* @param {string} arg
-* @returns {string}
-*/
-const quote = (arg) => {
-	if (/^[a-z0-9/_.\-@:=]+$/i.test(arg) || arg === '') {
-		return arg;
-	}
-	return (`'` +
-		arg
-			.replace(/\\/g, '\\\\')
-			.replace(/'/g, "\\'")
-			.replace(/\f/g, '\\f')
-			.replace(/\n/g, '\\n')
-			.replace(/\r/g, '\\r')
-			.replace(/\t/g, '\\t')
-			.replace(/\v/g, '\\v')
-			.replace(/\0/g, '\\0') +
-		`'`);
-}
-/**
-* Escape CLI arguments
-* @param {string[]} arg
-* @retruns {string}
-*/
-const sanitizeArg = (arg) => {
-	const s = `${arg}`;
-	return quote(s);
-}
-
 /**
 * 4ms, 5s || 5
 * @param {number|string} d 
@@ -104,57 +72,15 @@ const SH = new Proxy(function(pieces, ...args) {
 	while (i < args.length) {
 		let s;
 		if (Array.isArray(args[i])) {
-			s = args[i].map((x) => sanitizeArg(x)).join(' ');
+			s = args[i].map((x) => x).join(' ');
 		}
 		else {
-			s = sanitizeArg(args[i]);
+			s = args[i];
 		}
 		cmd += s + pieces[++i];
 	}
 	return new SHDispatch(cmd);
 }, {});
-/**
- * Splits a command string into an array of arguments, handling quoted strings.
- * This fixes a problem when a command is like this: SH`${command}` 
- * 
- * @param {string} command - The command string to split.
- * @returns {string[]} - The array of command arguments.
- */
-const args = (command) => {
-	const args = [];
-	let currentArg = '';
-	let insideQuotes = false;
-	let quoteChar = null;
-
-	for (let i = 0; i < command.length; i++) {
-		const char = command[i];
-
-		if (char === '"' || char === "'") {
-			if (insideQuotes && quoteChar === char && command[i - 1] !== '\\') {
-				insideQuotes = false;
-				quoteChar = null;
-			} else if (!insideQuotes) {
-				insideQuotes = true;
-				quoteChar = char;
-			} else {
-				currentArg += char;
-			}
-		} else if (char === ' ' && !insideQuotes) {
-			if (currentArg.length > 0) {
-				args.push(currentArg);
-				currentArg = '';
-			}
-		} else {
-			currentArg += char;
-		}
-	}
-
-	if (currentArg.length > 0) {
-		args.push(currentArg);
-	}
-
-	return args.map(arg => arg.replace(/\\(['"])/g, '$1'));
-}
 /**
 * Create a async context in an sync block
 * @param {function} callback - async function
@@ -284,13 +210,41 @@ 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,
-	args,
 	cd,
 	sleep,
 	retry,
 	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.4",
+  "version": "1.0.6",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",

package/types/SH.d.ts

@@ -6,14 +6,6 @@ export type Shell = Function;
 export const SH: Shell & {
     (pieces: TemplateStringsArray, ...args: any): SHDispatch;
 };
-/**
- * Splits a command string into an array of arguments, handling quoted strings.
- * This fixes a problem when a command is like this: SH`${command}`
- *
- * @param {string} command - The command string to split.
- * @returns {string[]} - The array of command arguments.
- */
-export function args(command: string): string[];
 /**
 * Change working directory
 * @param {string} dir
@@ -76,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';