npm - @naturalcycles/nodejs-lib - Versions diffs - 13.34.3 → 13.34.5 - Mend

@naturalcycles/nodejs-lib 13.34.3 → 13.34.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dist/util/exec2.d.ts CHANGED Viewed

@@ -8,7 +8,7 @@ import { AnyObject, AppError, NumberOfMilliseconds } from '@naturalcycles/js-lib
  *
  * Short-running job, no need to print the output, might want to return the output - use Exec.
  *
- * Need to both print and return the output - use SpawnAsync.
+ * Need to both print and return the output - use SpawnAsyncAndReturn.
  *
  * ***
  *
@@ -23,55 +23,68 @@ import { AnyObject, AppError, NumberOfMilliseconds } from '@naturalcycles/js-lib
  */
 declare class Exec2 {
     /**
-     * Advanced/async version of Spawn.
-     * Consider simpler `spawn` or `exec` first, which are also sync.
-     *
-     * spawnAsync features:
+     * Reasons to use it:
+     * - Sync
+     * - Need to print output while running
      *
-     * 1. Async
-     * 2. Allows to collect the output AND print it while running.
-     * 3. Returns SpawnOutput with stdout, stderr and exitCode.
-     * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
+     * Limitations:
+     * - Cannot return stdout/stderr (use exec, execAsync or spawnAsyncAndReturn for that)
      *
      * Defaults:
      *
      * shell: true
-     * printWhileRunning: true
-     * collectOutputWhileRunning: true
-     * throwOnNonZeroCode: true
      * log: true
      */
-    spawnAsync(cmd: string, opt?: SpawnAsyncOptions): Promise<SpawnOutput>;
+    spawn(cmd: string, opt?: SpawnOptions): void;
     /**
      * Reasons to use it:
+     *
      * - Sync
+     * - Need to return output
+     *
+     * Limitations:
+     * - Cannot print while running (use spawn or spawnAsync for that)
+     *
+     * Defaults:
+     *
+     * shell: true
+     * log: false
+     */
+    exec(cmd: string, opt?: ExecOptions): string;
+    /**
+     * Reasons to use it:
+     * - Async
      * - Need to print output while running
      *
      * Limitations:
-     * - Cannot return stdout/stderr (use exec or spawnAsync for that)
+     * - Cannot return stdout/stderr (use execAsync or spawnAsyncAndReturn for that)
      *
      * Defaults:
      *
      * shell: true
      * log: true
      */
-    spawn(cmd: string, opt?: SpawnOptions): void;
+    spawnAsync(cmd: string, opt?: SpawnOptions): Promise<void>;
     /**
-     * Reasons to use it:
+     * Advanced/async version of Spawn.
+     * Consider simpler `spawn` or `exec` first, which are also sync.
      *
-     * - Sync
-     * - Need to return output
+     * spawnAsyncAndReturn features:
      *
-     * Limitations:
-     * - Cannot print while running (use spawn or spawnAsync for that)
+     * 1. Async
+     * 2. Allows to collect the output AND print it while running.
+     * 3. Returns SpawnOutput with stdout, stderr and exitCode.
+     * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
      *
      * Defaults:
      *
      * shell: true
+     * printWhileRunning: true
+     * collectOutputWhileRunning: true
+     * throwOnNonZeroCode: true
      * log: true
      */
-    exec(cmd: string, opt?: ExecOptions): string;
-    throwOnNonZeroExitCode(o: SpawnOutput): void;
+    spawnAsyncAndReturn(cmd: string, opt?: SpawnAsyncOptions): Promise<SpawnOutput>;
     private logStart;
     private logFinish;
 }

package/dist/util/exec2.js CHANGED Viewed

@@ -14,7 +14,7 @@ const colors_1 = require("../colors/colors");
  *
  * Short-running job, no need to print the output, might want to return the output - use Exec.
  *
- * Need to both print and return the output - use SpawnAsync.
+ * Need to both print and return the output - use SpawnAsyncAndReturn.
  *
  * ***
  *
