@nu-art/commando 0.204.86 → 0.204.88

package/core/cli.d.ts

@@ -1,147 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="mocha" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { ExecOptions } from 'child_process';
-import { AsyncVoidFunction, Constructor, Logger } from '@nu-art/ts-common';
-export type CliBlock<Cli extends CliWrapper> = (cli: Cli) => void;
-export type CliOptions = ExecOptions & {
-    encoding: BufferEncoding | string | null;
-};
-/**
- * Type definition for options used in Cli class.
- */
-type Options = {
-    newlineDelimiter: string;
-    indentation: number;
-};
-export declare class BaseCLI extends Logger {
-    protected stderrValidator: ((stdout: string) => boolean);
-    protected stdoutProcessors: ((stdout: string) => void)[];
-    protected stderrProcessors: ((stdout: string) => void)[];
-    protected commands: string[];
-    private indentation;
-    protected _debug: boolean;
-    protected option: Options;
-    protected uid: string;
-    /**
-     * Constructs a CLI instance with given options.
-     * @param {Options} options - Configuration options for the CLI instance.
-     */
-    constructor(options?: Partial<Options>);
-    protected getIndentation: () => string;
-    readonly indentIn: () => void;
-    readonly indentOut: () => void;
-    debug(debug?: boolean): boolean;
-    /**
-     * Appends a command or a Cli instance to the command list with proper indentation.
-     * @param {string} command - The command or Cli instance to append.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    readonly append: (command: string) => this;
-    setUID(uuid: string): void;
-    setStdErrorValidator(processor: (stderr: string) => boolean): void;
-    addStdoutProcessor(processor: (stdout: string) => void): void;
-    addStderrProcessor(processor: (stderr: string) => void): void;
-    removeStdoutProcessor(processor: (stdout: string) => void): void;
-    removeStderrProcessor(processor: (stderr: string) => void): void;
-}
-export declare class CliInteractive extends BaseCLI {
-    private shell;
-    private alive;
-    constructor();
-    execute: () => Promise<void>;
-    endInteractive: (cb?: AsyncVoidFunction) => void;
-    kill: (signal?: NodeJS.Signals | number) => boolean;
-    gracefullyKill: (pid?: number) => Promise<void>;
-}
-export declare class Cli extends BaseCLI {
-    private cliOptions;
-    /**
-     * Executes the accumulated commands in the command list.
-     * @returns {Promise<string>} A promise that resolves with the standard output of the executed command.
-     */
-    execute: () => Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    /**
-     * Appends an empty line to the script for readability.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    emptyLine(): this;
-    setShell(shell: string): void;
-    setOptions(options: Partial<CliOptions>): void;
-}
-export declare class CliWrapper {
-    cli: Cli;
-}
-export declare class Commando {
-    cli: Cli;
-    static create<T extends Constructor<CliWrapper>[]>(...plugins: T): Commando & import("./class-merger").MergeTypes<T>;
-    setShell: (shell: string) => this;
-    setOptions: (options: ExecOptions) => this;
-    debug: (debug?: boolean) => this;
-    append: (command: string) => this;
-    setUID: (uid: string) => this;
-    execute: () => Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    /**
-     * Executes a given file.
-     * @param {string} filePath - The path to the file to execute.
-     * @param {string} [interpreter] - Optional. The interpreter to use for executing the file (e.g., "python", "bash").
-     *                                 If not provided, the file is executed directly.
-     *
-     * @returns {Cli} - The script execution output.
-     */
-    executeFile: (filePath: string, interpreter?: string) => Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    executeRemoteFile: (pathToFile: string, interpreter: string) => Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    addStdoutProcessor: (processor: (stdout: string) => void) => this;
-    addStderrProcessor: (processor: (stderr: string) => void) => this;
-    removeStdoutProcessor: (processor: (stdout: string) => void) => this;
-    removeStderrProcessor: (processor: (stderr: string) => void) => this;
-    setStdErrorValidator: (processor: (stderr: string) => boolean) => this;
-    private constructor();
-}
-export declare class CommandoInteractive {
-    cli: CliInteractive;
-    static create<T extends Constructor<CliWrapper>[]>(...plugins: T): CommandoInteractive & Commando & import("./class-merger").MergeTypes<T>;
-    addStdoutProcessor: (processor: (stdout: string) => void) => this;
-    addStderrProcessor: (processor: (stderr: string) => void) => this;
-    removeStdoutProcessor: (processor: (stdout: string) => void) => this;
-    removeStderrProcessor: (processor: (stderr: string) => void) => this;
-    setStdErrorValidator: (processor: (stderr: string) => boolean) => this;
-    setUID: (uid: string) => this;
-    close: (cb?: AsyncVoidFunction) => this;
-    kill: (signal?: NodeJS.Signals | number) => boolean;
-    gracefullyKill: (pid?: number) => Promise<void>;
-}
-type CommandoCLIListener_Callback = (stdout: string) => void;
-export declare class CommandoCLIListener {
-    private cb;
-    protected filter?: RegExp;
-    constructor(callback: CommandoCLIListener_Callback, filter?: string | RegExp);
-    private _process;
-    private stdoutPassesFilter;
-    listen: <T extends Commando | CommandoInteractive>(commando: T) => T;
-    protected process(stdout: string): void;
-}
-export declare class CommandoCLIKeyValueListener extends CommandoCLIListener {
-    private value;
-    constructor(pattern: string | RegExp);
-    private setValue;
-    protected process(stdout: string): void;
-    getValue: () => string | undefined;
-}
-export {};

