bob-core 1.2.2 → 1.2.4

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

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingSignatureArgument = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const BobError_js_1 = require("../errors/BobError.js");
-class MissingSignatureArgument extends BobError_js_1.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((0, chalk_1.default) `\n{yellow Available arguments}:`);
-            for (const argument of this.argumentSignatures) {
-                const type = argument.type ? (0, chalk_1.default) `{white (${argument.type})}` : '';
-                const spaces = ' '.repeat(20 - argument.name.length);
-                log((0, chalk_1.default) `  {green ${argument.name}} ${spaces} ${argument.help ?? '\b'} ${type}`);
-            }
-            log('');
-        }
-        log((0, chalk_1.default) `  {white.bgRed  ERROR } Argument {bold.yellow ${this.argument}} is missing in the signature.`);
-    }
-}
-exports.MissingSignatureArgument = MissingSignatureArgument;

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

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MissingSignatureOption = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const BobError_js_1 = require("../errors/BobError.js");
-class MissingSignatureOption extends BobError_js_1.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((0, chalk_1.default) `{yellow Available options}:`);
-            for (const option of this.optionsSignature) {
-                const type = option.type ? (0, chalk_1.default) `{white (${option.type})}` : '';
-                const spaces = ' '.repeat(20 - option.name.length);
-                log((0, chalk_1.default) `  {green ${option.name}} ${spaces} ${option.help ?? '\b'} ${type}`);
-            }
-            log('');
-        }
-        log((0, chalk_1.default) `  {white.bgRed  ERROR } Option {bold.yellow ${this.option}} is missing in the signature.`);
-    }
-}
-exports.MissingSignatureOption = MissingSignatureOption;

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

@@ -1,19 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./BobError.js"), exports);
-__exportStar(require("./BadCommandParameter.js"), exports);
-__exportStar(require("./BadCommandOption.js"), exports);

package/dist/cjs/src/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Command.js"), exports);
-__exportStar(require("./Cli.js"), exports);
-__exportStar(require("./errors/index.js"), exports);
-__exportStar(require("./contracts/index.js"), exports);
-__exportStar(require("./options/index.js"), exports);

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

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSpace = generateSpace;
-function generateSpace(nb) {
-    return new Array(nb + 5).join(' ');
-}

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

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HelpOption = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const string_js_1 = require("../lib/string.js");
-class HelpOption {
-    option = 'help';
-    alias = ['h'];
-    defaultValue = false;
-    description = (0, chalk_1.default) `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((0, chalk_1.default) `{yellow Description}:`);
-        log((0, chalk_1.default) `  ${this.description}\n`);
-        log((0, chalk_1.default) `{yellow Usage}:`);
-        log((0, chalk_1.default) `  ${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((0, chalk_1.default) `\n{yellow Arguments}:`);
-            for (const signature of availableArguments) {
-                const spaces = (0, string_js_1.generateSpace)(maxLength - signature.name.length);
-                let message = (0, chalk_1.default) `  {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 += (0, chalk_1.default) ` {yellow [default: ${defaultValue}]}`;
-                }
-                if (signature.variadic) {
-                    message += (0, chalk_1.default) ` {white (variadic)}`;
-                }
-                log(message);
-            }
-        }
-        if (availableOptions.length > 0) {
-            log((0, chalk_1.default) `\n{yellow Options}:`);
-            for (const signature of availableOptions) {
-                const spaces = (0, string_js_1.generateSpace)(maxLength - signature.optionWithAlias.length);
-                let message = (0, chalk_1.default) `{green ${signature.optionWithAlias}} ${spaces} ${signature.help ?? '\b'}`;
-                if (signature.type) {
-                    message += (0, chalk_1.default) ` {white (${signature.type})}`;
-                }
-                if (signature.defaultValue !== undefined && signature.optional) {
-                    const defaultValue = signature.type === 'array' ? JSON.stringify(signature.defaultValue) : signature.defaultValue;
-                    message += (0, chalk_1.default) ` {yellow [default: ${defaultValue}]}`;
-                }
-                log(message);
-            }
-        }
-        if (this.commandsExamples.length > 0) {
-            log((0, chalk_1.default) `\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((0, chalk_1.default) `    {green ${binaryName} ${example.command}}`);
-            }
-        }
-        return -1;
-    }
-}
-exports.HelpOption = HelpOption;

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

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./HelpOption.js"), exports);

