visual-exec 0.1.13 → 0.2.0

package/dist/get-default-logger.d.ts

@@ -0,0 +1,4 @@
+import VisualLogger from "visual-logger";
+export declare function getDefaultLogger(): VisualLogger;
+export default getDefaultLogger;
+//# sourceMappingURL=get-default-logger.d.ts.map

package/dist/get-default-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-default-logger.d.ts","sourceRoot":"","sources":["../src/get-default-logger.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAKzC,wBAAgB,gBAAgB,IAAI,YAAY,CAU/C;AAED,eAAe,gBAAgB,CAAC"}

package/dist/get-default-logger.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultLogger = getDefaultLogger;
+const visual_logger_1 = __importDefault(require("visual-logger"));
+const ci_info_1 = require("ci-info");
+let logger = null;
+function getDefaultLogger() {
+    if (!logger) {
+        logger = new visual_logger_1.default();
+        if (ci_info_1.isCI) {
+            logger.info("visual-exec: CI env detected");
+            logger.setItemType("none");
+        }
+    }
+    return logger;
+}
+exports.default = getDefaultLogger;
+//# sourceMappingURL=get-default-logger.js.map

package/dist/get-default-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-default-logger.js","sourceRoot":"","sources":["../src/get-default-logger.ts"],"names":[],"mappings":";;;;;AAKA,4CAUC;AAfD,kEAAyC;AACzC,qCAA+B;AAE/B,IAAI,MAAM,GAAwB,IAAI,CAAC;AAEvC,SAAgB,gBAAgB;IAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,GAAG,IAAI,uBAAY,EAAE,CAAC;QAE5B,IAAI,cAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;YAC5C,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,kBAAe,gBAAgB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { VisualExec, VisualExecOptions } from "./visual-exec";
+export { getDefaultLogger } from "./get-default-logger";
+export { VisualExec as default } from "./visual-exec";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,UAAU,IAAI,OAAO,EAAE,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = exports.getDefaultLogger = exports.VisualExec = void 0;
+var visual_exec_1 = require("./visual-exec");
+Object.defineProperty(exports, "VisualExec", { enumerable: true, get: function () { return visual_exec_1.VisualExec; } });
+var get_default_logger_1 = require("./get-default-logger");
+Object.defineProperty(exports, "getDefaultLogger", { enumerable: true, get: function () { return get_default_logger_1.getDefaultLogger; } });
+var visual_exec_2 = require("./visual-exec");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return visual_exec_2.VisualExec; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAA8D;AAArD,yGAAA,UAAU,OAAA;AACnB,2DAAwD;AAA/C,sHAAA,gBAAgB,OAAA;AACzB,6CAAsD;AAA7C,sGAAA,UAAU,OAAW"}

package/dist/visual-exec.d.ts

@@ -0,0 +1,70 @@
+import VisualLogger from "visual-logger";
+export interface VisualExecOptions {
+    /** The command to execute */
+    command: string;
+    /** Working directory for the command */
+    cwd?: string;
+    /** Visual logger instance to use */
+    visualLogger?: VisualLogger;
+    /** Spinner style to use */
+    spinner?: any;
+    /** Title displayed during execution */
+    displayTitle?: string;
+    /** Label used in log messages */
+    logLabel?: string;
+    /** Label used in output messages */
+    outputLabel?: string;
+    /** Log level for output (default: "verbose") */
+    outputLevel?: string;
+    /** Maximum buffer size for stdout/stderr (default: 10MB) */
+    maxBuffer?: number;
+    /** Force stderr output to be logged as error (default: true) */
+    forceStderr?: boolean;
+    /** Regex or boolean to check stdout for error patterns (default: true) */
+    checkStdoutError?: boolean | RegExp;
+}
+interface ExecOutput {
+    stdout: string;
+    stderr: string;
+}
+interface ExecError extends Error {
+    output?: ExecOutput;
+}
+interface ChildProcess {
+    stdout: NodeJS.ReadableStream;
+    stderr: NodeJS.ReadableStream;
+    promise: Promise<ExecOutput>;
+}
+export declare class VisualExec {
+    private _title;
+    private _logLabel;
+    private _outputLabel;
+    private _command;
+    private _cwd;
+    private _logger;
+    private _outputLevel;
+    private _spinner;
+    private _maxBuffer;
+    private _forceStderr;
+    private _checkStdoutError;
+    private _startTime;
+    private _stdoutKey?;
+    private _stderrKey?;
+    private _updateStdout?;
+    private _updateStderr?;
+    private _child?;
+    constructor(options: VisualExecOptions);
+    private _makeTitle;
+    private _updateDigest;
+    show(child: ChildProcess): Promise<ExecOutput>;
+    logResult(err: ExecError | null, output?: ExecOutput): void;
+    checkForErrors(text: string): RegExpMatchArray | null;
+    /**
+     * Log the final output. Can be overridden to customize output handling.
+     * Set to a no-op function to suppress output logging.
+     */
+    logFinalOutput(err: ExecError | null, output: ExecOutput): void;
+    execute(command?: string): Promise<ExecOutput>;
+}
+export default VisualExec;
+//# sourceMappingURL=visual-exec.d.ts.map

