bob-core 0.9.4 → 0.9.6

package/dist/Cli.d.ts

@@ -11,11 +11,11 @@ export declare class Cli<C> {
     get HelpCommandClass(): typeof HelpCommand;
     get ExceptionHandlerClass(): typeof ExceptionHandler;
     constructor(ctx?: C);
-    setCommandResolver(resolver: (path: string) => Promise<Command>): void;
-    withCommands(...commands: Array<Command | {
-        new (): Command;
+    setCommandResolver(resolver: (path: string) => Promise<Command<C>>): void;
+    withCommands(...commands: Array<Command<C> | {
+        new (): Command<C>;
     } | string>): Promise<void>;
-    runCommand(command: string, ...args: any[]): Promise<number>;
+    runCommand(command: string | Command, ...args: any[]): Promise<number>;
     runHelpCommand(): Promise<number>;
-    protected registerCommand(command: Command): void;
+    protected registerCommand(command: Command<C>): void;
 }

package/dist/Cli.js

@@ -26,7 +26,6 @@ class Cli {
         this.commandRegistry = new this.CommandRegistryClass();
         this.exceptionHandler = new this.ExceptionHandlerClass();
         this.helpCommand = new this.HelpCommandClass(this.commandRegistry);
-        this.registerCommand(this.helpCommand);
     }
     setCommandResolver(resolver) {
         this.commandRegistry.setCommandResolver(resolver);
@@ -47,11 +46,14 @@ class Cli {
         }
     }
     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.command);
+        return await this.runCommand(this.helpCommand);
     }
     registerCommand(command) {
         this.commandRegistry.registerCommand(command);

package/dist/CommandRegistry.d.ts

@@ -10,6 +10,8 @@ export declare class CommandRegistry {
     setCommandResolver(resolver: (path: string) => Promise<Command>): void;
     registerCommand(command: Command, force?: boolean): void;
     loadCommandsPath(commandsPath: string): Promise<void>;
-    runCommand(ctx: any, command: string, ...args: any[]): Promise<number>;
+    runCommand(ctx: any, command: string | Command, ...args: any[]): Promise<number>;
+    private suggestCommand;
+    private askRunSimilarCommand;
     private listCommandsFiles;
 }

package/dist/CommandRegistry.js

@@ -30,6 +30,8 @@ exports.CommandRegistry = void 0;
 const path_1 = __importDefault(require("path"));
 const fs = __importStar(require("node:fs"));
 const CommandNotFoundError_1 = require("./errors/CommandNotFoundError");
+const SS = __importStar(require("string-similarity"));
+const chalk_1 = __importDefault(require("chalk"));
 class CommandRegistry {
     commands = {};
     get commandSuffix() {
@@ -78,12 +80,45 @@ class CommandRegistry {
         }
     }
     async runCommand(ctx, command, ...args) {
-        const commandToRun = this.commands[command];
-        if (!this.commands[command]) {
-            throw new CommandNotFoundError_1.CommandNotFoundError(command, this.getAvailableCommands());
+        const commandToRun = typeof command === 'string' ? this.commands[command] : command;
+        const commandSignature = typeof command === 'string' ? command : commandToRun.command;
+        if (!commandToRun) {
+            const suggestedCommand = await this.suggestCommand(commandSignature);
+            if (suggestedCommand) {
+                return await this.runCommand(ctx, suggestedCommand, ...args);
+            }
+            return 1;
         }
         return await commandToRun.run(ctx, ...args);
     }
+    async suggestCommand(command) {
+        const availableCommands = this.getAvailableCommands();
+        const similarCommands = SS.findBestMatch(command, availableCommands).ratings.filter(r => r.rating > 0.2).map(r => r.target);
+        if (similarCommands.length === 1) {
+            const commandToAsk = similarCommands[0];
+            const runCommand = await this.askRunSimilarCommand(command, commandToAsk);
+            if (runCommand) {
+                return commandToAsk;
+            }
+            else {
+                return null;
+            }
+        }
+        throw new CommandNotFoundError_1.CommandNotFoundError(command, similarCommands);
+    }
+    async askRunSimilarCommand(command, commandToAsk) {
+        const readline = require('readline').createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        console.log((0, chalk_1.default) `  {bgRed  ERROR } Command {yellow ${command}} not found.\n`);
+        return new Promise((resolve) => {
+            readline.question((0, chalk_1.default) `{green Do you want to run {yellow ${commandToAsk}} instead?} {white (yes/no)} [{yellow no}]\n > `, (answer) => {
+                resolve(answer === 'yes' || answer === 'y');
+                readline.close();
+            });
+        });
+    }
     async *listCommandsFiles(basePath) {
         const dirEntry = fs.readdirSync(basePath, { withFileTypes: true });
         for (const dirent of dirEntry) {

package/dist/errors/CommandNotFoundError.d.ts

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

package/dist/errors/CommandNotFoundError.js

@@ -1,56 +1,29 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandNotFoundError = void 0;
 const BobError_1 = require("./BobError");
-const SS = __importStar(require("string-similarity"));
 const chalk_1 = __importDefault(require("chalk"));
 class CommandNotFoundError extends BobError_1.BobError {
     command;
-    availableCommands;
-    constructor(command, availableCommands) {
+    similarCommands;
+    constructor(command, similarCommands) {
         super(`Command "${command}" not found.`);
         this.command = command;
-        this.availableCommands = availableCommands;
+        this.similarCommands = similarCommands;
     }
     pretty() {
         const log = console.log;
-        const similarCommands = this.availableCommands.filter(cmd => cmd //
-            .split(':')
-            .filter(part => SS.compareTwoStrings(part, this.command) > 0.3).length);
-        if (similarCommands.length) {
-            log((0, chalk_1.default) `  {white.bgRed  ERROR } Command "${this.command}" is not defined, Did you mean one of these?`);
-            for (const cmd of similarCommands) {
+        if (this.similarCommands.length) {
+            log((0, chalk_1.default) `  {white.bgRed  ERROR } Command "${this.command}" not found, Did you mean one of these?`);
+            for (const cmd of this.similarCommands) {
                 log((0, chalk_1.default) `  {gray ⇂ ${cmd}}`);
             }
         }
         else {
-            log((0, chalk_1.default) `  {white.bgRed  ERROR } Command "${this.command}" is not defined.`);
+            log((0, chalk_1.default) `  {white.bgRed  ERROR } Command "${this.command}" not found.`);
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bob-core",
-  "version": "0.9.4",
+  "version": "0.9.6",
   "description": "BOB Core",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",