bob-core 1.2.2 → 1.2.4

package/dist/esm/src/errors/BadCommandParameter.js

@@ -1,29 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class BadCommandParameter extends BobError {
-    param;
-    constructor(param) {
-        let message = `Argument "${param.param}" value is invalid.`;
-        if (param.reason) {
-            message += ` Reason: ${param.reason}`;
-        }
-        else {
-            message += ` Value: "${param.value}"`;
-        }
-        super(message);
-        this.param = param;
-    }
-    pretty() {
-        const log = console.log;
-        log(chalk `  {white.bgRed  ERROR } Argument {bold.yellow ${this.param.param}} value is invalid. `);
-        if (this.param.value || this.param.reason) {
-            log('');
-        }
-        if (this.param.value) {
-            log(chalk `  {blue Value}: ${this.param.value}`);
-        }
-        if (this.param.reason) {
-            log(chalk `  {yellow Reason}: ${this.param.reason}`);
-        }
-    }
-}

package/dist/esm/src/errors/BobError.d.ts

@@ -1,3 +0,0 @@
-export declare abstract class BobError extends Error {
-    abstract pretty(): void;
-}

package/dist/esm/src/errors/BobError.js

@@ -1,2 +0,0 @@
-export class BobError extends Error {
-}

package/dist/esm/src/errors/CommandNotFoundError.d.ts

@@ -1,7 +0,0 @@
-import { BobError } from "../errors/BobError.js";
-export declare class CommandNotFoundError extends BobError {
-    readonly command: string;
-    readonly similarCommands: string[];
-    constructor(command: string, similarCommands: string[]);
-    pretty(): void;
-}

package/dist/esm/src/errors/CommandNotFoundError.js

@@ -1,23 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class CommandNotFoundError extends BobError {
-    command;
-    similarCommands;
-    constructor(command, similarCommands) {
-        super(`Command "${command}" not found.`);
-        this.command = command;
-        this.similarCommands = similarCommands;
-    }
-    pretty() {
-        const log = console.log;
-        if (this.similarCommands.length) {
-            log(chalk `  {white.bgRed  ERROR } Command "${this.command}" not found, Did you mean one of these?`);
-            for (const cmd of this.similarCommands) {
-                log(chalk `  {gray ⇂ ${cmd}}`);
-            }
-        }
-        else {
-            log(chalk `  {white.bgRed  ERROR } Command "${this.command}" not found.`);
-        }
-    }
-}

package/dist/esm/src/errors/InvalidOption.js

@@ -1,25 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class InvalidOption extends BobError {
-    option;
-    optionsSignature;
-    constructor(option, optionsSignature) {
-        super(`Invalid option ${option} in not recognized`);
-        this.option = option;
-        this.optionsSignature = optionsSignature;
-    }
-    pretty() {
-        const log = console.log;
-        if (this.optionsSignature.length > 0) {
-            log(chalk `\n{yellow Available options}:`);
-            for (const option of this.optionsSignature) {
-                const type = option.type ? chalk `{white (${option.type})}` : '';
-                const nameWithAlias = `--${option.name}${option.alias?.map(a => `, -${a}`).join('') ?? ''}`;
-                const spaces = ' '.repeat(30 - nameWithAlias.length);
-                log(chalk `  {green ${nameWithAlias}} ${spaces} ${option.help ?? '\b'} ${type}`);
-            }
-            log('');
-        }
-        log(chalk `  {white.bgRed  ERROR } Option {bold.yellow ${this.option}} is not recognized.`);
-    }
-}

package/dist/esm/src/errors/MissingRequiredArgumentValue.d.ts

@@ -1,7 +0,0 @@
-import { BobError } from "../errors/BobError.js";
-import { ArgSignature } from "../CommandParser.js";
-export declare class MissingRequiredArgumentValue extends BobError {
-    readonly paramSignature: ArgSignature;
-    constructor(paramSignature: ArgSignature);
-    pretty(): void;
-}

package/dist/esm/src/errors/MissingRequiredArgumentValue.js