package/dist/visual-exec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visual-exec.d.ts","sourceRoot":"","sources":["../src/visual-exec.ts"],"names":[],"mappings":"AAGA,OAAO,YAAY,MAAM,eAAe,CAAC;AAUzC,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,2BAA2B;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,uCAAuC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gEAAgE;IAChE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CACrC;AAOD,UAAU,UAAU;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,SAAU,SAAQ,KAAK;IAC/B,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB;AAED,UAAU,YAAY;IACpB,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAM;IACtB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,iBAAiB,CAAmB;IAC5C,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,aAAa,CAAC,CAAwB;IAC9C,OAAO,CAAC,aAAa,CAAC,CAAwB;IAC9C,OAAO,CAAC,MAAM,CAAC,CAAe;gBAElB,OAAO,EAAE,iBAAiB;IAgCtC,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,aAAa;IAmDrB,IAAI,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAsC9C,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,UAAU,GAAG,IAAI;IAoB3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI;IAQrD;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IA2B/D,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAc/C;AAED,eAAe,UAAU,CAAC"}

package/dist/visual-exec.js

@@ -0,0 +1,179 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualExec = void 0;
+const xsh_1 = __importDefault(require("xsh"));
+const chalk_1 = __importDefault(require("chalk"));
+const get_default_logger_1 = require("./get-default-logger");
+const visual_logger_1 = __importDefault(require("visual-logger"));
+const has_ansi_1 = __importDefault(require("has-ansi"));
+const strip_ansi_1 = __importDefault(require("strip-ansi"));
+// Set xsh to use native Promise
+xsh_1.default.Promise = Promise;
+const ONE_MB = 1024 * 1024;
+const TEN_MB = 10 * ONE_MB;
+class VisualExec {
+    constructor(options) {
+        const { command, cwd = process.cwd(), visualLogger, spinner = visual_logger_1.default.spinners[1], displayTitle, logLabel, outputLabel, outputLevel = "verbose", maxBuffer = TEN_MB, forceStderr = true, checkStdoutError = true } = options;
+        this._title = displayTitle || this._makeTitle(command);
+        this._logLabel = logLabel || this._title;
+        this._outputLabel = outputLabel || this._title;
+        this._command = command;
+        this._cwd = cwd || process.cwd();
+        this._logger = visualLogger || (0, get_default_logger_1.getDefaultLogger)();
+        this._outputLevel = outputLevel;
+        this._spinner = spinner;
+        this._maxBuffer = maxBuffer;
+        this._forceStderr = forceStderr;
+        this._checkStdoutError =
+            checkStdoutError === true
+                ? /error|warn|fatal|unhandled|reject|exception|failure|fail|failed/i
+                : checkStdoutError;
+        this._startTime = Date.now();
+    }
+    _makeTitle(command) {
+        if (typeof command !== "string") {
+            command = "user command";
+        }
+        return `Running ${command}`;
+    }
+    _updateDigest(item, buf) {
+        const newBuf = item.buf + buf;
+        const lines = newBuf
+            .split("\n")
+            .map(x => x && x.trim())
+            .filter(x => x);
+        const stripLines = lines.map(x => ((0, has_ansi_1.default)(x) ? (0, strip_ansi_1.default)(x) : x));
+        let length = 0;
+        // gather as many lines from the end as possible that will fit in a single line, using
+        // strings without ansi code to get real length
+        let ix = stripLines.length - 1;
+        for (; ix >= 0; ix--) {
+            const line = stripLines[ix];
+            if (line) {
+                if (length + line.length < 100) {
+                    length += line.length;
+                }
+                else {
+                    break;
+                }
+            }
+        }
+        let msgs = ix >= 0 ? lines.slice(ix + 1) : lines;
+        if (msgs.length === 0) {
+            // even the last line is too long, save it, and display last line as is
+            item.buf = lines[lines.length - 1] || "";
+            // set some reasonable limit to avoid visual digest getting clobberred
+            if (item.buf.length > 120) {
+                // truncate stripped line only to avoid breaking ansi code
+                item.buf = stripLines[stripLines.length - 1].substr(0, 100);
+            }
+            msgs = [item.buf];
+        }
+        else {
+            item.buf = msgs.join("\n");
+        }
+        if (buf.endsWith("\n")) {
+            item.buf += "\n";
+        }
+        this._logger.updateItem(item.name, {
+            msg: msgs.join(chalk_1.default.blue.inverse("\\n")),
+            _save: false,
+            _render: false
+        });
+    }
+    show(child) {
+        this._stdoutKey = Symbol("visual-exec-stdout");
+        this._stderrKey = Symbol("visual-exec-stderr");
+        this._logger.addItem({
+            name: this._stdoutKey,
+            color: "green",
+            display: `=== ${this._title}\nstdout`,
+            spinner: this._spinner
+        });
+        this._logger.addItem({
+            name: this._stderrKey,
+            color: "red",
+            display: `stderr`
+        });
+        const stdoutDigest = { name: this._stdoutKey, buf: "" };
+        const stderrDigest = { name: this._stderrKey, buf: "" };
+        this._updateStdout = (buf) => this._updateDigest(stdoutDigest, buf);
+        this._updateStderr = (buf) => this._updateDigest(stderrDigest, buf);
+        child.stdout.on("data", this._updateStdout);
+        child.stderr.on("data", this._updateStderr);
+        this._child = child;
+        return child.promise
+            .catch((err) => {
+            this.logResult(err);
+            throw err;
+        })
+            .then((output) => {
+            this.logResult(null, output);
+            return output;
+        });
+    }
+    logResult(err, output) {
+        const child = this._child;
+        this._logger.removeItem(this._stdoutKey);
+        this._logger.removeItem(this._stderrKey);
+        child.stdout.removeListener("data", this._updateStdout);
+        child.stderr.removeListener("data", this._updateStderr);
+        if (err) {
+            this._logger.error(`${chalk_1.default.red("Failed")} ${this._logLabel} - ${chalk_1.default.red(err.message)}`);
+            output = err.output;
+        }
+        else {
+            const time = ((Date.now() - this._startTime) / 1000).toFixed(2);
+            const dispTime = `${chalk_1.default.magenta(time)}secs`;
+            this._logger.info(`Done ${this._logLabel} ${dispTime} ${chalk_1.default.green("exit code 0")}`);
+        }
+        this.logFinalOutput(err, output);
+    }
+    checkForErrors(text) {
+        if (!this._checkStdoutError || !text)
+            return null;
+        if (this._checkStdoutError instanceof RegExp) {
+            return text.match(this._checkStdoutError);
+        }
+        return null;
+    }
+    /**
+     * Log the final output. Can be overridden to customize output handling.
+     * Set to a no-op function to suppress output logging.
+     */
+    logFinalOutput(err, output) {
+        const level = err || (this._forceStderr && output?.stderr) || this.checkForErrors(output?.stdout || "")
+            ? "error"
+            : this._outputLevel;
+        if (!output || (!output.stdout && !output.stderr)) {
+            this._logger[level](`${chalk_1.default.green("No output")} from ${this._outputLabel}`);
+            return;
+        }
+        const colorize = (t) => t.replace(/ERR!/g, chalk_1.default.red("ERR!"));
+        const logs = [chalk_1.default.green(">>>"), `Start of output from ${this._outputLabel} ===`];
+        if (output.stdout) {
+            logs.push(`\n${colorize(output.stdout)}`);
+        }
+        if (output.stderr) {
+            logs.push(chalk_1.default.red("\n=== stderr ===\n") + colorize(output.stderr));
+        }
+        logs.push(chalk_1.default.blue("\n<<<"), `End of output from ${this._outputLabel} ---`);
+        this._logger.prefix(false)[level](...logs);
+    }
+    execute(command) {
+        this._startTime = Date.now();
+        const child = xsh_1.default.exec({
+            silent: true,
+            cwd: this._cwd,
+            env: Object.assign({}, process.env, { PWD: this._cwd }),
+            maxBuffer: this._maxBuffer
+        }, command || this._command);
+        return this.show(child);
+    }
+}
+exports.VisualExec = VisualExec;
+exports.default = VisualExec;
+//# sourceMappingURL=visual-exec.js.map