package/core/cli.js

@@ -1,404 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandoCLIKeyValueListener = exports.CommandoCLIListener = exports.CommandoInteractive = exports.Commando = exports.CliWrapper = exports.Cli = exports.CliInteractive = exports.BaseCLI = void 0;
-const child_process_1 = require("child_process");
-const class_merger_1 = require("./class-merger");
-const CliError_1 = require("./CliError");
-const ts_common_1 = require("@nu-art/ts-common");
-const node_child_process_1 = require("node:child_process");
-/**
- * Default options for Cli class instances.
- */
-const defaultOptions = {
-    newlineDelimiter: '\n',
-    indentation: 2,
-};
-class BaseCLI extends ts_common_1.Logger {
-    /**
-     * Constructs a CLI instance with given options.
-     * @param {Options} options - Configuration options for the CLI instance.
-     */
-    constructor(options = defaultOptions) {
-        super();
-        this.stderrValidator = () => true;
-        this.stdoutProcessors = [];
-        this.stderrProcessors = [];
-        this.commands = [];
-        this.indentation = 0;
-        this._debug = true;
-        this.uid = (0, ts_common_1.generateHex)((8));
-        this.getIndentation = () => {
-            return ' '.repeat(this.option.indentation * this.indentation);
-        };
-        this.indentIn = () => {
-            this.indentation++;
-        };
-        this.indentOut = () => {
-            this.indentation++;
-        };
-        /**
-         * Appends a command or a Cli instance to the command list with proper indentation.
-         * @param {string} command - The command or Cli instance to append.
-         * @returns {this} - The Cli instance for method chaining.
-         */
-        this.append = (command) => {
-            this.commands.push(`${this.getIndentation()}${command}`);
-            return this;
-        };
-        this.setMinLevel(ts_common_1.LogLevel.Verbose);
-        this.option = options;
-    }
-    debug(debug) {
-        this._debug = debug !== null && debug !== void 0 ? debug : !this._debug;
-        return this._debug;
-    }
-    setUID(uuid) {
-        this.setTag(uuid);
-    }
-    setStdErrorValidator(processor) {
-        this.stderrValidator = processor;
-    }
-    addStdoutProcessor(processor) {
-        this.stdoutProcessors.push(processor);
-    }
-    addStderrProcessor(processor) {
-        this.stderrProcessors.push(processor);
-    }
-    removeStdoutProcessor(processor) {
-        (0, ts_common_1.removeItemFromArray)(this.stdoutProcessors, processor);
-    }
-    removeStderrProcessor(processor) {
-        (0, ts_common_1.removeItemFromArray)(this.stderrProcessors, processor);
-    }
-}
-exports.BaseCLI = BaseCLI;
-class CliInteractive extends BaseCLI {
-    constructor() {
-        var _a, _b;
-        super();
-        this.execute = async () => {
-            var _a;
-            const command = this.commands.join(this.option.newlineDelimiter);
-            if (this._debug)
-                this.logDebug(`executing: `, `"""\n${command}\n"""`);
-            (_a = this.shell.stdin) === null || _a === void 0 ? void 0 : _a.write(command + this.option.newlineDelimiter, 'utf-8', (err) => {
-                if (err)
-                    this.logError(`error`, err);
-            });
-            this.commands = [];
-        };
-        this.endInteractive = (cb) => {
-            var _a;
-            (_a = this.shell.stdin) === null || _a === void 0 ? void 0 : _a.end(cb);
-        };
-        this.kill = (signal) => {
-            return this.shell.kill(signal);
-        };
-        this.gracefullyKill = async (pid) => {
-            // if the shell is already dead no need to wait for kill
-            if (!this.alive)
-                return;
-            return new Promise((resolve, reject) => {
-                this.shell.on('exit', async (code, signal) => {
-                    this.alive = false;
-                    resolve();
-                });
-                if (pid) {
-                    process.kill(pid, 'SIGINT');
-                }
-                else {
-                    this.shell.kill('SIGINT');
-                }
-            });
-        };
-        this.shell = (0, node_child_process_1.spawn)('/bin/bash', {
-            detached: true,
-            shell: true
-        });
-        //set alive
-        this.alive = true;
-        // Handle shell output (stdout)
-        const printer = (data) => {
-            const message = data.toString().trim();
-            if (!message.length)
-                return;
-            try {
-                if (!this.stderrValidator(message))
-                    this.stdoutProcessors.forEach(processor => processor(message));
-                else
-                    this.stderrProcessors.forEach(processor => processor(message));
-                this.logInfo(`${message}`);
-            }
-            catch (e) {
-                this.logError(e);
-            }
-        };
-        (_a = this.shell.stdout) === null || _a === void 0 ? void 0 : _a.on('data', printer);
-        (_b = this.shell.stderr) === null || _b === void 0 ? void 0 : _b.on('data', printer);
-        // Handle shell errors (stderr)
-        this.shell.on('data', printer);
-        // Handle shell exit
-        this.shell.on('close', (code) => {
-            this.alive = false;
-            this.logInfo(`child process exited with code ${code}`);
-        });
-    }
-}
-exports.CliInteractive = CliInteractive;
-class Cli extends BaseCLI {
-    constructor() {
-        super(...arguments);
-        this.cliOptions = { shell: '/bin/bash' };
-        /**
-         * Executes the accumulated commands in the command list.
-         * @returns {Promise<string>} A promise that resolves with the standard output of the executed command.
-         */
-        this.execute = async () => {
-            const command = this.commands.join(this.option.newlineDelimiter);
-            if (this._debug)
-                this.logDebug(`executing: `, `"""\n${command}\n"""`);
-            return new Promise((resolve, reject) => {
-                (0, child_process_1.exec)(command, this.cliOptions, (error, stdout, stderr) => {
-                    this.commands = [];
-                    if (error) {
-                        reject(new CliError_1.CliError(`executing:\n${command}\n`, stdout, stderr, error));
-                    }
-                    const errorLogs = stderr.split('\n');
-                    const { filteredIn, filteredOut } = (0, ts_common_1.filterInOut)(errorLogs, this.stderrValidator);
-                    stderr = filteredIn.join('\n').trim();
-                    if (stderr && stderr.length > 0)
-                        reject(stderr);
-                    const stdErrToOut = filteredOut.join('\n').trim();
-                    if (stdErrToOut && stdErrToOut.length > 0)
-                        stdout += `from stderr: \n${stdErrToOut}`;
-                    if (stdout) {
-                        this.stdoutProcessors.forEach(processor => processor(stdout));
-                        this.logInfo(stdout);
-                    }
-                    if (stderr) {
-                        this.stderrProcessors.forEach(processor => processor(stdout));
-                        this.logError(stderr);
-                    }
-                    resolve({ stdout, stderr });
-                });
-            });
-        };
-    }
-    /**
-     * Appends an empty line to the script for readability.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    emptyLine() {
-        this.append('');
-        return this;
-    }
-    setShell(shell) {
-        (this.cliOptions || (this.cliOptions = {})).shell = shell;
-    }
-    setOptions(options) {
-        this.cliOptions = options;
-    }
-}
-exports.Cli = Cli;
-class CliWrapper {
-}
-exports.CliWrapper = CliWrapper;
-class Commando {
-    static create(...plugins) {
-        const _commando = (0, class_merger_1.CreateMergedInstance)(...plugins);
-        const commando = _commando;
-        const cli = new Cli();
-        cli.setMinLevel(ts_common_1.LogLevel.Verbose);
-        commando.cli = cli;
-        commando.execute = () => commando.cli.execute();
-        commando.debug = (debug) => {
-            commando.cli.debug(debug);
-            return commando;
-        };
-        commando.setOptions = (options) => {
-            commando.cli.setOptions(options);
-            return commando;
-        };
-        commando.setShell = (shell) => {
-            commando.cli.setShell(shell);
-            return commando;
-        };
-        commando.executeFile = (filePath, interpreter) => {
-            let command = filePath;
-            // If an interpreter is provided, prefix the command with it.
-            if (interpreter) {
-                command = `${interpreter} ${filePath}`;
-            }
-            return new Cli().append(command).execute();
-        };
-        commando.executeRemoteFile = (pathToFile, interpreter) => {
-            return new Cli().append(`curl -o- "${pathToFile}" | ${interpreter}`).execute();
-        };
-        commando.append = (command) => {
-            commando.cli.append(command);
-            return commando;
-        };
-        commando.setUID = (uid) => {
-            commando.cli.setUID(uid);
-            return commando;
-        };
-        commando.addStdoutProcessor = (processor) => {
-            cli.addStdoutProcessor(processor);
-            return commando;
-        };
-        commando.addStderrProcessor = (processor) => {
-            cli.addStderrProcessor(processor);
-            return commando;
-        };
-        commando.removeStdoutProcessor = (processor) => {
-            cli.removeStdoutProcessor(processor);
-            return commando;
-        };
-        commando.removeStderrProcessor = (processor) => {
-            cli.removeStderrProcessor(processor);
-            return commando;
-        };
-        commando.setStdErrorValidator = (processor) => {
-            cli.setStdErrorValidator(processor);
-            return commando;
-        };
-        return commando;
-    }
-    constructor() {
-        this.setShell = (shell) => this;
-        this.setOptions = (options) => this;
-        this.debug = (debug) => this;
-        this.append = (command) => this;
-        this.setUID = (uid) => this;
-        this.execute = async () => ({ stdout: '', stderr: '', }); // placeholder
-        /**
-         * Executes a given file.
-         * @param {string} filePath - The path to the file to execute.
-         * @param {string} [interpreter] - Optional. The interpreter to use for executing the file (e.g., "python", "bash").
-         *                                 If not provided, the file is executed directly.
-         *
-         * @returns {Cli} - The script execution output.
-         */
-        this.executeFile = async (filePath, interpreter) => ({ stdout: '', stderr: '', });
-        this.executeRemoteFile = async (pathToFile, interpreter) => ({ stdout: '', stderr: '', });
-        this.addStdoutProcessor = (processor) => this;
-        this.addStderrProcessor = (processor) => this;
-        this.removeStdoutProcessor = (processor) => this;
-        this.removeStderrProcessor = (processor) => this;
-        this.setStdErrorValidator = (processor) => this;
-    }
-}
-exports.Commando = Commando;
-class CommandoInteractive {
-    constructor() {
-        this.addStdoutProcessor = (processor) => this;
-        this.addStderrProcessor = (processor) => this;
-        this.removeStdoutProcessor = (processor) => this;
-        this.removeStderrProcessor = (processor) => this;
-        this.setStdErrorValidator = (processor) => this;
-        this.setUID = (uid) => this;
-        this.close = (cb) => this;
-        this.kill = (signal) => true;
-        this.gracefullyKill = (pid) => {
-            return new Promise(resolve => resolve());
-        };
-    }
-    static create(...plugins) {
-        const _commando = Commando.create(...plugins);
-        const commando = _commando;
-        const cli = new CliInteractive();
-        cli.setMinLevel(ts_common_1.LogLevel.Verbose);
-        commando.cli = cli;
-        commando.setUID = (uid) => {
-            commando.cli.setUID(uid);
-            return commando;
-        };
-        commando.close = (cb) => {
-            commando.cli.endInteractive(cb);
-            return commando;
-        };
-        commando.kill = (signal) => {
-            return commando.cli.kill(signal);
-        };
-        commando.gracefullyKill = async (pid) => {
-            await commando.cli.gracefullyKill(pid);
-        };
-        commando.addStdoutProcessor = (processor) => {
-            cli.addStdoutProcessor(processor);
-            return commando;
-        };
-        commando.addStderrProcessor = (processor) => {
-            cli.addStderrProcessor(processor);
-            return commando;
-        };
-        commando.removeStdoutProcessor = (processor) => {
-            cli.removeStdoutProcessor(processor);
-            return commando;
-        };
-        commando.removeStderrProcessor = (processor) => {
-            cli.removeStderrProcessor(processor);
-            return commando;
-        };
-        commando.setStdErrorValidator = (processor) => {
-            cli.setStdErrorValidator(processor);
-            return commando;
-        };
-        return commando;
-    }
-}
-exports.CommandoInteractive = CommandoInteractive;
-class CommandoCLIListener {
-    constructor(callback, filter) {
-        this.stdoutPassesFilter = (stdout) => {
-            if (!this.filter)
-                return true;
-            return this.filter.test(stdout);
-        };
-        //######################### Functions #########################
-        this.listen = (commando) => {
-            const process = this._process.bind(this);
-            commando.addStdoutProcessor(process);
-            commando.addStderrProcessor(process);
-            return commando;
-        };
-        this.cb = callback;
-        if (!filter)
-            return;
-        if (typeof filter === 'string')
-            this.filter = new RegExp(filter);
-        else
-            this.filter = filter;
-    }
-    //######################### Inner Logic #########################
-    _process(stdout) {
-        if (!this.stdoutPassesFilter(stdout))
-            return;
-        this.process(stdout);
-    }
-    process(stdout) {
-        this.cb(stdout);
-    }
-}
-exports.CommandoCLIListener = CommandoCLIListener;
-class CommandoCLIKeyValueListener extends CommandoCLIListener {
-    constructor(pattern) {
-        const filter = typeof pattern === 'string' ? new RegExp(pattern) : pattern;
-        super(ts_common_1.voidFunction, filter);
-        //######################### Inner Logic #########################
-        this.setValue = (value) => {
-            this.value = value;
-        };
-        this.getValue = () => this.value;
-    }
-    //######################### Functions #########################
-    process(stdout) {
-        var _a;
-        const pattern = this.filter;
-        if (!pattern)
-            throw new ts_common_1.ThisShouldNotHappenException('Class does not have a pattern, but it should have been initialized with one');
-        const value = (_a = stdout.match(pattern)) === null || _a === void 0 ? void 0 : _a[1];
-        if (value)
-            this.setValue(value);
-    }
-}
-exports.CommandoCLIKeyValueListener = CommandoCLIKeyValueListener;