@@ -1,16 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class MissingRequiredArgumentValue extends BobError {
-    paramSignature;
-    constructor(paramSignature) {
-        super(`Argument "${paramSignature.name}" is required.`);
-        this.paramSignature = paramSignature;
-    }
-    pretty() {
-        const log = console.log;
-        if (this.paramSignature.help) {
-            log(chalk `{yellow Help}: ${this.paramSignature.help}\n`);
-        }
-        log(chalk `  {white.bgRed  ERROR } Argument {bold.yellow ${this.paramSignature.name}} is required.`);
-    }
-}

package/dist/esm/src/errors/MissingSignatureArgument.d.ts

@@ -1,8 +0,0 @@
-import { BobError } from "../errors/BobError.js";
-import { ArgSignature } from "../CommandParser.js";
-export declare class MissingSignatureArgument extends BobError {
-    private argument;
-    private argumentSignatures;
-    constructor(argument: string, argumentSignatures: ArgSignature[]);
-    pretty(): void;
-}

package/dist/esm/src/errors/MissingSignatureArgument.js

@@ -1,24 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class MissingSignatureArgument extends BobError {
-    argument;
-    argumentSignatures;
-    constructor(argument, argumentSignatures) {
-        super(`Missing ${argument} in the command signature`);
-        this.argument = argument;
-        this.argumentSignatures = argumentSignatures;
-    }
-    pretty() {
-        const log = console.log;
-        if (this.argumentSignatures.length) {
-            log(chalk `\n{yellow Available arguments}:`);
-            for (const argument of this.argumentSignatures) {
-                const type = argument.type ? chalk `{white (${argument.type})}` : '';
-                const spaces = ' '.repeat(20 - argument.name.length);
-                log(chalk `  {green ${argument.name}} ${spaces} ${argument.help ?? '\b'} ${type}`);
-            }
-            log('');
-        }
-        log(chalk `  {white.bgRed  ERROR } Argument {bold.yellow ${this.argument}} is missing in the signature.`);
-    }
-}

package/dist/esm/src/errors/MissingSignatureOption.d.ts

@@ -1,8 +0,0 @@
-import { BobError } from "../errors/BobError.js";
-import { ArgSignature } from "../CommandParser.js";
-export declare class MissingSignatureOption extends BobError {
-    private option;
-    private optionsSignature;
-    constructor(option: string, optionsSignature: ArgSignature[]);
-    pretty(): void;
-}

package/dist/esm/src/errors/MissingSignatureOption.js

@@ -1,24 +0,0 @@
-import chalk from "chalk";
-import { BobError } from "../errors/BobError.js";
-export class MissingSignatureOption extends BobError {
-    option;
-    optionsSignature;
-    constructor(option, optionsSignature) {
-        super(`Missing ${option} in the command signature`);
-        this.option = option;
-        this.optionsSignature = optionsSignature;
-    }
-    pretty() {
-        const log = console.log;
-        if (this.optionsSignature.length) {
-            log(chalk `{yellow Available options}:`);
-            for (const option of this.optionsSignature) {
-                const type = option.type ? chalk `{white (${option.type})}` : '';
-                const spaces = ' '.repeat(20 - option.name.length);
-                log(chalk `  {green ${option.name}} ${spaces} ${option.help ?? '\b'} ${type}`);
-            }
-            log('');
-        }
-        log(chalk `  {white.bgRed  ERROR } Option {bold.yellow ${this.option}} is missing in the signature.`);
-    }
-}

package/dist/esm/src/errors/index.d.ts

@@ -1,3 +0,0 @@
-export * from './BobError.js';
-export * from './BadCommandParameter.js';
-export * from './BadCommandOption.js';

package/dist/esm/src/errors/index.js

@@ -1,3 +0,0 @@
-export * from './BobError.js';
-export * from './BadCommandParameter.js';
-export * from './BadCommandOption.js';

package/dist/esm/src/index.d.ts

@@ -1,5 +0,0 @@
-export * from './Command.js';
-export * from './Cli.js';
-export * from './errors/index.js';
-export * from './contracts/index.js';
-export * from './options/index.js';

package/dist/esm/src/index.js

@@ -1,5 +0,0 @@
-export * from './Command.js';
-export * from './Cli.js';
-export * from './errors/index.js';
-export * from './contracts/index.js';
-export * from './options/index.js';

package/dist/esm/src/lib/string.d.ts

@@ -1 +0,0 @@
-export declare function generateSpace(nb: number): string;

package/dist/esm/src/lib/string.js