package/dist/esm/package.json

@@ -1,50 +0,0 @@
-{
-    "name": "bob-core",
-    "version": "1.2.2",
-    "description": "BOB Core",
-    "type": "module",
-    "files": [
-        "/dist"
-    ],
-    "exports": {
-        ".": {
-            "import": "./dist/esm/src/index.js",
-            "require": "./dist/cjs/src/index.js"
-        }
-    },
-    "typesVersions": {
-        "*": {
-            "*": [
-                "./dist/cjs/index.d.ts"
-            ]
-        }
-    },
-    "scripts": {
-        "start": "node -r @swc-node/register debug/main.ts",
-        "build": "rimraf ./dist && npm run build:cjs && npm run build:esm",
-        "build:cjs": "tsc --project tsconfig.json --module commonjs --verbatimModuleSyntax false --moduleResolution node10 --outDir ./dist/cjs && tsc-alias -p tsconfig.json --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
-        "build:esm": "tsc --project tsconfig.json --outDir ./dist/esm && tsc-alias -p tsconfig.json --outDir ./dist/esm",
-        "prepare": "npm run build",
-        "test": "jest"
-    },
-    "author": "Léo Hubert",
-    "license": "ISC",
-    "devDependencies": {
-        "@swc-node/register": "^1.11.1",
-        "@types/jest": "^29.5.12",
-        "@types/lodash": "^4.17.5",
-        "@types/minimist": "^1.2.5",
-        "@types/node": "^20.14.5",
-        "@types/string-similarity": "^4.0.2",
-        "jest": "^29.7.0",
-        "rimraf": "^6.0.1",
-        "ts-jest": "^29.1.5",
-        "tsc-alias": "^1.8.16",
-        "typescript": "^5.7.3"
-    },
-    "dependencies": {
-        "chalk": "^4.1.2",
-        "minimist": "^1.2.8",
-        "string-similarity": "^4.0.4"
-    }
-}

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

@@ -1,26 +0,0 @@
-import { CommandRegistry } from "./CommandRegistry.js";
-import { Command } from "./Command.js";
-import HelpCommand from "./commands/HelpCommand.js";
-import { ExceptionHandler } from "./ExceptionHandler.js";
-export type CliOptions<C> = {
-    ctx?: C;
-    name?: string;
-    version?: string;
-};
-export declare class Cli<C> {
-    readonly commandRegistry: CommandRegistry;
-    private readonly exceptionHandler;
-    private readonly ctx?;
-    private readonly helpCommand;
-    get CommandRegistryClass(): typeof CommandRegistry;
-    get HelpCommandClass(): typeof HelpCommand;
-    get ExceptionHandlerClass(): typeof ExceptionHandler;
-    constructor(opts?: CliOptions<C>);
-    setCommandResolver(resolver: (path: string) => Promise<Command<C>>): void;
-    withCommands(...commands: Array<Command<C> | {
-        new (): Command<C>;
-    } | string>): Promise<void>;
-    runCommand(command: string | Command, ...args: any[]): Promise<number>;
-    runHelpCommand(): Promise<number>;
-    protected registerCommand(command: Command<C>): void;
-}

package/dist/esm/src/Cli.js

