@sap-ux/nodejs-utils 0.2.1 → 0.2.2

package/dist/commandRunner.d.ts

@@ -1,4 +1,5 @@
 import { type SpawnOptionsWithoutStdio } from 'child_process';
+import type { Logger } from '@sap-ux/logger';
 /**
  *
  */
@@ -9,9 +10,10 @@ export declare class CommandRunner {
      * @param {string} cmd to execute
      * @param {string[]} args to pass to the command
      * @param {SpawnOptionsWithoutStdio} [opts] options to pass to the command
+     * @param {Logger} [logger] optional logger to capture command output
      * @returns {*}  {(Promise<any | void>)}
      * @memberof CommandRunner
      */
-    run(cmd: string, args?: string[], opts?: SpawnOptionsWithoutStdio): Promise<string | void>;
+    run(cmd: string, args?: string[], opts?: SpawnOptionsWithoutStdio, logger?: Logger): Promise<string | void>;
 }
 //# sourceMappingURL=commandRunner.d.ts.map

package/dist/commandRunner.js

@@ -12,10 +12,14 @@ class CommandRunner {
      * @param {string} cmd to execute
      * @param {string[]} args to pass to the command
      * @param {SpawnOptionsWithoutStdio} [opts] options to pass to the command
+     * @param {Logger} [logger] optional logger to capture command output
      * @returns {*}  {(Promise<any | void>)}
      * @memberof CommandRunner
      */
-    run(cmd, args = [], opts = {}) {
+    run(cmd, args = [], opts = {}, logger) {
+        if (logger) {
+            logger.debug(`Running command: ${cmd} ${args.join(' ')}`);
+        }
         return new Promise((resolve, reject) => {
             const stack = [];
             const spawnOpts = process.platform === 'win32' ? { ...opts, shell: true } : opts;
@@ -23,17 +27,23 @@ class CommandRunner {
             spawnedCmd.stdout.setEncoding('utf8');
             let response;
             spawnedCmd.stdout.on('data', (data) => {
+                logger?.info(data.toString().replace(/[\r\n]$/, '')); // remove trailing newline as another is added by the logger
                 response = data.toString();
             });
             spawnedCmd.stderr.on('data', (data) => {
+                logger?.info(data.toString().replace(/[\r\n]$/, '')); // remove trailing newline as another is added by the logger
                 stack.push(data.toString());
             });
             spawnedCmd.on('error', (error) => {
-                reject(`Command failed with error: ${error.message}`);
+                const cmdFailedMsg = `Command failed with error: ${error.message}`;
+                logger?.error(cmdFailedMsg);
+                reject(error);
             });
             spawnedCmd.on('close', (errorCode) => {
                 if (errorCode !== 0) {
-                    reject(`Command failed, \`${cmd} ${args.join(' ')}\`, ${stack.join(', ')}`);
+                    const cmdFailedMsg = `Command failed, \`${cmd} ${args.join(' ')}\`, ${stack.join(', ')}`;
+                    logger?.debug(cmdFailedMsg);
+                    reject(cmdFailedMsg);
                 }
                 resolve(response);
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/nodejs-utils",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Nodejs utility wrappers",
   "repository": {
     "type": "git",
@@ -22,7 +22,8 @@
   "devDependencies": {
     "@types/semver": "7.5.2",
     "@types/vscode": "1.73.1",
-    "mock-spawn": "0.2.6"
+    "mock-spawn": "0.2.6",
+    "@sap-ux/logger": "0.7.0"
   },
   "files": [
     "dist",