@naturalcycles/nodejs-lib 15.20.1 → 15.21.0

package/dist/exec2/exec2.d.ts

@@ -1,3 +1,4 @@
+import { type StdioOptions } from 'node:child_process';
 import { AppError } from '@naturalcycles/js-lib/error/error.util.js';
 import type { AnyObject, NumberOfMilliseconds } from '@naturalcycles/js-lib/types';
 /**
@@ -164,6 +165,10 @@ export interface SpawnOptions {
      * Set to false or true to override.
      */
     forceColor?: boolean;
+    /**
+     * Defaults to "inherit"
+     */
+    stdio?: StdioOptions;
 }
 export interface ExecOptions {
     /**
@@ -192,5 +197,10 @@ export interface ExecOptions {
      * Set to true to pass `process.env` to the spawned process.
      */
     passProcessEnv?: boolean;
+    /**
+     * Defaults to undefined.
+     * beware that stdio: 'inherit', means we don't get the output returned.
+     */
+    stdio?: StdioOptions;
 }
 export {};

package/dist/exec2/exec2.js

@@ -40,7 +40,7 @@ class Exec2 {
      * log: true
      */
     spawn(cmd, opt = {}) {
-        const { shell = true, cwd, env, passProcessEnv = true, forceColor = hasColors } = opt;
+        const { shell = true, cwd, env, passProcessEnv = true, forceColor = hasColors, stdio = 'inherit', } = opt;
         opt.log ??= true; // by default log should be true, as we are printing the output
         opt.logStart ??= opt.log;
         opt.logFinish ??= opt.log;
@@ -48,7 +48,7 @@ class Exec2 {
         this.logStart(cmd, opt);
         const r = spawnSync(cmd, opt.args, {
             encoding: 'utf8',
-            stdio: 'inherit',
+            stdio,
             shell,
             cwd,
             env: {
@@ -81,7 +81,7 @@ class Exec2 {
      * log: false
      */
     exec(cmd, opt = {}) {
-        const { cwd, env, passProcessEnv = true, timeout } = opt;
+        const { cwd, env, passProcessEnv = true, timeout, stdio } = opt;
         opt.logStart ??= opt.log ?? false;
         opt.logFinish ??= opt.log ?? false;
         const started = Date.now();
@@ -89,8 +89,7 @@ class Exec2 {
         try {
             const s = execSync(cmd, {
                 encoding: 'utf8',
-                // stdio: 'inherit', // no, otherwise we don't get the output returned
-                stdio: undefined,
+                stdio,
                 // shell: undefined,
                 cwd,
                 timeout,
@@ -245,9 +244,7 @@ class Exec2 {
             .map(([k, v]) => [k, v].join('='))
             .join(' ');
         if (opt.name) {
-            console.log(['  ', dimGrey(envString), white(opt.name), dimGrey('started...')]
-                .filter(Boolean)
-                .join(' '));
+            console.log(['  ', white(opt.name), dimGrey('started...')].filter(Boolean).join(' '));
         }
         else {
             console.log([

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.20.1",
+  "version": "15.21.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",
@@ -23,7 +23,7 @@
   },
   "devDependencies": {
     "@types/through2-concurrent": "^2",
-    "@naturalcycles/dev-lib": "19.32.0"
+    "@naturalcycles/dev-lib": "18.4.2"
   },
   "exports": {
     ".": "./dist/index.js",

package/src/exec2/exec2.ts

@@ -1,4 +1,4 @@
-import { execSync, spawn, spawnSync } from 'node:child_process'
+import { execSync, spawn, spawnSync, type StdioOptions } from 'node:child_process'
 import { _since } from '@naturalcycles/js-lib/datetime/time.util.js'
 import { AppError } from '@naturalcycles/js-lib/error/error.util.js'
 import { _substringAfterLast } from '@naturalcycles/js-lib/string/string.util.js'
@@ -46,7 +46,14 @@ class Exec2 {
    * log: true
    */
   spawn(cmd: string, opt: SpawnOptions = {}): void {
-    const { shell = true, cwd, env, passProcessEnv = true, forceColor = hasColors } = opt
+    const {
+      shell = true,
+      cwd,
+      env,
+      passProcessEnv = true,
+      forceColor = hasColors,
+      stdio = 'inherit',
+    } = opt
     opt.log ??= true // by default log should be true, as we are printing the output
     opt.logStart ??= opt.log
     opt.logFinish ??= opt.log
@@ -55,7 +62,7 @@ class Exec2 {
 
     const r = spawnSync(cmd, opt.args, {
       encoding: 'utf8',
-      stdio: 'inherit',
+      stdio,
       shell,
       cwd,
       env: {
@@ -91,7 +98,7 @@ class Exec2 {
    * log: false
    */
   exec(cmd: string, opt: ExecOptions = {}): string {
-    const { cwd, env, passProcessEnv = true, timeout } = opt
+    const { cwd, env, passProcessEnv = true, timeout, stdio } = opt
     opt.logStart ??= opt.log ?? false
     opt.logFinish ??= opt.log ?? false
     const started = Date.now() as UnixTimestampMillis
@@ -100,8 +107,7 @@ class Exec2 {
     try {
       const s = execSync(cmd, {
         encoding: 'utf8',
-        // stdio: 'inherit', // no, otherwise we don't get the output returned
-        stdio: undefined,
+        stdio,
         // shell: undefined,
         cwd,
         timeout,
@@ -276,11 +282,7 @@ class Exec2 {
       .join(' ')
 
     if (opt.name) {
-      console.log(
-        ['  ', dimGrey(envString), white(opt.name), dimGrey('started...')]
-          .filter(Boolean)
-          .join(' '),
-      )
+      console.log(['  ', white(opt.name), dimGrey('started...')].filter(Boolean).join(' '))
     } else {
       console.log(
         [
@@ -402,6 +404,11 @@ export interface SpawnOptions {
    * Set to false or true to override.
    */
   forceColor?: boolean
+
+  /**
+   * Defaults to "inherit"
+   */
+  stdio?: StdioOptions
 }
 
 export interface ExecOptions {
@@ -433,4 +440,10 @@ export interface ExecOptions {
    * Set to true to pass `process.env` to the spawned process.
    */
   passProcessEnv?: boolean
+
+  /**
+   * Defaults to undefined.
+   * beware that stdio: 'inherit', means we don't get the output returned.
+   */
+  stdio?: StdioOptions
 }