package/dist/visual-exec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visual-exec.js","sourceRoot":"","sources":["../src/visual-exec.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAsB;AACtB,kDAA0B;AAC1B,6DAAwD;AACxD,kEAAyC;AACzC,wDAA+B;AAC/B,4DAAmC;AAEnC,gCAAgC;AAC/B,aAAW,CAAC,OAAO,GAAG,OAAO,CAAC;AAE/B,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;AAC3B,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC;AA+C3B,MAAa,UAAU;IAmBrB,YAAY,OAA0B;QACpC,MAAM,EACJ,OAAO,EACP,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,YAAY,EACZ,OAAO,GAAG,uBAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAClC,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,WAAW,GAAG,SAAS,EACvB,SAAS,GAAG,MAAM,EAClB,WAAW,GAAG,IAAI,EAClB,gBAAgB,GAAG,IAAI,EACxB,GAAG,OAAO,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,WAAW,IAAI,IAAI,CAAC,MAAM,CAAC;QAC/C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,YAAY,IAAI,IAAA,qCAAgB,GAAE,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,iBAAiB;YACpB,gBAAgB,KAAK,IAAI;gBACvB,CAAC,CAAC,kEAAkE;gBACpE,CAAC,CAAC,gBAAgB,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/B,CAAC;IAEO,UAAU,CAAC,OAAe;QAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,GAAG,cAAc,CAAC;QAC3B,CAAC;QACD,OAAO,WAAW,OAAO,EAAE,CAAC;IAC9B,CAAC;IAEO,aAAa,CAAC,IAAgB,EAAE,GAAW;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAE9B,MAAM,KAAK,GAAG,MAAM;aACjB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;aACvB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAa,CAAC;QAE9B,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,kBAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,oBAAS,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEnE,IAAI,MAAM,GAAG,CAAC,CAAC;QAEf,sFAAsF;QACtF,+CAA+C;QAC/C,IAAI,EAAE,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/B,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;YAC5B,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC/B,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;gBACxB,CAAC;qBAAM,CAAC;oBACN,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,uEAAuE;YACvE,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACzC,sEAAsE;YACtE,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBAC1B,0DAA0D;gBAC1D,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC9D,CAAC;YACD,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE;YACjC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACzC,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,KAAmB;QACtB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAE/C,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,OAAO,IAAI,CAAC,MAAM,UAAU;YACrC,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,QAAQ;SAClB,CAAC,CAAC;QAEH,MAAM,YAAY,GAAe,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QACpE,MAAM,YAAY,GAAe,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;QACpE,IAAI,CAAC,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAC5E,IAAI,CAAC,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;QAE5E,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC5C,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAE5C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,OAAO,KAAK,CAAC,OAAO;aACjB,KAAK,CAAC,CAAC,GAAc,EAAE,EAAE;YACxB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACpB,MAAM,GAAG,CAAC;QACZ,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,MAAkB,EAAE,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC;IAED,SAAS,CAAC,GAAqB,EAAE,MAAmB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAO,CAAC;QAE3B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;QAC1C,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,aAAc,CAAC,CAAC;QACzD,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,aAAc,CAAC,CAAC;QAEzD,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,eAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,SAAS,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC3F,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChE,MAAM,QAAQ,GAAG,GAAG,eAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;YAC9C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,IAAI,QAAQ,IAAI,eAAK,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,MAAO,CAAC,CAAC;IACpC,CAAC;IAED,cAAc,CAAC,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAClD,IAAI,IAAI,CAAC,iBAAiB,YAAY,MAAM,EAAE,CAAC;YAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,GAAqB,EAAE,MAAkB;QACtD,MAAM,KAAK,GACT,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,MAAM,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,IAAI,EAAE,CAAC;YACvF,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;QAExB,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,OAAe,CAAC,KAAK,CAAC,CAAC,GAAG,eAAK,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;YACtF,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,eAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QAEtE,MAAM,IAAI,GAAa,CAAC,eAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,wBAAwB,IAAI,CAAC,YAAY,MAAM,CAAC,CAAC;QAE7F,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,oBAAoB,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,eAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,IAAI,CAAC,YAAY,MAAM,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,CAAC,OAAgB;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAG,aAAG,CAAC,IAAI,CACpB;YACE,MAAM,EAAE,IAAI;YACZ,GAAG,EAAE,IAAI,CAAC,IAAI;YACd,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;YACvD,SAAS,EAAE,IAAI,CAAC,UAAU;SAC3B,EACD,OAAO,IAAI,IAAI,CAAC,QAAQ,CACzB,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,KAAgC,CAAC,CAAC;IACrD,CAAC;CACF;AA5ND,gCA4NC;AAED,kBAAe,UAAU,CAAC"}

