@nu-art/commando 0.401.0 → 0.401.2

package/shell/plugins/basic.d.ts

@@ -1,59 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-import { CliBlock } from '../types.js';
-type Cli_EchoOptions = {
-    escape?: boolean;
-    toFile?: {
-        name: string;
-        append?: boolean;
-    };
-};
-type Cli_RmdirOptions = {
-    force?: true;
-    recursive?: true;
-};
-type Cli_CpdirOptions = {
-    contentOnly?: boolean;
-};
-/**
- * Represents a Command Line Interface (CLI) to build and execute shell commands.
- */
-export declare class Commando_Basic extends BaseCommando {
-    /**
-     * Changes directory and optionally executes a block of commands in that directory.
-     * @param {string} folderName - Name of the directory to change to.
-     * @param {CliBlock} [toRun] - Optional block of commands to execute in the directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    cd(folderName: string, toRun?: CliBlock<this>): this;
-    custom(command: string): this;
-    /**
-     * Changes directory back to the previous directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    cd_(): this;
-    /**
-     * Appends an 'ls' command with optional parameters.
-     * @param {string} [params] - Optional parameters for the 'ls' command.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    ls(params?: string): this;
-    mkdir(dirName: string): this;
-    rm(dirPath: string, options?: Cli_RmdirOptions): this;
-    rmdir(dirPath: string, options?: Cli_RmdirOptions): this;
-    cpdir(srcPath: string, destPath: string, options?: Cli_CpdirOptions): this;
-    cat(fileName: string): this;
-    echo(log: string, options?: Cli_EchoOptions): this;
-    /**
-     * Appends a 'pwd' command to print the current directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    pwd(): this;
-    /**
-     * Assigns a value to a variable in the script.
-     * @param {string} varName - The name of the variable.
-     * @param {string | string[]} value - The value to assign to the variable.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    assignVar(varName: string, value: string | string[]): this;
-}
-export {};

package/shell/plugins/basic.js

@@ -1,98 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-/**
- * Represents a Command Line Interface (CLI) to build and execute shell commands.
- */
-export class Commando_Basic extends BaseCommando {
-    /**
-     * Changes directory and optionally executes a block of commands in that directory.
-     * @param {string} folderName - Name of the directory to change to.
-     * @param {CliBlock} [toRun] - Optional block of commands to execute in the directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    cd(folderName, toRun) {
-        this.append(`cd ${folderName}`);
-        this.indentIn();
-        if (toRun) {
-            toRun(this);
-            this.cd_();
-        }
-        return this;
-    }
-    custom(command) {
-        this.append(command);
-        return this;
-    }
-    /**
-     * Changes directory back to the previous directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    cd_() {
-        this.indentOut();
-        this.append(`cd -`);
-        return this;
-    }
-    /**
-     * Appends an 'ls' command with optional parameters.
-     * @param {string} [params] - Optional parameters for the 'ls' command.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    ls(params = '') {
-        this.append(`ls ${params}`);
-        return this;
-    }
-    mkdir(dirName) {
-        this.append(`mkdir -p ${dirName}`);
-        return this;
-    }
-    rm(dirPath, options) {
-        let command = 'rm';
-        if (options?.force)
-            command += ' -f';
-        this.append(`${command} ${dirPath}`);
-        return this;
-    }
-    rmdir(dirPath, options) {
-        let command = 'rm -r';
-        if (options?.force)
-            command += ' -f';
-        this.append(`${command} ${dirPath}`);
-        return this;
-    }
-    cpdir(srcPath, destPath, options) {
-        let command = `cp -r ${srcPath}`;
-        if (options?.contentOnly)
-            command += '/*';
-        command += ` ${destPath}`;
-        this.append(command);
-        return this;
-    }
-    cat(fileName) {
-        this.append(`cat ${fileName}`);
-        return this;
-    }
-    echo(log, options) {
-        const _escape = options?.escape ? '-e' : '';
-        const _toFile = options?.toFile ? `>${options.toFile.append ? '>' : ''} ${options.toFile.name}` : '';
-        const escapedLog = log.replace(/\\/g, '\\\\').replace(/\n/g, '\\\\n').replace(/\t/g, '\\\t');
-        this.append(`echo ${_escape} "${escapedLog}" ${_toFile}`);
-        return this;
-    }
-    /**
-     * Appends a 'pwd' command to print the current directory.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    pwd() {
-        this.append('pwd');
-        return this;
-    }
-    /**
-     * Assigns a value to a variable in the script.
-     * @param {string} varName - The name of the variable.
-     * @param {string | string[]} value - The value to assign to the variable.
-     * @returns {this} - The Cli instance for method chaining.
-     */
-    assignVar(varName, value) {
-        this.append(`${varName}=(${Array.isArray(value) ? value : [value].join(' ')})`);
-        return this;
-    }
-}

package/shell/plugins/git.d.ts

@@ -1,54 +0,0 @@
-import { Commando_Programming } from './programming.js';
-import { Commando_Basic } from './basic.js';
-import { BaseCommando } from '../core/BaseCommando.js';
-declare const Super: import("@nu-art/ts-common").Constructor<BaseCommando & Commando_Programming & Commando_Basic>;
-type GitCloneParams = {
-    outputFolder?: string;
-    branch?: string;
-    recursive?: boolean;
-};
-type GitPushParams = {
-    remote: string;
-    branch: string;
-    tags?: boolean;
-    force?: boolean;
-};
-export declare class Commando_Git extends Super {
-    git(): {
-        clone: (url: string, options?: GitCloneParams) => this;
-        checkout: (branch: string) => this;
-        createTag: (tagName: string) => this;
-        gitCommit: (commitMessage: string) => this;
-        add: (file: string) => this;
-        addAll: () => this;
-        addAndCommit: (commitMessage: string) => this;
-        push: (options?: GitPushParams) => this;
-        pushTags: () => this;
-        fetch: () => this;
-        resetHard: (tag?: string) => this;
-        getCurrentBranch: () => this;
-        pull: (params: string) => this;
-        merge: (mergeFrom: string) => this;
-        createBranch: (branch: string) => this;
-        gsui: (modules?: string) => this;
-        status: () => this;
-    };
-    git_clone(url: string, options?: GitCloneParams): this;
-    git_checkout(branch: string): this;
-    git_createTag(tagName: string): this;
-    git_gitCommit(commitMessage: string): this;
-    git_add(file: string): this;
-    git_addAll(): this;
-    git_addAndCommit(commitMessage: string): this;
-    git_push(options?: GitPushParams): this;
-    git_pushTags(): this;
-    git_fetch(): this;
-    git_resetHard(tag?: string): this;
-    git_getCurrentBranch(): this;
-    git_pull(params: string): this;
-    git_merge(mergeFrom: string): this;
-    git_createBranch(branch: string): this;
-    git_gsui(modules?: string): this;
-    git_status(): this;
-}
-export {};

package/shell/plugins/git.js

@@ -1,104 +0,0 @@
-import { Commando_Programming } from './programming.js';
-import { Commando_Basic } from './basic.js';
-import { MergeClass } from '../core/class-merger.js';
-import { BaseCommando } from '../core/BaseCommando.js';
-const Super = MergeClass(BaseCommando, Commando_Programming, Commando_Basic);
-export class Commando_Git extends Super {
-    git() {
-        return {
-            clone: this.git_clone,
-            checkout: this.git_checkout,
-            createTag: this.git_createTag,
-            gitCommit: this.git_gitCommit,
-            add: this.git_add,
-            addAll: this.git_addAll,
-            addAndCommit: this.git_addAndCommit,
-            push: this.git_push,
-            pushTags: this.git_pushTags,
-            fetch: this.git_fetch,
-            resetHard: this.git_resetHard,
-            getCurrentBranch: this.git_getCurrentBranch,
-            pull: this.git_pull,
-            merge: this.git_merge,
-            createBranch: this.git_createBranch,
-            gsui: this.git_gsui,
-            status: this.git_status,
-        };
-    }
-    ;
-    git_clone(url, options) {
-        const branch = `${options?.branch ? ` -b ${options?.branch}` : ''}`;
-        const recursive = `${options?.recursive ? ` --recursive` : ''}`;
-        const outputFolder = `${options?.outputFolder ? ` ${options.outputFolder}` : ''}`;
-        const command = `git clone${recursive}${branch} ${url}${outputFolder}`;
-        return this.append(command);
-    }
-    // git_cloneAssert(url: string, options?: GitCloneParams) {
-    // 	return new Promise<void>((resolve, reject) => {
-    // 		const branch = `${options?.branch ? ` -b ${options?.branch}` : ''}`;
-    // 		const recursive = `${options?.recursive ? ` --recursive` : ''}`;
-    // 		const outputFolder = `${options?.outputFolder ? ` ${options.outputFolder}` : ''}`;
-    // 		const command = `git clone${recursive}${branch} ${url}${outputFolder}`;
-    // 		this.echo(command);
-    // 		this.append(command)
-    // 			.execute((stdout: string, stderr: string, exitCode: number) => {
-    // 				if (exitCode === 0)
-    // 					return resolve();
-    //
-    // 				if (exitCode === 128)
-    // 					return reject(new Error(`No access to repo: ${url}`));
-    //
-    // 				return reject(new Error(`Got unexpected exit code(${exitCode}) while cloning: ${url}`));
-    // 			});
-    // 	});
-    // }
-    git_checkout(branch) {
-        return this.append(`git checkout ${branch}`);
-    }
-    git_createTag(tagName) {
-        return this.append(`git tag -f ${tagName}`);
-    }
-    git_gitCommit(commitMessage) {
-        return this.append(`git commit -m "${commitMessage}"`);
-    }
-    git_add(file) {
-        return this.append(`git add "${file}"`);
-    }
-    git_addAll() {
-        return this.append(`git add .`);
-    }
-    git_addAndCommit(commitMessage) {
-        return this.append(`git commit -am "${commitMessage}"`);
-    }
-    git_push(options) {
-        return this.append(`git push ${options?.remote ?? ''} ${options?.branch ?? ''}`);
-    }
-    git_pushTags() {
-        return this.append('git push --tags --force');
-    }
-    git_fetch() {
-        return this.append('git fetch');
-    }
-    git_resetHard(tag = '') {
-        return this.append('git reset --hard ${tag}');
-    }
-    git_getCurrentBranch() {
-        return this.append('git status | grep "On branch" | sed -E "s');
-    }
-    git_pull(params) {
-        return this.append('git pull ${params}');
-    }
-    git_merge(mergeFrom) {
-        return this.append(`git merge ${mergeFrom}`);
-    }
-    git_createBranch(branch) {
-        return this.append(`git checkout - b ${branch}`)
-            .append(`git push-- set -upstream origin ${branch}`);
-    }
-    git_gsui(modules = '') {
-        return this.append('git submodule update --recursive --init ${modules}');
-    }
-    git_status() {
-        return this.append('git status');
-    }
-}

package/shell/plugins/nvm.d.ts

@@ -1,12 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-import { Commando_Programming } from './programming.js';
-import { Commando_Basic } from './basic.js';
-declare const Super: import("@nu-art/ts-common").Constructor<BaseCommando & Commando_Programming & Commando_Basic>;
-export declare class Commando_NVM extends Super {
-    applyNVM(): this;
-    install(version: string): Promise<this>;
-    getVersion(): Promise<string>;
-    installNodeVersion(requiredVersion: string): Promise<this>;
-    getInstalledNodeVersions: () => Promise<(string | undefined)[]>;
-}
-export {};

package/shell/plugins/pnpm.d.ts

@@ -1,11 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-import { Commando_Basic } from './basic.js';
-import { Commando_Programming } from './programming.js';
-import { Commando_NVM } from './nvm.js';
-declare const Super: import("@nu-art/ts-common").Constructor<BaseCommando & Commando_Programming & Commando_Basic & Commando_NVM>;
-export declare class Commando_PNPM extends Super {
-    installPackages(): Promise<this>;
-    install(version: string): Promise<this>;
-    getVersion(): Promise<string>;
-}
-export {};

package/shell/plugins/python.d.ts

@@ -1,10 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-import { Commando_Programming } from './programming.js';
-import { Commando_Basic } from './basic.js';
-declare const Super: import("@nu-art/ts-common").Constructor<BaseCommando & Commando_Programming & Commando_Basic>;
-export declare class Commando_Python3 extends Super {
-    sourceVenv(venvFolder?: string): this;
-    installVenv(venvFolder?: string): Promise<this>;
-    installRequirements(pathToRequirementsFile?: string): Promise<this>;
-}
-export {};

package/shell/plugins/python.js

@@ -1,26 +0,0 @@
-import { BaseCommando } from '../core/BaseCommando.js';
-import { Commando_Programming } from './programming.js';
-import { MergeClass } from '../core/class-merger.js';
-import { Commando_Basic } from './basic.js';
-import { Exception } from '@nu-art/ts-common';
-const Super = MergeClass(BaseCommando, Commando_Programming, Commando_Basic);
-const DefaultVenvFolder = '.venv';
-export class Commando_Python3 extends Super {
-    sourceVenv(venvFolder = DefaultVenvFolder) {
-        this.append(`source ${venvFolder}/bin/activate`);
-        return this;
-    }
-    async installVenv(venvFolder = DefaultVenvFolder) {
-        this.append(`python3 -m venv ${venvFolder}`);
-        await this.execute((stdout, stderr, exitCode) => {
-            if (exitCode !== 0)
-                throw new Exception(`Error installing VENV - exit code (${exitCode})`);
-        });
-        return this;
-    }
-    async installRequirements(pathToRequirementsFile = './requirements.txt') {
-        await this.append(`pip3 install -r ${pathToRequirementsFile}`)
-            .execute();
-        return this;
-    }
-}

package/shell/services/nvm.d.ts

@@ -1,18 +0,0 @@
-import { Logger } from '@nu-art/ts-common';
-import { Commando_NVM } from '../plugins/nvm.js';
-export declare class Cli_NVM extends Logger {
-    private _expectedVersion;
-    private _homeEnvVar;
-    constructor();
-    get homeEnvVar(): string;
-    set homeEnvVar(value: string);
-    get expectedVersion(): string;
-    set expectedVersion(value: string);
-    install: (commando: Commando_NVM) => Promise<boolean | this | undefined>;
-    isInstalled: () => boolean;
-    getRequiredNode_Version: () => Promise<string>;
-    installRequiredVersionIfNeeded: (commando: Commando_NVM) => Promise<boolean>;
-    uninstall: () => Promise<void>;
-    private installVersion;
-}
-export declare const NVM: Cli_NVM;

package/shell/services/pnpm.d.ts

@@ -1,26 +0,0 @@
-import { Logger } from '@nu-art/ts-common';
-import { Commando_PNPM } from '../plugins/pnpm.js';
-export declare class Cli_PNPM extends Logger {
-    private _expectedVersion;
-    private _homeEnvVar;
-    constructor();
-    get homeEnvVar(): string;
-    set homeEnvVar(value: string);
-    get expectedVersion(): string;
-    set expectedVersion(value: string);
-    install: (commando: Commando_PNPM) => Promise<this | undefined>;
-    isInstalled: () => boolean;
-    installPackages: (commando: Commando_PNPM) => Promise<Commando_PNPM>;
-    uninstall: () => Promise<void>;
-    /**
-     * Asynchronously creates a workspace file with a list of packages.
-     * Each package is listed under the 'packages:' section in the file.
-     *
-     * @param listOfLibs An array of library names to include in the workspace.
-     * @param pathToWorkspaceFolder The filesystem path where the workspace file will be written.
-     * @example
-     * await createWorkspace(['pack1', 'pack2'], './path/to/workspace.yaml');
-     */
-    createWorkspace: (listOfLibs: string[], pathToWorkspaceFolder?: string) => Promise<void>;
-}
-export declare const PNPM: Cli_PNPM;

package/shell/simple/Commando.d.ts

@@ -1,17 +0,0 @@
-import { Constructor } from '@nu-art/ts-common';
-import { BaseCommando } from '../core/BaseCommando.js';
-export declare class Commando extends BaseCommando {
-    private uid?;
-    static create<T extends Constructor<any>[]>(...plugins: T): (import("../core/class-merger.js").MergeTypes<[typeof BaseCommando, typeof Commando, ...T]> & BaseCommando) & Commando;
-    constructor();
-    setUID(uid: string): this;
-    executeFile(filePath: string, interpreter?: string): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    executeRemoteFile(pathToFile: string, interpreter: string): Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    execute<T>(callback?: (stdout: string, stderr: string, exitCode: number) => T): Promise<T | void>;
-}

package/shell/simple/Commando.js

@@ -1,47 +0,0 @@
-import { ThisShouldNotHappenException } from '@nu-art/ts-common';
-import { SimpleShell } from './SimpleShell.js';
-import { BaseCommando } from '../core/BaseCommando.js';
-import { CliError } from '../core/CliError.js';
-export class Commando extends BaseCommando {
-    uid;
-    static create(...plugins) {
-        const _commando = BaseCommando._create(Commando, ...plugins);
-        return _commando;
-    }
-    constructor() {
-        super();
-    }
-    setUID(uid) {
-        this.uid = uid;
-        return this;
-    }
-    executeFile(filePath, interpreter) {
-        let command = filePath;
-        // If an interpreter is provided, prefix the command with it.
-        if (interpreter) {
-            command = `${interpreter} ${filePath}`;
-        }
-        return new SimpleShell().execute(command);
-    }
-    executeRemoteFile(pathToFile, interpreter) {
-        const command = `curl -o- "${pathToFile}" | ${interpreter}`;
-        return new SimpleShell().execute(command);
-    }
-    async execute(callback) {
-        const command = this.builder.reset();
-        const simpleShell = new SimpleShell().debug(this._debug);
-        try {
-            if (this.uid)
-                simpleShell.setUID(this.uid);
-            const { stdout, stderr } = await simpleShell.execute(command);
-            return callback?.(stdout, stderr, 0);
-        }
-        catch (_error) {
-            simpleShell.logError(_error);
-            const cliError = _error;
-            if ('isInstanceOf' in cliError && cliError.isInstanceOf(CliError))
-                return callback?.(cliError.stdout, cliError.stderr, cliError.cause.code ?? -1);
-            throw new ThisShouldNotHappenException('Unhandled error', _error);
-        }
-    }
-}

package/shell/simple/SimpleShell.d.ts

@@ -1,21 +0,0 @@
-import { ExecOptions } from 'child_process';
-import { Logger } from '@nu-art/ts-common';
-export type CliOptions = ExecOptions & {
-    encoding: BufferEncoding | string | null;
-};
-export declare class SimpleShell extends Logger {
-    private _debug;
-    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: (command: string) => Promise<{
-        stdout: string;
-        stderr: string;
-    }>;
-    debug(debug?: boolean): this;
-    setShell(shell: string): void;
-    setOptions(options: Partial<CliOptions>): void;
-    setUID(uid: string): this;
-}

package/shell/tools.d.ts

@@ -1,3 +0,0 @@
-import { AbsolutePath } from '@nu-art/ts-common';
-export declare function removeAnsiCodes(text: string): string;
-export declare function convertToFullPath(pathToFile: string, assetParentPath?: string): AbsolutePath;

package/shell/tools.js

@@ -1,17 +0,0 @@
-import * as path from 'path';
-export function removeAnsiCodes(text) {
-    // This regular expression matches the escape codes and removes them
-    return text.replace(/\x1B\[\d+;?\d*m/g, '');
-}
-export function convertToFullPath(pathToFile, assetParentPath = process.cwd()) {
-    if (!pathToFile)
-        throw new Error('Path not provided');
-    if (pathToFile === '')
-        throw new Error('Empty path not allowed');
-    while (pathToFile.startsWith('/'))
-        pathToFile = pathToFile.substring(1);
-    const absolutePath = path.resolve(assetParentPath, pathToFile);
-    // if (!absolutePath.startsWith(assetParentPath))
-    // 	throw new Error(`Found path: '${absolutePath}' which is out of the scope of the assert directory: '${assetParentPath}'`);
-    return absolutePath;
-}

package/shell/types.d.ts

@@ -1,3 +0,0 @@
-import { BaseCommando } from './core/BaseCommando.js';
-export type LogTypes = 'out' | 'err';
-export type CliBlock<Commando extends BaseCommando> = (cli: Commando) => void;

package/shell/types.js

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