bob-core 1.0.1 → 1.2.1

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

@@ -0,0 +1,24 @@
+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

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

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

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

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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,5 @@
+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

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

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

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

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,70 @@
+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

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

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

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

package/package.json

@@ -1,34 +1,49 @@
 {
   "name": "bob-core",
-  "version": "1.0.1",
+  "version": "1.2.1",
   "description": "BOB Core",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
   "files": [
     "/dist"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/cjs/index.d.ts"
+      ]
+    }
+  },
   "scripts": {
     "start": "node -r @swc-node/register debug/main.ts",
-    "build": "tsc",
+    "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.9.2",
+    "@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",
-    "typescript": "^5.4.5"
+    "tsc-alias": "^1.8.16",
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "chalk": "^4.1.2",
-    "lodash": "^4.17.21",
     "minimist": "^1.2.8",
     "string-similarity": "^4.0.4"
   }

package/dist/CommandHelper.d.ts

@@ -1,4 +0,0 @@
-import { Command } from "./Command";
-export declare class CommandHelper {
-    help(this: Command<any>): number;
-}

package/dist/CommandHelper.js

@@ -1,74 +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.CommandHelper = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const lodash_1 = require("lodash");
-const string_1 = require("./lib/string");
-class CommandHelper {
-    help() {
-        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 = (0, lodash_1.max)(availableOptions.map((signature) => signature.optionWithAlias.length)) ?? 0;
-        const maxArgumentLength = (0, lodash_1.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_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_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.CommandHelper = CommandHelper;

package/dist/commands/HelpCommand.js

@@ -1,56 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Command_1 = require("../Command");
-const chalk_1 = __importDefault(require("chalk"));
-const lodash_1 = require("lodash");
-const string_1 = require("../lib/string");
-class HelpCommand extends Command_1.Command {
-    opts;
-    signature = 'help';
-    description = 'Show help';
-    constructor(opts) {
-        super();
-        this.opts = opts;
-    }
-    async handle() {
-        const commands = this.opts.commandRegistry.getCommands();
-        const cliName = this.opts.cliName ?? 'Bob CLI';
-        const version = this.opts.cliVersion ?? '0.0.0';
-        const coreVersion = require('../../package.json').version;
-        console.log((0, chalk_1.default) `${cliName} {green ${version}} (core: {yellow ${coreVersion}})
-
-{yellow Usage}:
-  command [options] [arguments]
-
-{yellow Available commands}:
-`);
-        const maxCommandLength = (0, lodash_1.max)(commands.map(command => command.command.length)) ?? 0;
-        const commandByGroups = {};
-        for (const command of commands) {
-            const commandGroup = command.command.split(':')[0];
-            if (!commandByGroups[commandGroup]) {
-                commandByGroups[commandGroup] = [];
-            }
-            commandByGroups[commandGroup].push(command);
-        }
-        const sortedCommandsByGroups = (0, lodash_1.orderBy)((0, lodash_1.orderBy)(Object.entries(commandByGroups), [([group]) => group.toLowerCase()], ['asc']), [([_, commands]) => commands.length], ['asc']);
-        for (const [group, groupCommands] of sortedCommandsByGroups) {
-            const isGrouped = groupCommands.length > 1;
-            if (isGrouped) {
-                console.log((0, chalk_1.default) `{yellow ${group}}:`);
-            }
-            const sortedGroupCommands = (0, lodash_1.orderBy)(groupCommands, [command => command.command.toLowerCase()], ['asc']);
-            for (const command of sortedGroupCommands) {
-                let spaces = (0, string_1.generateSpace)(maxCommandLength - command.command.length);
-                if (isGrouped) {
-                    spaces = spaces.slice(2);
-                }
-                console.log((0, chalk_1.default) `${isGrouped ? '  ' : ''}{green ${command.command}} ${spaces} ${command.description}`);
-            }
-        }
-    }
-}
-exports.default = HelpCommand;

package/dist/contracts/index.d.ts

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

package/dist/errors/index.d.ts

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

package/dist/index.d.ts

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

package/dist/options/index.d.ts

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