@naturalcycles/nodejs-lib 13.33.1 → 13.34.1

package/dist/util/exec2.d.ts

@@ -140,6 +140,16 @@ export interface SpawnOptions {
     name?: string;
     cwd?: string;
     env?: AnyObject;
+    /**
+     * Defaults to false for security reasons.
+     * Set to true to pass `process.env` to the spawned process.
+     */
+    passProcessEnv?: boolean;
+    /**
+     * Defaults to "auto detect colors".
+     * Set to false or true to override.
+     */
+    forceColor?: boolean;
 }
 export interface ExecOptions {
     /**
@@ -163,5 +173,10 @@ export interface ExecOptions {
     cwd?: string;
     timeout?: NumberOfMilliseconds;
     env?: AnyObject;
+    /**
+     * Defaults to false for security reasons.
+     * Set to true to pass `process.env` to the spawned process.
+     */
+    passProcessEnv?: boolean;
 }
 export {};

package/dist/util/exec2.js

@@ -50,15 +50,20 @@ class Exec2 {
     async spawnAsync(cmd, opt = {}) {
         const started = Date.now();
         this.logStart(cmd, opt);
-        const { shell = true, printWhileRunning = true, collectOutputWhileRunning = true, throwOnNonZeroCode = true, cwd, env, } = opt;
+        const { shell = true, printWhileRunning = true, collectOutputWhileRunning = true, throwOnNonZeroCode = true, cwd, env, forceColor = colors_1.hasColors, } = opt;
         let stdout = '';
         let stderr = '';
+        if (printWhileRunning)
+            console.log(''); // 1-line padding before the output
         return await new Promise((resolve, reject) => {
             const p = node_child_process_1.default.spawn(cmd, opt.args || [], {
                 shell,
                 cwd,
-                env,
-                // ...process.env, // not passing by default for security reasons
+                env: {
+                    ...env,
+                    ...(opt.passProcessEnv ? process.env : {}),
+                    ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+                },
             });
             p.stdout.on('data', data => {
                 if (collectOutputWhileRunning) {
@@ -79,7 +84,10 @@ class Exec2 {
                 }
             });
             p.on('close', code => {
-                this.logFinish(cmd, opt, started);
+                if (printWhileRunning)
+                    console.log(''); // 1-line padding after the output
+                const isSuccessful = !code;
+                this.logFinish(cmd, opt, started, isSuccessful);
                 const exitCode = code || 0;
                 const o = {
                     exitCode,
@@ -109,16 +117,22 @@ class Exec2 {
     spawn(cmd, opt = {}) {
         const started = Date.now();
         this.logStart(cmd, opt);
-        const { shell = true, cwd, env } = opt;
+        const { shell = true, cwd, env, forceColor = colors_1.hasColors } = opt;
+        console.log(''); // 1-line padding before the output
         const r = node_child_process_1.default.spawnSync(cmd, opt.args, {
             encoding: 'utf8',
             stdio: 'inherit',
             shell,
             cwd,
-            env,
-            // ...process.env, // not passing by default for security reasons
+            env: {
+                ...env,
+                ...(opt.passProcessEnv ? process.env : {}),
+                ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+            },
         });
-        this.logFinish(cmd, opt, started);
+        console.log(''); // 1-line padding after the output
+        const isSuccessful = !r.error && !r.status;
+        this.logFinish(cmd, opt, started, isSuccessful);
         if (r.error) {
             throw r.error;
         }
@@ -145,7 +159,7 @@ class Exec2 {
         this.logStart(cmd, opt);
         const { cwd, env, timeout } = opt;
         try {
-            return node_child_process_1.default
+            const s = node_child_process_1.default
                 .execSync(cmd, {
                 encoding: 'utf8',
                 // stdio: 'inherit', // no, otherwise we don't get the output returned
@@ -153,10 +167,14 @@ class Exec2 {
                 // shell: undefined,
                 cwd,
                 timeout,
-                env,
-                // ...process.env, // not passing by default for security reasons
+                env: {
+                    ...env,
+                    ...(opt.passProcessEnv ? process.env : {}),
+                },
             })
                 .trim();
+            this.logFinish(cmd, opt, started, true);
+            return s;
         }
         catch (err) {
             // Not logging stderr, as it's printed by execSync by default (somehow)
@@ -167,11 +185,9 @@ class Exec2 {
             if (err.stdout) {
                 process.stdout.write(err.stdout);
             }
+            this.logFinish(cmd, opt, started, false);
             throw new Error(`exec exited with code ${err.status}: ${cmd}`);
         }
-        finally {
-            this.logFinish(cmd, opt, started);
-        }
     }
     throwOnNonZeroExitCode(o) {
         if (o.exitCode) {
@@ -189,10 +205,17 @@ class Exec2 {
             .filter(Boolean)
             .join(' '));
     }
-    logFinish(cmd, opt, started) {
-        if (!opt.logFinish && !opt.log)
+    logFinish(cmd, opt, started, isSuccessful) {
+        if (isSuccessful && !opt.logFinish && !opt.log)
             return;
-        console.log([(0, colors_1.white)(opt.name || cmd), (0, colors_1.dimGrey)('took ' + (0, js_lib_1._since)(started))].join(' '));
+        console.log([
+            (0, colors_1.white)(opt.name || cmd),
+            ...((!opt.name && opt.args) || []),
+            (0, colors_1.dimGrey)('took ' + (0, js_lib_1._since)(started)),
+            !isSuccessful && (0, colors_1.dimGrey)('and ') + (0, colors_1.dimRed)('failed'),
+        ]
+            .filter(Boolean)
+            .join(' '));
     }
 }
 exports.exec2 = new Exec2();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "13.33.1",
+  "version": "13.34.1",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/util/exec2.ts

@@ -6,7 +6,7 @@ import {
   NumberOfMilliseconds,
   UnixTimestampMillisNumber,
 } from '@naturalcycles/js-lib'
-import { dimGrey, white } from '../colors/colors'
+import { dimGrey, dimRed, hasColors, white } from '../colors/colors'
 
 /**
  * Set of utility functions to work with Spawn / Exec.
@@ -60,16 +60,22 @@ class Exec2 {
       throwOnNonZeroCode = true,
       cwd,
       env,
+      forceColor = hasColors,
     } = opt
     let stdout = ''
     let stderr = ''
 
+    if (printWhileRunning) console.log('') // 1-line padding before the output
+
     return await new Promise<SpawnOutput>((resolve, reject) => {
       const p = cp.spawn(cmd, opt.args || [], {
         shell,
         cwd,
-        env,
-        // ...process.env, // not passing by default for security reasons
+        env: {
+          ...env,
+          ...(opt.passProcessEnv ? process.env : {}),
+          ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+        },
       })
 
       p.stdout.on('data', data => {
@@ -92,7 +98,9 @@ class Exec2 {
       })
 
       p.on('close', code => {
-        this.logFinish(cmd, opt, started)
+        if (printWhileRunning) console.log('') // 1-line padding after the output
+        const isSuccessful = !code
+        this.logFinish(cmd, opt, started, isSuccessful)
         const exitCode = code || 0
         const o: SpawnOutput = {
           exitCode,
@@ -123,18 +131,24 @@ class Exec2 {
   spawn(cmd: string, opt: SpawnOptions = {}): void {
     const started = Date.now()
     this.logStart(cmd, opt)
-    const { shell = true, cwd, env } = opt
+    const { shell = true, cwd, env, forceColor = hasColors } = opt
+    console.log('') // 1-line padding before the output
 
     const r = cp.spawnSync(cmd, opt.args, {
       encoding: 'utf8',
       stdio: 'inherit',
       shell,
       cwd,
-      env,
-      // ...process.env, // not passing by default for security reasons
+      env: {
+        ...env,
+        ...(opt.passProcessEnv ? process.env : {}),
+        ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+      },
     })
 
-    this.logFinish(cmd, opt, started)
+    console.log('') // 1-line padding after the output
+    const isSuccessful = !r.error && !r.status
+    this.logFinish(cmd, opt, started, isSuccessful)
 
     if (r.error) {
       throw r.error
@@ -164,7 +178,7 @@ class Exec2 {
     const { cwd, env, timeout } = opt
 
     try {
-      return cp
+      const s = cp
         .execSync(cmd, {
           encoding: 'utf8',
           // stdio: 'inherit', // no, otherwise we don't get the output returned
@@ -172,10 +186,15 @@ class Exec2 {
           // shell: undefined,
           cwd,
           timeout,
-          env,
-          // ...process.env, // not passing by default for security reasons
+          env: {
+            ...env,
+            ...(opt.passProcessEnv ? process.env : {}),
+          },
         })
         .trim()
+
+      this.logFinish(cmd, opt, started, true)
+      return s
     } catch (err) {
       // Not logging stderr, as it's printed by execSync by default (somehow)
       // stdout is not printed by execSync though, therefor we print it here
@@ -185,9 +204,8 @@ class Exec2 {
       if ((err as any).stdout) {
         process.stdout.write((err as any).stdout)
       }
+      this.logFinish(cmd, opt, started, false)
       throw new Error(`exec exited with code ${(err as any).status}: ${cmd}`)
-    } finally {
-      this.logFinish(cmd, opt, started)
     }
   }
 
@@ -215,10 +233,20 @@ class Exec2 {
     cmd: string,
     opt: SpawnOptions | ExecOptions,
     started: UnixTimestampMillisNumber,
+    isSuccessful: boolean,
   ): void {
-    if (!opt.logFinish && !opt.log) return
+    if (isSuccessful && !opt.logFinish && !opt.log) return
 
-    console.log([white(opt.name || cmd), dimGrey('took ' + _since(started))].join(' '))
+    console.log(
+      [
+        white(opt.name || cmd),
+        ...((!opt.name && (opt as SpawnOptions).args) || []),
+        dimGrey('took ' + _since(started)),
+        !isSuccessful && dimGrey('and ') + dimRed('failed'),
+      ]
+        .filter(Boolean)
+        .join(' '),
+    )
   }
 }
 
@@ -297,6 +325,16 @@ export interface SpawnOptions {
   cwd?: string
 
   env?: AnyObject
+  /**
+   * Defaults to false for security reasons.
+   * Set to true to pass `process.env` to the spawned process.
+   */
+  passProcessEnv?: boolean
+  /**
+   * Defaults to "auto detect colors".
+   * Set to false or true to override.
+   */
+  forceColor?: boolean
 }
 
 export interface ExecOptions {
@@ -323,4 +361,9 @@ export interface ExecOptions {
   timeout?: NumberOfMilliseconds
 
   env?: AnyObject
+  /**
+   * Defaults to false for security reasons.
+   * Set to true to pass `process.env` to the spawned process.
+   */
+  passProcessEnv?: boolean
 }