@j-o-r/sh 1.1.16 → 1.1.18

package/lib/SH.js

@@ -90,8 +90,13 @@ const parseDuration = (d) => {
 	}
 	throw new Error(`Unknown duration: "${d}".`);
 }
-
-/** @type {Shell & { (pieces: TemplateStringsArray, ...args: *): SHDispatch }} */
+/**
+* A template-tag that returns an SHDispatch.
+* @typedef {(pieces: TemplateStringsArray, ...args: unknown[]) => SHDispatch} SHTag
+*/
+/**
+* @type {Shell & SHTag}
+*/
 const SH = new Proxy(function(pieces, ...args) {
 	if (pieces.some((p) => p == undefined)) {
 		throw new Error(`Malformed command ${pieces}`);
@@ -99,9 +104,12 @@ const SH = new Proxy(function(pieces, ...args) {
 	let cmd = pieces[0], i = 0;
 	while (i < args.length) {
 		let s;
+		
 		if (Array.isArray(args[i])) {
 			s = args[i].map(/** @param {string} x */(x) => {
-				let str = String(x);
+				// Trim every element
+				let str = String(x).trim();
+        str = str.replace(/\n/g, '\\n').replace(/\r/g, '\\r').replace(/\t/g, '\\t');
 				// If the string contains special characters, wrap in single quotes
 				if (str.match(/[ "'$`(){}[\]]/)) {
 					// Escape single quotes within the string
@@ -110,15 +118,6 @@ const SH = new Proxy(function(pieces, ...args) {
 				return str;
 			}).join(' ');
 		} else {
-			// let str = String(args[i]);
-			// if (str.match(/[ "'$`(){}[\]]/)) {
-			// 	s = `'${str.replace(/'/g, `'\\''`)}'`;
-			// } else {
-			// 	s = str;
-			// }
-			// Leave string UNALTERED
-			// Should be escaped in the code and is the responsibility of the developer
-			// SH`do something "${filename}"`;
 			s = String(args[i]);
 		}
 		cmd += s + pieces[++i];
@@ -146,10 +145,12 @@ const within = async (callback) => {
 
 /**
 * This function reads the standard input (stdin) from the current process.
+* @returns {Promise<string>}
 * @example 
 * const content = await stdin();
 */
 const readIn = async () => {
+	if (process.stdin.isTTY) return '';   // nothing was piped
 	let buf = '';
 	process.stdin.setEncoding('utf8');
 	for await (const chunk of process.stdin) {

package/lib/SHExecute.js

@@ -1,5 +1,4 @@
 import { spawnSync, spawn, exec } from 'node:child_process';
-import { nextTick } from 'node:process';
 
 /**
 * Kills a process and all child processes of a given process ID in Linux/Posix.

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.16",
+  "version": "1.1.18",
   "description": "Execute shell commands on Linux-based systems from javascript",
   "main": "lib/SH.js",
   "types": "types/SH.d.ts",
@@ -13,7 +13,7 @@
     "test": "npm run test:sh",
     "test:sh": "scenarios/sh.js",
     "publish": "npm run release && npm publish --access public",
-    "release": "npm pack --pack-destination=release",
+    "release": "npm run types && npm pack --pack-destination=release",
     "types": "rm types/* && tsc -p tsc.json"
   },
   "repository": {

package/types/SH.d.ts

@@ -7,10 +7,18 @@ export type ResolveCallback = Function;
  * Creates a new SHDispatch object that represents a command to be executed.
  */
 export type Shell = Function;
-/** @type {Shell & { (pieces: TemplateStringsArray, ...args: *): SHDispatch }} */
-export const SH: Shell & {
-    (pieces: TemplateStringsArray, ...args: any): SHDispatch;
-};
+/**
+ * A template-tag that returns an SHDispatch.
+ */
+export type SHTag = (pieces: TemplateStringsArray, ...args: unknown[]) => SHDispatch;
+/**
+* A template-tag that returns an SHDispatch.
+* @typedef {(pieces: TemplateStringsArray, ...args: unknown[]) => SHDispatch} SHTag
+*/
+/**
+* @type {Shell & SHTag}
+*/
+export const SH: Shell & SHTag;
 /**
 * Change working directory
 * @param {string} dir
@@ -47,6 +55,7 @@ export function sleep(duration: string | number): Promise<any>;
 export function retry(count: number, a: string | number | typeof expBackoff | Function, b?: Function): Promise<any>;
 /**
 * This function reads the standard input (stdin) from the current process.
+* @returns {Promise<string>}
 * @example
 * const content = await stdin();
 */