@j-o-r/sh 1.1.17 → 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}`);
@@ -140,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/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.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();
 */