@@ -28,85 +28,13 @@ const colors_1 = require("../colors/colors");
  * Exec always uses the shell (there's no option to disable it).
  */
 class Exec2 {
-    /**
-     * Advanced/async version of Spawn.
-     * Consider simpler `spawn` or `exec` first, which are also sync.
-     *
-     * spawnAsync features:
-     *
-     * 1. Async
-     * 2. Allows to collect the output AND print it while running.
-     * 3. Returns SpawnOutput with stdout, stderr and exitCode.
-     * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
-     *
-     * Defaults:
-     *
-     * shell: true
-     * printWhileRunning: true
-     * collectOutputWhileRunning: true
-     * throwOnNonZeroCode: true
-     * log: true
-     */
-    async spawnAsync(cmd, opt = {}) {
-        const { shell = true, printWhileRunning = true, collectOutputWhileRunning = true, throwOnNonZeroCode = true, cwd, env, passProcessEnv = true, forceColor = colors_1.hasColors, } = opt;
-        opt.log ??= printWhileRunning; // by default log should be true, as we are printing the output
-        const started = Date.now();
-        this.logStart(cmd, 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: {
-                    ...(passProcessEnv ? process.env : {}),
-                    ...(forceColor ? { FORCE_COLOR: '1' } : {}),
-                    ...env,
-                },
-            });
-            p.stdout.on('data', data => {
-                if (collectOutputWhileRunning) {
-                    stdout += data.toString();
-                    // console.log('stdout:', data.toString())
-                }
-                if (printWhileRunning) {
-                    process.stdout.write(data);
-                    // console.log('stderr:', data.toString())
-                }
-            });
-            p.stderr.on('data', data => {
-                if (collectOutputWhileRunning) {
-                    stderr += data.toString();
-                }
-                if (printWhileRunning) {
-                    process.stderr.write(data);
-                }
-            });
-            p.on('close', code => {
-                // 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,
-                    stdout: stdout.trim(),
-                    stderr: stderr.trim(),
-                };
-                if (throwOnNonZeroCode && code) {
-                    return reject(new SpawnError(`spawnAsync exited with code ${code}: ${cmd}`, o));
-                }
-                resolve(o);
-            });
-        });
-    }
     /**
      * Reasons to use it:
      * - Sync
      * - Need to print output while running
      *
      * Limitations:
-     * - Cannot return stdout/stderr (use exec or spawnAsync for that)
+     * - Cannot return stdout/stderr (use exec, execAsync or spawnAsyncAndReturn for that)
      *
      * Defaults:
      *
@@ -116,9 +44,10 @@ class Exec2 {
     spawn(cmd, opt = {}) {
         const { shell = true, cwd, env, passProcessEnv = true, forceColor = colors_1.hasColors } = opt;
         opt.log ??= true; // by default log should be true, as we are printing the output
+        opt.logStart ??= opt.log;
+        opt.logFinish ??= opt.log;
         const started = Date.now();
         this.logStart(cmd, opt);
-        // console.log('') // 1-line padding before the output
         const r = node_child_process_1.default.spawnSync(cmd, opt.args, {
             encoding: 'utf8',
             stdio: 'inherit',
@@ -130,7 +59,6 @@ class Exec2 {
                 ...env,
             },
         });
-        // console.log('') // 1-line padding after the output
         const isSuccessful = !r.error && !r.status;
         this.logFinish(cmd, opt, started, isSuccessful);
         if (r.error) {
@@ -152,12 +80,14 @@ class Exec2 {
      * Defaults:
      *
      * shell: true
-     * log: true
+     * log: false
      */
     exec(cmd, opt = {}) {
+        const { cwd, env, passProcessEnv = true, timeout } = opt;
+        opt.logStart ??= opt.log ?? false;
+        opt.logFinish ??= opt.log ?? false;
         const started = Date.now();
         this.logStart(cmd, opt);
-        const { cwd, env, passProcessEnv = true, timeout } = opt;
         try {
             const s = node_child_process_1.default
                 .execSync(cmd, {
@@ -189,13 +119,121 @@ class Exec2 {
             throw new Error(`exec exited with code ${err.status}: ${cmd}`);
         }
     }
-    throwOnNonZeroExitCode(o) {
-        if (o.exitCode) {
-            throw new SpawnError(`spawn exited with code ${o.exitCode}`, o);
-        }
+    /**
+     * Reasons to use it:
+     * - Async
+     * - Need to print output while running
+     *
+     * Limitations:
+     * - Cannot return stdout/stderr (use execAsync or spawnAsyncAndReturn for that)
+     *
+     * Defaults:
+     *
+     * shell: true
+     * log: true
+     */
+    async spawnAsync(cmd, opt = {}) {
+        const { shell = true, cwd, env, passProcessEnv = true, forceColor = colors_1.hasColors } = opt;
+        opt.log ??= true; // by default log should be true, as we are printing the output
+        opt.logStart ??= opt.log;
+        opt.logFinish ??= opt.log;
+        const started = Date.now();
+        this.logStart(cmd, opt);
+        await new Promise((resolve, reject) => {
+            const p = node_child_process_1.default.spawn(cmd, opt.args || [], {
+                shell,
+                cwd,
+                stdio: 'inherit',
+                env: {
+                    ...(passProcessEnv ? process.env : {}),
+                    ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+                    ...env,
+                },
+            });
+            p.on('close', code => {
+                const isSuccessful = !code;
+                this.logFinish(cmd, opt, started, isSuccessful);
+                if (code) {
+                    return reject(new Error(`spawnAsync exited with code ${code}: ${cmd}`));
+                }
+                resolve();
+            });
+        });
+    }
+    /**
+     * Advanced/async version of Spawn.
+     * Consider simpler `spawn` or `exec` first, which are also sync.
+     *
+     * spawnAsyncAndReturn features:
+     *
+     * 1. Async
+     * 2. Allows to collect the output AND print it while running.
+     * 3. Returns SpawnOutput with stdout, stderr and exitCode.
+     * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
+     *
+     * Defaults:
+     *
+     * shell: true
+     * printWhileRunning: true
+     * collectOutputWhileRunning: true
+     * throwOnNonZeroCode: true
+     * log: true
+     */
+    async spawnAsyncAndReturn(cmd, opt = {}) {
+        const { shell = true, printWhileRunning = true, collectOutputWhileRunning = true, throwOnNonZeroCode = true, cwd, env, passProcessEnv = true, forceColor = colors_1.hasColors, } = opt;
+        opt.log ??= printWhileRunning; // by default log should be true, as we are printing the output
+        opt.logStart ??= opt.log;
+        opt.logFinish ??= opt.log;
+        const started = Date.now();
+        this.logStart(cmd, opt);
+        let stdout = '';
+        let stderr = '';
+        return await new Promise((resolve, reject) => {
+            const p = node_child_process_1.default.spawn(cmd, opt.args || [], {
+                shell,
+                cwd,
+                env: {
+                    ...(passProcessEnv ? process.env : {}),
+                    ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+                    ...env,
+                },
+            });
+            p.stdout.on('data', data => {
+                if (collectOutputWhileRunning) {
+                    stdout += data.toString();
+                    // console.log('stdout:', data.toString())
+                }
+                if (printWhileRunning) {
+                    process.stdout.write(data);
+                    // console.log('stderr:', data.toString())
+                }
+            });
+            p.stderr.on('data', data => {
+                if (collectOutputWhileRunning) {
+                    stderr += data.toString();
+                }
+                if (printWhileRunning) {
+                    process.stderr.write(data);
+                }
+            });
+            p.on('close', code => {
+                const isSuccessful = !code;
+                this.logFinish(cmd, opt, started, isSuccessful);
+                const exitCode = code || 0;
+                const o = {
+                    exitCode,
+                    stdout: stdout.trim(),
+                    stderr: stderr.trim(),
+                };
+                if (throwOnNonZeroCode && code) {
+                    return reject(new SpawnError(`spawnAsyncAndReturn exited with code ${code}: ${cmd}`, o));
+                }
+                resolve(o);
+            });
+        });
     }
     logStart(cmd, opt) {
-        if (!opt.logStart && !opt.log)
+        if (!opt.logStart)
             return;
         console.log([
             (0, colors_1.dimGrey)(...Object.entries(opt.env || {}).map(([k, v]) => [k, v].join('='))),
@@ -206,7 +244,7 @@ class Exec2 {
             .join(' '));
     }
     logFinish(cmd, opt, started, isSuccessful) {
-        if (isSuccessful && !opt.logFinish && !opt.log)
+        if (isSuccessful && !opt.logFinish)
             return;
         console.log([
             (0, colors_1.white)(opt.name || cmd),

package/package.json CHANGED Viewed

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

package/src/util/exec2.ts CHANGED Viewed

@@ -17,7 +17,7 @@ import { dimGrey, dimRed, hasColors, white } from '../colors/colors'
  *
  * Short-running job, no need to print the output, might want to return the output - use Exec.
  *
- * Need to both print and return the output - use SpawnAsync.
+ * Need to both print and return the output - use SpawnAsyncAndReturn.
  *
  * ***
  *
@@ -31,99 +31,13 @@ import { dimGrey, dimRed, hasColors, white } from '../colors/colors'
  * Exec always uses the shell (there's no option to disable it).
  */
 class Exec2 {
-  /**
-   * Advanced/async version of Spawn.
-   * Consider simpler `spawn` or `exec` first, which are also sync.
-   *
-   * spawnAsync features:
-   *
-   * 1. Async
-   * 2. Allows to collect the output AND print it while running.
-   * 3. Returns SpawnOutput with stdout, stderr and exitCode.
-   * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
-   *
-   * Defaults:
-   *
-   * shell: true
-   * printWhileRunning: true
-   * collectOutputWhileRunning: true
-   * throwOnNonZeroCode: true
-   * log: true
-   */
-  async spawnAsync(cmd: string, opt: SpawnAsyncOptions = {}): Promise<SpawnOutput> {
-    const {
-      shell = true,
-      printWhileRunning = true,
-      collectOutputWhileRunning = true,
-      throwOnNonZeroCode = true,
-      cwd,
-      env,
-      passProcessEnv = true,
-      forceColor = hasColors,
-    } = opt
-    opt.log ??= printWhileRunning // by default log should be true, as we are printing the output
-    const started = Date.now()
-    this.logStart(cmd, 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: {
-          ...(passProcessEnv ? process.env : {}),
-          ...(forceColor ? { FORCE_COLOR: '1' } : {}),
-          ...env,
-        },
-      })
-      p.stdout.on('data', data => {
-        if (collectOutputWhileRunning) {
-          stdout += data.toString()
-          // console.log('stdout:', data.toString())
-        }
-        if (printWhileRunning) {
-          process.stdout.write(data)
-          // console.log('stderr:', data.toString())
-        }
-      })
-      p.stderr.on('data', data => {
-        if (collectOutputWhileRunning) {
-          stderr += data.toString()
-        }
-        if (printWhileRunning) {
-          process.stderr.write(data)
-        }
-      })
-      p.on('close', code => {
-        // 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,
-          stdout: stdout.trim(),
-          stderr: stderr.trim(),
-        }
-        if (throwOnNonZeroCode && code) {
-          return reject(new SpawnError(`spawnAsync exited with code ${code}: ${cmd}`, o))
-        }
-        resolve(o)
-      })
-    })
-  }
   /**
    * Reasons to use it:
    * - Sync
    * - Need to print output while running
    *
    * Limitations:
-   * - Cannot return stdout/stderr (use exec or spawnAsync for that)
+   * - Cannot return stdout/stderr (use exec, execAsync or spawnAsyncAndReturn for that)
    *
    * Defaults:
    *
@@ -133,9 +47,10 @@ class Exec2 {
   spawn(cmd: string, opt: SpawnOptions = {}): void {
     const { shell = true, cwd, env, passProcessEnv = true, forceColor = hasColors } = opt
     opt.log ??= true // by default log should be true, as we are printing the output
+    opt.logStart ??= opt.log
+    opt.logFinish ??= opt.log
     const started = Date.now()
     this.logStart(cmd, opt)
-    // console.log('') // 1-line padding before the output
     const r = cp.spawnSync(cmd, opt.args, {
       encoding: 'utf8',
@@ -149,7 +64,6 @@ class Exec2 {
       },
     })
-    // console.log('') // 1-line padding after the output
     const isSuccessful = !r.error && !r.status
     this.logFinish(cmd, opt, started, isSuccessful)
@@ -173,12 +87,14 @@ class Exec2 {
    * Defaults:
    *
    * shell: true
-   * log: true
+   * log: false
    */
   exec(cmd: string, opt: ExecOptions = {}): string {
+    const { cwd, env, passProcessEnv = true, timeout } = opt
+    opt.logStart ??= opt.log ?? false
+    opt.logFinish ??= opt.log ?? false
     const started = Date.now()
     this.logStart(cmd, opt)
-    const { cwd, env, passProcessEnv = true, timeout } = opt
     try {
       const s = cp
@@ -212,14 +128,137 @@ class Exec2 {
     }
   }
-  throwOnNonZeroExitCode(o: SpawnOutput): void {
-    if (o.exitCode) {
-      throw new SpawnError(`spawn exited with code ${o.exitCode}`, o)
-    }
+  /**
+   * Reasons to use it:
+   * - Async
+   * - Need to print output while running
+   *
+   * Limitations:
+   * - Cannot return stdout/stderr (use execAsync or spawnAsyncAndReturn for that)
+   *
+   * Defaults:
+   *
+   * shell: true
+   * log: true
+   */
+  async spawnAsync(cmd: string, opt: SpawnOptions = {}): Promise<void> {
+    const { shell = true, cwd, env, passProcessEnv = true, forceColor = hasColors } = opt
+    opt.log ??= true // by default log should be true, as we are printing the output
+    opt.logStart ??= opt.log
+    opt.logFinish ??= opt.log
+    const started = Date.now()
+    this.logStart(cmd, opt)
+    await new Promise<void>((resolve, reject) => {
+      const p = cp.spawn(cmd, opt.args || [], {
+        shell,
+        cwd,
+        stdio: 'inherit',
+        env: {
+          ...(passProcessEnv ? process.env : {}),
+          ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+          ...env,
+        },
+      })
+      p.on('close', code => {
+        const isSuccessful = !code
+        this.logFinish(cmd, opt, started, isSuccessful)
+        if (code) {
+          return reject(new Error(`spawnAsync exited with code ${code}: ${cmd}`))
+        }
+        resolve()
+      })
+    })
+  }
+  /**
+   * Advanced/async version of Spawn.
+   * Consider simpler `spawn` or `exec` first, which are also sync.
+   *
+   * spawnAsyncAndReturn features:
+   *
+   * 1. Async
+   * 2. Allows to collect the output AND print it while running.
+   * 3. Returns SpawnOutput with stdout, stderr and exitCode.
+   * 4. Allows to not throw on error, but just return SpawnOutput for further inspection.
+   *
+   * Defaults:
+   *
+   * shell: true
+   * printWhileRunning: true
+   * collectOutputWhileRunning: true
+   * throwOnNonZeroCode: true
+   * log: true
+   */
+  async spawnAsyncAndReturn(cmd: string, opt: SpawnAsyncOptions = {}): Promise<SpawnOutput> {
+    const {
+      shell = true,
+      printWhileRunning = true,
+      collectOutputWhileRunning = true,
+      throwOnNonZeroCode = true,
+      cwd,
+      env,
+      passProcessEnv = true,
+      forceColor = hasColors,
+    } = opt
+    opt.log ??= printWhileRunning // by default log should be true, as we are printing the output
+    opt.logStart ??= opt.log
+    opt.logFinish ??= opt.log
+    const started = Date.now()
+    this.logStart(cmd, opt)
+    let stdout = ''
+    let stderr = ''
+    return await new Promise<SpawnOutput>((resolve, reject) => {
+      const p = cp.spawn(cmd, opt.args || [], {
+        shell,
+        cwd,
+        env: {
+          ...(passProcessEnv ? process.env : {}),
+          ...(forceColor ? { FORCE_COLOR: '1' } : {}),
+          ...env,
+        },
+      })
+      p.stdout.on('data', data => {
+        if (collectOutputWhileRunning) {
+          stdout += data.toString()
+          // console.log('stdout:', data.toString())
+        }
+        if (printWhileRunning) {
+          process.stdout.write(data)
+          // console.log('stderr:', data.toString())
+        }
+      })
+      p.stderr.on('data', data => {
+        if (collectOutputWhileRunning) {
+          stderr += data.toString()
+        }
+        if (printWhileRunning) {
+          process.stderr.write(data)
+        }
+      })
+      p.on('close', code => {
+        const isSuccessful = !code
+        this.logFinish(cmd, opt, started, isSuccessful)
+        const exitCode = code || 0
+        const o: SpawnOutput = {
+          exitCode,
+          stdout: stdout.trim(),
+          stderr: stderr.trim(),
+        }
+        if (throwOnNonZeroCode && code) {
+          return reject(new SpawnError(`spawnAsyncAndReturn exited with code ${code}: ${cmd}`, o))
+        }
+        resolve(o)
+      })
+    })
   }
   private logStart(cmd: string, opt: SpawnOptions | ExecOptions): void {
-    if (!opt.logStart && !opt.log) return
+    if (!opt.logStart) return
     console.log(
       [
@@ -238,7 +277,7 @@ class Exec2 {
     started: UnixTimestampMillisNumber,
     isSuccessful: boolean,
   ): void {
-    if (isSuccessful && !opt.logFinish && !opt.log) return
+    if (isSuccessful && !opt.logFinish) return
     console.log(
       [