@j-o-r/sh 1.1.17 → 1.1.19

package/lib/SH.js

@@ -27,6 +27,7 @@
 // Modified by: jorrit.duin+sh[AT]gmail.com
 /** @type {assert} */
 import assert from 'node:assert';
+import readline from 'node:readline/promises';
 import SHDispatch from './SHDispatch.js';
 import Test from './Test.js'
 import AsyncTracker from './AsyncTracker.js'
@@ -90,8 +91,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}`);
@@ -140,10 +146,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 content = await readIn();
 */
 const readIn = async () => {
+	if (process.stdin.isTTY) return '';   // nothing was piped
 	let buf = '';
 	process.stdin.setEncoding('utf8');
 	for await (const chunk of process.stdin) {
@@ -152,6 +160,46 @@ const readIn = async () => {
 	return buf;
 }
 
+
+/**
+* Get user input from the command line (stdin)
+* @param {string} prompt - prompt or question
+* @returns {Promise<string>}
+* @example 
+* const content = await userIn();
+*/
+
+const userIn = (prompt) => new Promise((resolve) => {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  let buffer = '';
+  let timer;
+  /**
+  * @param {string} chunk
+  */
+  const onData = (chunk) => {
+    if (chunk.length > 4 && chunk.includes('\n')) {
+      clearTimeout(timer);
+      timer = setTimeout(resolveFunc, 50);
+    }
+  };
+  const resolveFunc = () => {
+    let fullText = buffer;
+    if (rl.line) fullText += rl.line;
+    process.stdin.removeListener('data', onData);
+    resolve(fullText);
+    rl.close();
+  };
+  rl.on('line', (line) => {
+    buffer += line + '\n';
+    clearTimeout(timer);
+    timer = setTimeout(resolveFunc, 50);
+  });
+  process.stdin.on('data', onData);
+
+  rl.setPrompt(prompt);
+  rl.prompt();
+});
+
 /**
 * Retries a given asynchronous function a specified number of times with optional delays between attempts.
 *
@@ -301,6 +349,7 @@ export {
 	sleep,
 	retry,
 	readIn,
+	userIn,
 	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.1.17",
+  "version": "1.1.19",
   "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,11 +55,20 @@ 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();
+* const content = await readIn();
 */
 export function readIn(): Promise<string>;
 /**
+* Get user input from the command line (stdin)
+* @param {string} prompt - prompt or question
+* @returns {Promise<string>}
+* @example
+* const content = await userIn();
+*/
+export function userIn(prompt: string): Promise<string>;
+/**
 * Create a async/sync context in new execution callstack
 * @param {function} callback - async/sync function
 * @example