@j-o-r/sh 1.0.3 → 1.0.4

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 
 - `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.
@@ -92,6 +92,13 @@ This class is returned by the `SH` function. Here's a summary of its methods and
   console.log(res);
   ```
 
+- Create a command from a string
+  ```javascript
+	const command = args("uname -r");
+	const content = await SH`${command}`.run();
+	console.log(content);
+  ```
+
 - Async context with multiple commands and sleep:
   ```javascript
   within(async () => {

package/lib/SH.js

@@ -113,7 +113,48 @@ const SH = new Proxy(function(pieces, ...args) {
 	}
 	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
@@ -245,6 +286,7 @@ function* expBackoff(max = '60s', rand = '100ms') {
 }
 export {
 	SH,
+	args,
 	cd,
 	sleep,
 	retry,

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.3",
+  "version": "1.0.4",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",
@@ -13,7 +13,7 @@
     "test": "test/sh.js",
     "publish": "npm run release && npm publish --access public",
     "release": "npm pack --pack-destination=release",
-    "types": "tsc lib/*.js --module nodenext --moduleResolution nodenext --declaration --allowJs --emitDeclarationOnly --outDir types/",
+    "types": "tsc",
     "clear:types": "rm types/*.d.ts"
   },
   "repository": {
@@ -22,10 +22,7 @@
   },
   "license": "Apache License, Version 2.0",
   "dependencies": {},
-  "devDependencies": {
-    "@types/node": "^20.8.10",
-    "uvu": "^0.5.6"
-  },
+  "devDependencies": {},
   "bugs": {
     "url": "https://codeberg.org/duin/sh/issues"
   },
@@ -49,4 +46,4 @@
     "process-promise",
     "process-output"
   ]
-}
+}

package/types/SH.d.ts

@@ -6,6 +6,14 @@ 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
@@ -39,7 +47,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 | typeof expBackoff | Function, b?: Function | undefined): Promise<any>;
 /**
 * This function reads the standard input (stdin) from the current process.
 * @example
@@ -67,5 +75,5 @@ export function within(callback: Function): void;
  * @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, rand?: string): Generator<number, void, unknown>;
+export function expBackoff(max?: string | undefined, rand?: string | undefined): Generator<number, void, unknown>;
 import SHDispatch from './SHDispatch.js';

package/types/SHDispatch.d.ts

@@ -32,29 +32,29 @@ export type SHOptions = {
     /**
      * - The current working directory.
      */
-    cwd?: string;
+    cwd?: string | undefined;
     /**
      * - The environment variables.
      */
-    env?: NodeJS.ProcessEnv;
+    env?: any;
     /**
      * - The shell to use for execution.
      */
-    shell?: string;
+    shell?: string | undefined;
     /**
      * - The prefix commands to ensure a safe execution environment. e.g: prefix: 'set -euo pipefail;/usr/bin/env',
      */
-    prefix?: string;
+    prefix?: string | undefined;
     /**
      * - The stdio configuration.
      */
-    stdio?: StdioOptions | StdioOption;
+    stdio?: number | "pipe" | "ignore" | "inherit" | StdioOption[] | undefined;
     /**
      * - default 20000: a timeout error is triggerd when a process execution time is exceeded, 0 is no timeout
      */
-    timeout?: number;
+    timeout?: number | undefined;
 };
-export type StdioOption = ('pipe' | 'ignore' | 'inherit' | number);
+export type StdioOption = ("pipe" | "ignore" | "inherit" | number);
 export type StdioOptions = Array<StdioOption> | StdioOption;
 declare class SHDispatch {
     /**
@@ -70,13 +70,13 @@ declare class SHDispatch {
     * @param {string} [payload]
     * @returns {Promise<string>}
     */
-    run(payload?: string): Promise<string>;
+    run(payload?: string | undefined): Promise<string>;
     /**
     * Works for screen takeovers like editors
     * @param {string} [payload]
     * @returns {SpawnSyncResponse}
     */
-    runSync(payload?: string): SpawnSyncResponse;
+    runSync(payload?: string | undefined): SpawnSyncResponse;
     kill(): Promise<void>;
     #private;
 }

package/types/SHExecute.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 export default SHExecute;
 declare class SHExecute {
     /**
@@ -10,12 +9,12 @@ declare class SHExecute {
     * @param {string} [payload] - data to write
     * @retuns {Promise<object>}
     */
-    runSync(payload?: string): import("child_process").SpawnSyncReturns<Buffer>;
+    runSync(payload?: string | undefined): any;
     /**
     * @param {string} [payload] - data to write
     * @retuns {Promise<string>}
     */
-    run(payload?: string): Promise<any>;
+    run(payload?: string | undefined): Promise<any>;
     /**
     * @returns {Promise<number[]>}
     */