@@ -1,59 +0,0 @@
-import { CommandRegistry } from "./CommandRegistry.js";
-import HelpCommand from "./commands/HelpCommand.js";
-import { ExceptionHandler } from "./ExceptionHandler.js";
-export class Cli {
-    commandRegistry;
-    exceptionHandler;
-    ctx;
-    helpCommand;
-    get CommandRegistryClass() {
-        return CommandRegistry;
-    }
-    get HelpCommandClass() {
-        return HelpCommand;
-    }
-    get ExceptionHandlerClass() {
-        return ExceptionHandler;
-    }
-    constructor(opts = {}) {
-        this.ctx = opts.ctx;
-        this.commandRegistry = new this.CommandRegistryClass();
-        this.exceptionHandler = new this.ExceptionHandlerClass();
-        this.helpCommand = new this.HelpCommandClass({
-            cliName: opts.name,
-            cliVersion: opts.version,
-            commandRegistry: this.commandRegistry
-        });
-    }
-    setCommandResolver(resolver) {
-        this.commandRegistry.setCommandResolver(resolver);
-    }
-    async withCommands(...commands) {
-        for (const command of commands) {
-            if (typeof command === 'string') {
-                await this.commandRegistry.loadCommandsPath(command);
-            }
-            else {
-                if (typeof command === 'function') {
-                    this.registerCommand(new command());
-                }
-                else {
-                    this.registerCommand(command);
-                }
-            }
-        }
-    }
-    async runCommand(command, ...args) {
-        if (!command) {
-            return await this.runHelpCommand();
-        }
-        return await this.commandRegistry.runCommand(this.ctx, command, ...args)
-            .catch(this.exceptionHandler.handle);
-    }
-    async runHelpCommand() {
-        return await this.runCommand(this.helpCommand);
-    }
-    registerCommand(command) {
-        this.commandRegistry.registerCommand(command);
-    }
-}

package/dist/esm/src/Command.js

@@ -1,93 +0,0 @@
-import { CommandParser } from "./CommandParser.js";
-import { HelpOption } from "./options/index.js";
-export class Command {
-    ctx;
-    helperDefinitions = {};
-    commandsExamples = [];
-    parser;
-    get CommandParserClass() {
-        return CommandParser;
-    }
-    defaultOptions() {
-        return [new HelpOption];
-    }
-    get command() {
-        if (this.parser) {
-            return this.parser.command;
-        }
-        return this.signature.split(' ')[0];
-    }
-    async run(ctx, ...args) {
-        this.ctx = ctx;
-        const defaultOptions = this.defaultOptions();
-        this.parser = new this.CommandParserClass(this.signature, this.helperDefinitions, defaultOptions, ...args);
-        for (const option of defaultOptions) {
-            if (this.parser.option(option.option)) {
-                const code = await option.handler.call(this);
-                if (code && code !== 0) {
-                    return code;
-                }
-            }
-        }
-        this.parser.validate();
-        return (await this.handle()) ?? 0;
-    }
-    setOption(name, value) {
-        this.parser.setOption(name, value);
-    }
-    setArgument(name, value) {
-        this.parser.setArgument(name, value);
-    }
-    option(key, defaultValue = null) {
-        return this.parser.option(key) ?? defaultValue;
-    }
-    optionBoolean(key, defaultValue = false) {
-        return this.parser.option(key) ?? defaultValue;
-    }
-    optionArray(key, defaultValue = []) {
-        const values = this.parser.option(key);
-        if (!Array.isArray(values)) {
-            throw new Error(`Option ${key} is not an array`);
-        }
-        if (values.length) {
-            return values;
-        }
-        return defaultValue;
-    }
-    optionNumber(key, defaultValue = null) {
-        const value = this.parser.option(key);
-        if (!value) {
-            return defaultValue;
-        }
-        if (typeof value === 'number') {
-            return value;
-        }
-        return parseInt(value);
-    }
-    argument(key, defaultValue = null) {
-        return this.parser.argument(key) ?? defaultValue;
-    }
-    argumentArray(key, defaultValue = []) {
-        const values = this.parser.argument(key);
-        if (!Array.isArray(values)) {
-            throw new Error(`Argument ${key} is not an array`);
-        }
-        if (values?.length) {
-            return values;
-        }
-        return defaultValue;
-    }
-    argumentBoolean(key, defaultValue = false) {
-        return this.parser.argument(key) ?? defaultValue;
-    }
-    argumentNumber(key, defaultValue = null) {
-        const value = this.parser.argument(key);
-        if (!value) {
-            return defaultValue;
-        }
-        if (typeof value === 'number') {
-            return value;
-        }
-        return parseInt(value);
-    }
-}