@@ -1,3 +0,0 @@
-export function generateSpace(nb) {
-    return new Array(nb + 5).join(' ');
-}

package/dist/esm/src/options/HelpOption.d.ts

@@ -1,9 +0,0 @@
-import { Command } from "../Command.js";
-import { CommandOption } from "../contracts/index.js";
-export declare class HelpOption implements CommandOption<Command> {
-    option: string;
-    alias: string[];
-    defaultValue: boolean;
-    description: string;
-    handler(this: Command): Promise<number | void>;
-}

package/dist/esm/src/options/HelpOption.js

@@ -1,70 +0,0 @@
-import chalk from "chalk";
-import { generateSpace } from "../lib/string.js";
-export class HelpOption {
-    option = 'help';
-    alias = ['h'];
-    defaultValue = false;
-    description = chalk `Display help for the given command. When no command is given display help for the {green list} command`;
-    async handler() {
-        const log = console.log;
-        const availableArguments = Object.values(this.parser.getArgumentSignatures());
-        const availableOptions = Object.values(this.parser.getOptionSignatures())
-            .map((signature) => ({
-            ...signature,
-            optionWithAlias: `--${signature.name}${signature.alias?.map(a => `, -${a}`).join('') ?? ''}`
-        }));
-        const requiredArguments = availableArguments.filter((signature) => !signature.optional);
-        log(chalk `{yellow Description}:`);
-        log(chalk `  ${this.description}\n`);
-        log(chalk `{yellow Usage}:`);
-        log(chalk `  ${this.command} ${requiredArguments.length > 0 ? requiredArguments.map((signature) => `<${signature.name}>`).join(' ') : '\b'} [options]`);
-        const maxOptionLength = Math.max(...availableOptions.map((signature) => signature.optionWithAlias.length)) ?? 0;
-        const maxArgumentLength = Math.max(...availableArguments.map((arg) => arg.name.length)) ?? 0;
-        const maxLength = maxArgumentLength > maxOptionLength ? maxArgumentLength : maxOptionLength;
-        if (availableArguments.length > 0) {
-            log(chalk `\n{yellow Arguments}:`);
-            for (const signature of availableArguments) {
-                const spaces = generateSpace(maxLength - signature.name.length);
-                let message = chalk `  {green ${signature.name}} ${spaces} ${signature.help ?? '\b'}`;
-                if (signature.defaultValue !== undefined && signature.optional) {
-                    const defaultValue = signature.type === 'array' ? JSON.stringify(signature.defaultValue) : signature.defaultValue;
-                    message += chalk ` {yellow [default: ${defaultValue}]}`;
-                }
-                if (signature.variadic) {
-                    message += chalk ` {white (variadic)}`;
-                }
-                log(message);
-            }
-        }
-        if (availableOptions.length > 0) {
-            log(chalk `\n{yellow Options}:`);
-            for (const signature of availableOptions) {
-                const spaces = generateSpace(maxLength - signature.optionWithAlias.length);
-                let message = chalk `{green ${signature.optionWithAlias}} ${spaces} ${signature.help ?? '\b'}`;
-                if (signature.type) {
-                    message += chalk ` {white (${signature.type})}`;
-                }
-                if (signature.defaultValue !== undefined && signature.optional) {
-                    const defaultValue = signature.type === 'array' ? JSON.stringify(signature.defaultValue) : signature.defaultValue;
-                    message += chalk ` {yellow [default: ${defaultValue}]}`;
-                }
-                log(message);
-            }
-        }
-        if (this.commandsExamples.length > 0) {
-            log(chalk `\n{yellow Examples}:`);
-            let binaryName = process.argv[0].split('/').pop();
-            if (binaryName === 'node') {
-                binaryName += ' ' + process.argv[1].split('/').pop();
-            }
-            for (const [index, example] of this.commandsExamples.entries()) {
-                if (index > 0) {
-                    log('');
-                }
-                log(`  ${example.description}\n`);
-                log(chalk `    {green ${binaryName} ${example.command}}`);
-            }
-        }
-        return -1;
-    }
-}

package/dist/esm/src/options/index.d.ts

@@ -1 +0,0 @@
-export * from './HelpOption.js';

package/dist/esm/src/options/index.js

@@ -1 +0,0 @@
-export * from './HelpOption.js';