package/test-scripts/test-params.d.ts

@@ -1 +0,0 @@
-export {};

package/test-scripts/test-params.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cli_params_1 = require("../cli/cli-params");
-const testParam1 = {
-    keys: ['--test1', '-t1'],
-    keyName: 'test1',
-    type: 'string',
-    description: '',
-    defaultValue: 'psulet'
-};
-const testParam2 = {
-    keys: ['--test2'],
-    keyName: 'test2',
-    type: 'string[]',
-    description: ''
-};
-const testParam3 = {
-    keys: ['--test3'],
-    keyName: 'test3',
-    type: 'number',
-    description: ''
-};
-const testParam4 = {
-    keys: ['--test4'],
-    keyName: 'test4',
-    type: 'number[]',
-    description: ''
-};
-const testParam5 = {
-    keys: ['--test5'],
-    keyName: 'test5',
-    type: 'boolean',
-    description: ''
-};
-const testParam6 = {
-    keys: ['--test6'],
-    keyName: 'test6',
-    type: 'boolean[]',
-    description: ''
-};
-const params = [testParam1, testParam2, testParam3, testParam4, testParam5, testParam6];
-const MyAppParamResolver = new cli_params_1.CLIParams_Resolver(params);
-console.log(MyAppParamResolver.resolveParamValue());