@j-o-r/sh 1.1.26 → 1.1.28

package/lib/SH.js

@@ -103,6 +103,27 @@ const parseDuration = (d) => {
 	}
 	throw new Error(`Unknown duration: "${d}".`);
 }
+/**
+* bash escape a string suitable as an argument on the commandline
+* for javascript code
+* @param {string} x
+* @returns {string}
+*/
+const bashEscape = (x) => {
+	let str = String(x).trim();
+	// the trick is to double escape escape vars first
+	str = str.replace(/\\/g, '\\\\');
+	// then add escaping for oddities
+	// Replace literal escape sequences like \n, \t, \r in quoted strings
+	str = str.replace(/(['"])\\(.)\1/g, '$1\\\\$2$1');
+	// escape $ (is a BASH var)
+	str = str.replace(/\$/g, '\\$');
+	// Escape backticks
+	str = str.replace(/`/g, '\\`');
+	// Escape quotes
+	str = str.replace(/"/g, '\\"');
+	return str;
+}
 
 
 /** @type {import('./SHDispatch.js').SHOptions} */
@@ -194,10 +215,10 @@ const within = async (callback) => {
 */
 /**
  * Read entire stdin as UTF-8. If stdin is a TTY, resolves to an empty string.
- * @returns {Promise<string>}
+ * @returns {Promise<string|undefined>}
  */
 const readIn = async () => {
-	if (process.stdin.isTTY) return '';   // nothing was piped
+	if (process.stdin.isTTY) return;   // nothing was piped
 	let buf = '';
 	process.stdin.setEncoding('utf8');
 	for await (const chunk of process.stdin) {
@@ -436,5 +457,6 @@ export {
 	hasProp,
 	Test,
 	assert,
-	AsyncTracker
+	AsyncTracker,
+	bashEscape
 }

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

package/types/SH.d.ts

@@ -69,9 +69,9 @@ export function retry(count: number, a: string | number | typeof expBackoff | Fu
 */
 /**
  * Read entire stdin as UTF-8. If stdin is a TTY, resolves to an empty string.
- * @returns {Promise<string>}
+ * @returns {Promise<string|undefined>}
  */
-export function readIn(): Promise<string>;
+export function readIn(): Promise<string | undefined>;
 /**
 * Get user input from the command line (stdin)
 * void when input has been aborted
@@ -187,5 +187,12 @@ export function hasProp(o: any, p: string): boolean;
 import Test from './Test.js';
 import assert from 'node:assert';
 import AsyncTracker from './AsyncTracker.js';
+/**
+* bash escape a string suitable as an argument on the commandline
+* for javascript code
+* @param {string} x
+* @returns {string}
+*/
+export function bashEscape(x: string): string;
 import SHDispatch from './SHDispatch.js';
 export { Test, assert, AsyncTracker };