@j-o-r/sh 1.0.3 → 1.0.5

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 = "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

@@ -45,37 +45,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,16 +73,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);
 }, {});
-
 /**
 * Create a async context in an sync block
 * @param {function} callback - async function

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.5",
   "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"
   },

package/types/SH.d.ts

@@ -39,7 +39,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 +67,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[]>}
     */