package/package.json

@@ -1,20 +1,29 @@
 {
   "name": "visual-exec",
-  "version": "0.1.13",
-  "description": "Visual shell exec",
-  "main": "lib/visual-exec.js",
-  "scripts": {},
+  "version": "0.2.0",
+  "description": "Visual shell exec with spinners and progress display",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "xrun --serial build test"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jchip/visual-exec.git"
+    "url": "https://github.com/jchip/fynpo.git",
+    "directory": "packages/visual-exec"
   },
   "keywords": [
     "visual",
     "shell",
-    "exec"
+    "exec",
+    "spinner",
+    "progress"
   ],
   "files": [
-    "lib"
+    "dist"
   ],
   "author": "Joel Chen <joel123@gmail.com>",
   "license": "Apache-2.0",
@@ -26,6 +35,12 @@
     "visual-logger": "^1.1.3",
     "xsh": "^0.4.5"
   },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.20.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.9"
+  },
   "prettier": {
     "printWidth": 100,
     "trailingComma": "none",

package/lib/get-default-logger.js

@@ -1,19 +0,0 @@
-"use strict";
-
-const VisualLogger = require("visual-logger");
-const { isCI } = require("ci-info");
-
-let logger;
-const getLogger = () => {
-  if (!logger) {
-    logger = new VisualLogger();
-
-    if (isCI) {
-      logger.info("visual-exec: CI env detected");
-      logger.setItemType("none");
-    }
-  }
-  return logger;
-};
-
-module.exports = getLogger;

package/lib/visual-exec.js

@@ -1,209 +0,0 @@
-"use strict";
-
-/* eslint-disable no-magic-numbers,no-eval,prefer-template */
-
-const xsh = require("xsh");
-const chalk = require("chalk");
-const getDefaultLogger = require("./get-default-logger");
-const VisualLogger = require("visual-logger");
-const hasAnsi = require("has-ansi");
-const stripAnsi = require("strip-ansi");
-
-xsh.Promise = Promise;
-
-const ONE_MB = 1024 * 1024;
-const TEN_MB = 10 * ONE_MB;
-
-class VisualExec {
-  constructor({
-    command,
-    cwd = process.cwd(),
-    visualLogger,
-    spinner = VisualLogger.spinners[1],
-    displayTitle = undefined,
-    logLabel = undefined,
-    outputLabel = undefined,
-    outputLevel = "verbose",
-    maxBuffer = TEN_MB,
-    forceStderr = true,
-    checkStdoutError = true
-  }) {
-    this._title = displayTitle || this._makeTitle(command);
-    this._logLabel = logLabel || this._title;
-    this._outputLabel = outputLabel || this._title;
-    this._command = command;
-    this._cwd = cwd || process.cwd();
-    this._logger = visualLogger || getDefaultLogger();
-    this._outputLevel = outputLevel;
-    this._spinner = spinner;
-    this._maxBuffer = maxBuffer;
-    this._forceStderr = forceStderr;
-    this._checkStdoutError =
-      checkStdoutError === true
-        ? /error|warn|fatal|unhandled|reject|exception|failure|fail|failed/i
-        : checkStdoutError;
-  }
-
-  _makeTitle(command) {
-    if (typeof command !== "string") {
-      command = "user command";
-    }
-
-    return `Running ${command}`;
-  }
-
-  /* eslint-disable max-statements */
-  _updateDigest(item, buf) {
-    const newBuf = item.buf + buf;
-
-    const lines = newBuf
-      .split("\n")
-      .map(x => x && x.trim())
-      .filter(x => x);
-
-    const stripLines = lines.map(x => (hasAnsi(x) ? stripAnsi(x) : x));
-
-    let length = 0;
-
-    // gather as many lines from the end as possible that will fit in a single line, using
-    // strings without ansi code to get real length
-    let ix = stripLines.length - 1;
-    for (; ix >= 0; ix--) {
-      const line = stripLines[ix];
-      if (line) {
-        if (length + line.length < 100) {
-          length += line.length;
-        } else {
-          break;
-        }
-      }
-    }
-
-    let msgs = ix >= 0 ? lines.slice(ix + 1) : lines;
-    if (msgs.length === 0) {
-      // even the last line is too long, save it, and display last line as is
-      item.buf = lines[lines.length - 1] || "";
-      // set some reasonable limit to avoid visual digest getting clobberred
-      if (item.buf.length > 120) {
-        // truncte stripped line only to avoid breaking ansi code
-        item.buf = stripLines[stripLines.length - 1].substr(0, 100);
-      }
-      msgs = [item.buf];
-    } else {
-      item.buf = msgs.join("\n");
-    }
-
-    if (buf.endsWith("\n")) {
-      item.buf += "\n";
-    }
-
-    this._logger.updateItem(item.name, {
-      msg: msgs.join(chalk.blue.inverse("\\n")),
-      _save: false,
-      _render: false
-    });
-  }
-
-  show(child) {
-    this._stdoutKey = Symbol("visual-exec-stdout");
-    this._stderrKey = Symbol("visual-exec-stderr");
-
-    this._logger.addItem({
-      name: this._stdoutKey,
-      color: "green",
-      display: `=== ${this._title}\nstdout`,
-      spinner: this._spinner
-    });
-
-    this._logger.addItem({
-      name: this._stderrKey,
-      color: "red",
-      display: `stderr`
-    });
-
-    const stdoutDigest = { name: this._stdoutKey, buf: "" };
-    const stderrDigest = { name: this._stderrKey, buf: "" };
-    this._updateStdout = buf => this._updateDigest(stdoutDigest, buf);
-    this._updateStderr = buf => this._updateDigest(stderrDigest, buf);
-
-    child.stdout.on("data", this._updateStdout);
-    child.stderr.on("data", this._updateStderr);
-
-    this._child = child;
-
-    return child.promise
-      .catch(err => {
-        this.logResult(err);
-        throw err;
-      })
-      .then(output => {
-        this.logResult(null, output);
-        return output;
-      });
-  }
-
-  logResult(err, output) {
-    const child = this._child;
-
-    this._logger.removeItem(this._stdoutKey);
-    this._logger.removeItem(this._stderrKey);
-    child.stdout.removeListener("data", this._updateStdout);
-    child.stderr.removeListener("data", this._updateStderr);
-
-    if (err) {
-      this._logger.error(`${chalk.red("Failed")} ${this._logLabel} - ${chalk.red(err.message)}`);
-      output = err.output;
-    } else {
-      this._logger.info(`Done ${this._logLabel} ${chalk.green("exit code 0")}`);
-    }
-
-    this.logFinalOutput(err, output);
-  }
-
-  checkForErrors(text) {
-    return this._checkStdoutError && text && text.match(this._checkStdoutError);
-  }
-
-  logFinalOutput(err, output) {
-    const level =
-      err || (this._forceStderr && output.stderr) || this.checkForErrors(output.stdout)
-        ? "error"
-        : this._outputLevel;
-
-    if (!output || (!output.stdout && !output.stderr)) {
-      this._logger[level](`${chalk.green("No output")} from ${this._outputLabel}`);
-      return;
-    }
-
-    const colorize = t => t.replace(/ERR!/g, chalk.red("ERR!"));
-
-    const logs = [chalk.green(">>>"), `Start of output from ${this._outputLabel} ===`];
-
-    if (output.stdout) {
-      logs.push(`\n${colorize(output.stdout)}`);
-    }
-
-    if (output.stderr) {
-      logs.push(chalk.red("\n=== stderr ===\n") + colorize(output.stderr));
-    }
-
-    logs.push(chalk.blue("\n<<<"), `End of output from ${this._outputLabel} ---`);
-    this._logger.prefix(false)[level](...logs);
-  }
-
-  execute(command) {
-    const child = xsh.exec(
-      {
-        silent: true,
-        cwd: this._cwd,
-        env: Object.assign({}, process.env, { PWD: this._cwd }),
-        maxBuffer: this._maxBuffer
-      },
-      command || this._command
-    );
-
-    return this.show(child);
-  }
-}
-
-module.exports = VisualExec;