package/dist/esm/src/Command.test.d.ts

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

package/dist/esm/src/Command.test.js

@@ -1,50 +0,0 @@
-import { Command } from './Command.js';
-import { MissingRequiredArgumentValue } from "./errors/MissingRequiredArgumentValue.js";
-class MockCommand extends Command {
-    signature = 'mockCommand {argument} {--option}';
-    description = 'This is a mock command for testing';
-    handle() {
-        const opts = this.option('option');
-        const arg = this.argument('argument');
-        if (opts) {
-            return Promise.resolve(11);
-        }
-        if (arg === 'value') {
-            return Promise.resolve(1);
-        }
-        else if (arg) {
-            return Promise.resolve(-1);
-        }
-        return Promise.resolve(0);
-    }
-}
-describe('Command', () => {
-    let command;
-    beforeEach(() => {
-        command = new MockCommand();
-    });
-    it('should have a command', () => {
-        expect(command.command).toBe('mockCommand');
-    });
-    it('should have a signature', () => {
-        expect(command.signature).toBe('mockCommand {argument} {--option}');
-    });
-    it('should have a description', () => {
-        expect(command.description).toBe('This is a mock command for testing');
-    });
-    it('should handle command with argument', async () => {
-        const result = await command.run(undefined, 'value');
-        expect(result).toBe(1);
-    });
-    it('should handle command with argument', async () => {
-        const result = await command.run(undefined, 'badValue');
-        expect(result).toBe(-1);
-    });
-    it('should throw error if argument is missing', async () => {
-        await expect(command.run(undefined)).rejects.toThrowError(MissingRequiredArgumentValue);
-    });
-    it('should handle command with option', async () => {
-        const result = await command.run(undefined, 'value', '--option');
-        expect(result).toBe(11);
-    });
-});

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

@@ -1,46 +0,0 @@
-import { CommandOption } from "./contracts/index.js";
-export type ArgSignature = {
-    name: string;
-    type: string;
-    optional?: boolean;
-    variadic?: boolean;
-    alias?: string[];
-    help?: string;
-    defaultValue: string | boolean | Array<string> | null;
-    isOption?: boolean;
-};
-export declare class CommandParser {
-    protected readonly signature: string;
-    protected readonly helperDefinitions: {
-        [key: string]: string;
-    };
-    protected readonly defaultCommandOptions: CommandOption<any>[];
-    command: string;
-    private arguments;
-    private options;
-    private argumentsSignature;
-    private optionSignatures;
-    private optionAliases;
-    constructor(signature: string, helperDefinitions: {
-        [key: string]: string;
-    }, defaultCommandOptions: CommandOption<any>[], ...args: any[]);
-    option(name: string): any;
-    setOption(name: string, value: any): void;
-    optionHelp(name: string): string | undefined;
-    argument(name: string): any;
-    setArgument(name: string, value: any): void;
-    argumentHelp(name: string): string | undefined;
-    getArgumentSignatures(): {
-        [argument: string]: ArgSignature;
-    };
-    getOptionSignatures(): {
-        [option: string]: ArgSignature;
-    };
-    private getParamValue;
-    private handleArguments;
-    private handleOptions;
-    private parseSignature;
-    private parseDefaultOptions;
-    private parseParamSignature;
-    validate(): void;
-}