visual-exec 1.0.2 → 1.1.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { VisualExec, VisualExecOptions, ExecOutput, ExecErrorContext, VisualExecError, parsers, jsonLinesParser, keyValueParser } from "./visual-exec.js";
+export { VisualExec, type VisualExecOptions, type ExecOutput, type ExecErrorContext, type VisualExecError, parsers, jsonLinesParser, keyValueParser } from "./visual-exec.js";
 export type { OnOutputCallback, OnCompleteCallback, OutputFileOptions, ProgressExtractor, OutputMatcher } from "./visual-exec.js";
 export { getDefaultLogger } from "./get-default-logger.js";
 export { VisualExec as default } from "./visual-exec.js";

package/dist/visual-exec.d.ts

@@ -1,4 +1,4 @@
-import VisualLogger from "visual-logger";
+import VisualLogger, { type ItemOptions } from "visual-logger";
 export type OutputStream = "stdout" | "stderr";
 /** Called on each chunk of stdout/stderr during execution */
 export type OnOutputCallback = (data: string, stream: OutputStream) => void;
@@ -40,7 +40,7 @@ export interface VisualExecOptions {
     /** Visual logger instance to use */
     visualLogger?: VisualLogger;
     /** Spinner style to use */
-    spinner?: any;
+    spinner?: ItemOptions["spinner"];
     /** Title displayed during execution */
     displayTitle?: string;
     /** Label used in log messages */
@@ -192,7 +192,14 @@ export declare class VisualExec {
     abort(signal?: string): void;
     /** Alias for abort() */
     kill(signal?: string): void;
-    show(child: ChildProcess): Promise<ExecOutput | unknown>;
+    /**
+     * Attach to an already-started child and render its output.
+     *
+     * Resolves with the command's `ExecOutput`, unless an `onComplete` callback returned a
+     * value - that value is passed through instead. `T` names what the caller expects back;
+     * it defaults to `ExecOutput`, which is what a run without an `onComplete` produces.
+     */
+    show<T = ExecOutput>(child: ChildProcess): Promise<T>;
     logResult(err: VisualExecError | null, output?: ExecOutput): void;
     checkForErrors(text: string): RegExpMatchArray | null;
     /**
@@ -200,6 +207,12 @@ export declare class VisualExec {
      * Set to a no-op function to suppress output logging.
      */
     logFinalOutput(err: VisualExecError | null, output: ExecOutput): void;
-    execute(command?: string): Promise<ExecOutput | unknown>;
+    /**
+     * Run the command and render its output.
+     *
+     * Resolves with `ExecOutput`, or with whatever an `onComplete` callback returned in its
+     * place. `T` defaults to `ExecOutput` so the common case needs no cast at the call site.
+     */
+    execute<T = ExecOutput>(command?: string): Promise<T>;
 }
 export default VisualExec;

package/dist/visual-exec.js

@@ -3,7 +3,7 @@ import chalk from "chalk";
 import * as fs from "fs";
 import * as path from "path";
 import { getDefaultLogger } from "./get-default-logger.js";
-import VisualLogger from "visual-logger";
+import VisualLogger, {} from "visual-logger";
 import hasAnsi from "has-ansi";
 import stripAnsi from "strip-ansi";
 // Set xsh to use native Promise
@@ -294,6 +294,13 @@ export class VisualExec {
     kill(signal) {
         this.abort(signal);
     }
+    /**
+     * Attach to an already-started child and render its output.
+     *
+     * Resolves with the command's `ExecOutput`, unless an `onComplete` callback returned a
+     * value - that value is passed through instead. `T` names what the caller expects back;
+     * it defaults to `ExecOutput`, which is what a run without an `onComplete` produces.
+     */
     show(child) {
         this._stdoutKey = Symbol("visual-exec-stdout");
         this._stderrKey = Symbol("visual-exec-stderr");
@@ -336,10 +343,11 @@ export class VisualExec {
         const startTime = Date.now();
         let execPromise = child.promise
             .catch((err) => {
-            var _a, _b, _c, _d;
-            const output = (_a = err.output) !== null && _a !== void 0 ? _a : { stdout: "", stderr: "" };
-            const exitCode = (_c = (_b = err.exitCode) !== null && _b !== void 0 ? _b : err.code) !== null && _c !== void 0 ? _c : 1;
-            (_d = this._onComplete) === null || _d === void 0 ? void 0 : _d.call(this, output, exitCode);
+            var _a;
+            var _b, _c, _d;
+            const output = (_b = err.output) !== null && _b !== void 0 ? _b : { stdout: "", stderr: "" };
+            const exitCode = (_d = (_c = err.exitCode) !== null && _c !== void 0 ? _c : err.code) !== null && _d !== void 0 ? _d : 1;
+            (_a = this._onComplete) === null || _a === void 0 ? void 0 : _a.call(this, output, exitCode);
             this.logResult(err);
             throw err;
         })
@@ -418,6 +426,8 @@ export class VisualExec {
             });
             execPromise = Promise.race([execPromise, abortPromise]);
         }
+        // The runtime value is `ExecOutput` unless `onComplete` substituted its own; only the
+        // caller knows which, so the promise is handed back as the `T` they asked for.
         return execPromise.finally(cleanup);
     }
     logResult(err, output) {
@@ -475,6 +485,12 @@ export class VisualExec {
         logs.push(chalk.blue("\n<<<"), `End of output from ${this._outputLabel} ---`);
         this._logger.prefix(false)[level](...logs);
     }
+    /**
+     * Run the command and render its output.
+     *
+     * Resolves with `ExecOutput`, or with whatever an `onComplete` callback returned in its
+     * place. `T` defaults to `ExecOutput` so the common case needs no cast at the call site.
+     */
     execute(command) {
         this._startTime = Date.now();
         this._aborted = false;
@@ -492,22 +508,20 @@ export class VisualExec {
             child: result.child
         };
         const duration = () => Date.now() - this._startTime;
-        const baseContext = (output) => {
-            var _a, _b, _c, _d;
-            return ({
-                command: cmd,
-                cwd: this._cwd,
-                duration: duration(),
-                stdout: (_a = output === null || output === void 0 ? void 0 : output.stdout) !== null && _a !== void 0 ? _a : "",
-                stderr: (_b = output === null || output === void 0 ? void 0 : output.stderr) !== null && _b !== void 0 ? _b : "",
-                lastLines: lastLines([...((_c = output === null || output === void 0 ? void 0 : output.stdout) !== null && _c !== void 0 ? _c : "").split("\n"), ...((_d = output === null || output === void 0 ? void 0 : output.stderr) !== null && _d !== void 0 ? _d : "").split("\n")].join("\n"), DEFAULT_LAST_LINES)
-            });
-        };
+        const baseContext = (output) => { var _a, _b, _c, _d; return ({
+            command: cmd,
+            cwd: this._cwd,
+            duration: duration(),
+            stdout: (_a = output === null || output === void 0 ? void 0 : output.stdout) !== null && _a !== void 0 ? _a : "",
+            stderr: (_b = output === null || output === void 0 ? void 0 : output.stderr) !== null && _b !== void 0 ? _b : "",
+            lastLines: lastLines([...((_c = output === null || output === void 0 ? void 0 : output.stdout) !== null && _c !== void 0 ? _c : "").split("\n"), ...((_d = output === null || output === void 0 ? void 0 : output.stderr) !== null && _d !== void 0 ? _d : "").split("\n")].join("\n"), DEFAULT_LAST_LINES)
+        }); };
         child.promise = child.promise.catch((err) => {
-            var _a, _b, _c, _d, _e;
-            const output = (_a = err.output) !== null && _a !== void 0 ? _a : { stdout: "", stderr: "" };
-            const exitCode = (_b = err.code) !== null && _b !== void 0 ? _b : 1;
-            const signal = (_e = (_c = err.signal) !== null && _c !== void 0 ? _c : (((_d = result.child) === null || _d === void 0 ? void 0 : _d.killed) ? "SIGTERM" : null)) !== null && _e !== void 0 ? _e : null;
+            var _a;
+            var _b, _c, _d, _e;
+            const output = (_b = err.output) !== null && _b !== void 0 ? _b : { stdout: "", stderr: "" };
+            const exitCode = (_c = err.code) !== null && _c !== void 0 ? _c : 1;
+            const signal = (_e = (_d = err.signal) !== null && _d !== void 0 ? _d : (((_a = result.child) === null || _a === void 0 ? void 0 : _a.killed) ? "SIGTERM" : null)) !== null && _e !== void 0 ? _e : null;
             const context = {
                 ...baseContext(output),
                 exitCode,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "visual-exec",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "homepage": "https://github.com/jchip/fynjs/tree/main/packages/visual-exec",
   "description": "Visual shell exec with spinners and progress display",
   "type": "module",
@@ -14,12 +14,12 @@
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=22.12.0"
+    "node": ">=22.18.0"
   },
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.json",
     "test": "vitest run",
-    "ci:check": "tsc --noEmit -p tsconfig.json && npm test",
+    "ci:check": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json && npm test",
     "test:watch": "vitest",
     "prepublishOnly": "xrun --serial build test",
     "postpack": "publish-util-postpack"
@@ -49,8 +49,8 @@
     "ci-info": "^4.4.0",
     "has-ansi": "^6.0.2",
     "strip-ansi": "^7.2.0",
-    "visual-logger": "^2.0.1",
-    "xsh": "^1.0.1"
+    "visual-logger": "^2.1.1",
+    "xsh": "^1.1.0"
   },
   "sideEffects": false
 }