bob-core 3.0.0-alpha.3 → 3.0.0-alpha.5

package/dist/cjs/package-DOYmkuEV.cjs

@@ -0,0 +1 @@
+require(`./src/index.js`);var e={name:`bob-core`,version:`3.0.0-alpha.5`,description:`BOB Core`,type:`module`,main:`./dist/cjs/src/index.js`,module:`./dist/esm/src/index.js`,types:`./dist/esm/src/index.d.ts`,files:[`dist`],exports:{".":{import:{types:`./dist/esm/src/index.d.ts`,default:`./dist/esm/src/index.js`},require:{types:`./dist/cjs/src/index.d.ts`,default:`./dist/cjs/src/index.js`}}},scripts:{start:`node -r @swc-node/register debug/main.ts`,build:`rm -rf ./dist && vite build`,typecheck:`tsc --noEmit`,prepack:`npm run build`,test:`vitest run`,lint:`eslint .`,"lint:fix":`eslint . --fix`},author:`Léo Hubert`,license:`ISC`,devDependencies:{"@eslint/js":`^9.39.4`,"@faker-js/faker":`^10.3.0`,"@swc-node/register":`^1.11.1`,"@trivago/prettier-plugin-sort-imports":`^5.2.2`,"@types/minimist":`^1.2.5`,"@types/node":`^20.14.5`,"@types/string-similarity":`^4.0.2`,"@vitest/coverage-v8":`^4.1.0`,eslint:`^9.39.4`,"eslint-config-prettier":`^10.1.8`,"eslint-plugin-prettier":`^5.5.5`,prettier:`^3.6.2`,tsx:`^4.21.0`,typescript:`^5.9.3`,"typescript-eslint":`^8.57.0`,vite:`^8.0.0`,"vite-plugin-dts":`^4.5.4`,vitest:`^4.1.0`},dependencies:{"@inquirer/prompts":`^8.3.0`,chalk:`^4.1.2`,"inquirer-file-selector":`^1.0.1`,minimist:`^1.2.8`}};exports.default=e;

package/dist/cjs/src/Command.d.ts

@@ -1,6 +1,6 @@
-import { CommandIO, CommandIOOptions } from './CommandIO.js';
 import { CommandParser } from './CommandParser.js';
 import { Logger } from './Logger.js';
+import { UX } from './ux/index.js';
 import { ArgumentsSchema, ContextDefinition, FlagsSchema, Parsed } from './lib/types.js';
 export type CommandRunExample = {
     description: string;
@@ -16,7 +16,7 @@ export type CommandRunOption<C = ContextDefinition> = {
     flags: Record<string, any>;
 });
 export declare abstract class Command<C extends ContextDefinition = ContextDefinition> {
-    $type: "BobCommand";
+    static $type: "BobCommand";
     static command: string;
     static description: string;
     static group?: string;
@@ -29,7 +29,8 @@ export declare abstract class Command<C extends ContextDefinition = ContextDefin
     static allowUnknownFlags: boolean;
     static strictMode: boolean;
     protected ctx: C;
-    protected io: CommandIO;
+    protected logger: Logger;
+    protected ux: UX;
     protected parser: CommandParser<FlagsSchema, FlagsSchema>;
     protected preHandle?(): Promise<void | number>;
     protected abstract handle(ctx: C, parsed: Parsed<any>): Promise<number | void> | number | void;
@@ -38,8 +39,8 @@ export declare abstract class Command<C extends ContextDefinition = ContextDefin
         flags: FlagsSchema;
         args: ArgumentsSchema;
         ctx: ContextDefinition;
-        io: CommandIO;
+        ux: UX;
     }): CommandParser<FlagsSchema, FlagsSchema>;
-    protected newCommandIO(opts: CommandIOOptions): CommandIO;
+    protected newUX(): UX;
     run(runOpts: CommandRunOption<C>): Promise<number | void>;
 }

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

@@ -1,4 +1,4 @@
-import { CommandIO } from './CommandIO.js';
+import { UX } from './ux/index.js';
 import { ArgumentsSchema, ContextDefinition, FlagDefinition, FlagReturnType, FlagsObject, FlagsSchema } from './lib/types.js';
 /**
  * Parses command-line arguments into typed flags and arguments
@@ -9,13 +9,13 @@ export declare class CommandParser<Flags extends FlagsSchema, Arguments extends
         flags: Flags;
         args: Arguments;
         ctx?: ContextDefinition;
-        io: CommandIO;
+        ux: UX;
     };
     protected flags: FlagsSchema;
     protected parsedFlags: FlagsObject<Flags> | null;
     protected args: ArgumentsSchema;
     protected parsedArguments: FlagsObject<Arguments> | null;
-    protected io: CommandIO;
+    protected ux: UX;
     protected shouldPromptForMissingFlags: boolean;
     protected shouldValidateUnknownFlags: boolean;
     protected shouldRejectExtraArguments: boolean;
@@ -23,7 +23,7 @@ export declare class CommandParser<Flags extends FlagsSchema, Arguments extends
         flags: Flags;
         args: Arguments;
         ctx?: ContextDefinition;
-        io: CommandIO;
+        ux: UX;
     });
     /**
      * Parses raw command-line arguments into structured flags and arguments
@@ -96,11 +96,11 @@ export declare class CommandParser<Flags extends FlagsSchema, Arguments extends
     allowUnknownFlags(): this;
     strictMode(): this;
     /**
-     * Prompts the user to provide a missing argument value via CommandIO
-     * Used by validate() when shouldPromptForMissingArgs is enabled
-     * @param argumentName - The name of the missing argument
-     * @param definition - The argument's definition for type and description
-     * @returns The user-provided value, or null if none given
+     * Prompts the user to provide a missing flag/argument value via its `ask` method
+     * Used by validate() when shouldPromptForMissingFlags is enabled
+     * @param name - The name of the missing flag/argument
+     * @param definition - The flag's definition (must have an `ask` method)
+     * @returns The user-provided value, or null if `ask` is not defined
      */
-    protected promptForArgument(argumentName: string, definition: FlagDefinition): Promise<string | number | string[] | null>;
+    protected promptForArgument(name: string, definition: FlagDefinition): Promise<string | number | string[] | boolean | null>;
 }

package/dist/cjs/src/CommandRegistry.d.ts

@@ -1,20 +1,20 @@
 import { Command } from './Command.js';
-import { CommandIO, CommandIOOptions } from './CommandIO.js';
 import { Logger } from './Logger.js';
 import { StringSimilarity } from './StringSimilarity.js';
+import { UX } from './ux/index.js';
 import { ContextDefinition } from './lib/types.js';
 export type CommandResolver = (path: string) => Promise<typeof Command | null>;
 export type FileImporter = (filePath: string) => Promise<unknown>;
 export type CommandRegistryOptions = {
     logger?: Logger;
+    ux?: UX;
     stringSimilarity?: StringSimilarity;
 };
 export declare class CommandRegistry {
     private readonly commands;
-    protected readonly io: CommandIO;
+    protected readonly ux: UX;
     protected readonly logger: Logger;
     private readonly stringSimilarity;
-    protected newCommandIO(opts: CommandIOOptions): CommandIO;
     constructor(opts?: CommandRegistryOptions);
     getAvailableCommands(): string[];
     getCommands(): Array<typeof Command>;

package/dist/cjs/src/CommandWithSignature.d.ts

@@ -11,12 +11,14 @@ export declare abstract class CommandWithSignature<C extends ContextDefinition =
     static helperDefinitions: Record<string, string>;
     static get command(): string;
     run(runOpts: CommandRunOption<C>): Promise<number | void>;
+    /**
+     * Convenience accessor for a parsed option value.
+     */
     protected option<T = string>(key: string): T | null;
     protected option<T = string>(key: string, defaultValue: T): NoInfer<T>;
+    /**
+     * Convenience accessor for a parsed argument value.
+     */
     protected argument<T = string>(key: string): T | null;
     protected argument<T = string>(key: string, defaultValue: T): NoInfer<T>;
-    askForConfirmation(...opts: Parameters<typeof this.io.askForConfirmation>): ReturnType<typeof this.io.askForConfirmation>;
-    askForInput(...opts: Parameters<typeof this.io.askForInput>): ReturnType<typeof this.io.askForInput>;
-    askForSelect(...opts: Parameters<typeof this.io.askForSelect>): ReturnType<typeof this.io.askForSelect>;
-    newLoader(...opts: Parameters<typeof this.io.newLoader>): ReturnType<typeof this.io.newLoader>;
 }

package/dist/cjs/src/errors/ValidationError.d.ts

@@ -0,0 +1,3 @@
+export declare class ValidationError extends Error {
+    constructor(message: string);
+}

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

@@ -6,3 +6,4 @@ export * from './CommandNotFoundError.js';
 export * from './MissingRequiredArgumentValue.js';
 export * from './MissingRequiredFlagValue.js';
 export * from './TooManyArguments.js';
+export * from './ValidationError.js';

package/dist/cjs/src/flags/boolean.d.ts

@@ -0,0 +1,2 @@
+import { BooleanFlagDef, FlagInput } from '../lib/types.js';
+export declare function booleanFlag<const T extends FlagInput<BooleanFlagDef>>(opts?: T): BooleanFlagDef & T;

package/dist/cjs/src/flags/custom.d.ts

@@ -0,0 +1,2 @@
+import { CustomFlagDef, FlagInput } from '../lib/types.js';
+export declare function customFlag<T>(defaults?: FlagInput<CustomFlagDef<T>>): <const U extends FlagInput<CustomFlagDef<T>>>(overrides?: U) => CustomFlagDef<T> & U;

package/dist/cjs/src/flags/directory.d.ts

@@ -0,0 +1,2 @@
+import { DirectoryFlagDef, FlagInput } from '../lib/types.js';
+export declare function directoryFlag<const T extends FlagInput<DirectoryFlagDef>>(opts?: T): DirectoryFlagDef & T;

package/dist/cjs/src/flags/enum.d.ts

@@ -0,0 +1,4 @@
+import { EnumFlagDef, FlagInput } from '../lib/types.js';
+export declare function enumFlag<const T extends readonly string[], const U extends FlagInput<EnumFlagDef<T>, 'options'>>(opts: {
+    options: T;
+} & U): EnumFlagDef<T> & U;

package/dist/cjs/src/flags/file.d.ts

@@ -0,0 +1,2 @@
+import { FileFlagDef, FlagInput } from '../lib/types.js';
+export declare function fileFlag<const T extends FlagInput<FileFlagDef>>(opts?: T): FileFlagDef & T;

package/dist/cjs/src/flags/helpers.d.ts

@@ -0,0 +1,25 @@
+import { FlagAskContext, FlagDefinition } from '../lib/types.js';
+/**
+ * Generates a standard prompt message for a missing required flag/argument
+ */
+export declare function formatPromptMessage(name: string, definition: FlagDefinition): string;
+/**
+ * Wraps a flag definition's parse function into a UX-compatible validator.
+ * Catches ValidationError for clean messages, other errors get a generic message.
+ */
+export declare function buildInputValidator(definition: FlagDefinition): (value: string) => string | true;
+/**
+ * Wraps a flag definition's parse function into a UX-compatible validator
+ * for multiple comma-separated values. Calls parse per-item, catches ValidationError.
+ */
+export declare function buildMultipleValuesValidator(def: FlagDefinition): (value: string) => string | true;
+/**
+ * Shared ask logic for multiple-value flags (string[], number[]).
+ * Replaces the duplicated ~15-line branch in string and number ask methods.
+ */
+export declare function askForMultipleValues(ctx: FlagAskContext): Promise<string[] | null>;
+/**
+ * Shared ask logic for simple single-input flags (file, directory, url).
+ * Replaces the identical 3-line ask implementations.
+ */
+export declare function askForSingleInput(ctx: FlagAskContext): Promise<string | null>;

package/dist/cjs/src/flags/index.d.ts

@@ -0,0 +1,28 @@
+import { booleanFlag } from './boolean.js';
+import { customFlag } from './custom.js';
+import { directoryFlag } from './directory.js';
+import { enumFlag } from './enum.js';
+import { fileFlag } from './file.js';
+import { numberFlag } from './number.js';
+import { stringFlag } from './string.js';
+import { urlFlag } from './url.js';
+export declare const Flags: {
+    string: typeof stringFlag;
+    number: typeof numberFlag;
+    boolean: typeof booleanFlag;
+    enum: typeof enumFlag;
+    file: typeof fileFlag;
+    directory: typeof directoryFlag;
+    url: typeof urlFlag;
+    custom: typeof customFlag;
+};
+export declare const Args: {
+    string: typeof stringFlag;
+    number: typeof numberFlag;
+    boolean: typeof booleanFlag;
+    enum: typeof enumFlag;
+    file: typeof fileFlag;
+    directory: typeof directoryFlag;
+    url: typeof urlFlag;
+    custom: typeof customFlag;
+};

package/dist/cjs/src/flags/number.d.ts

@@ -0,0 +1,2 @@
+import { FlagInput, NumberFlagDef } from '../lib/types.js';
+export declare function numberFlag<const T extends FlagInput<NumberFlagDef>>(opts?: T): NumberFlagDef & T;

package/dist/cjs/src/flags/string.d.ts

@@ -0,0 +1,2 @@
+import { FlagInput, StringFlagDef } from '../lib/types.js';
+export declare function stringFlag<const T extends FlagInput<StringFlagDef>>(opts?: T): StringFlagDef & T;

package/dist/cjs/src/flags/url.d.ts

@@ -0,0 +1,2 @@
+import { FlagInput, UrlFlagDef } from '../lib/types.js';
+export declare function urlFlag<const T extends FlagInput<UrlFlagDef>>(opts?: T): UrlFlagDef & T;

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

@@ -1,15 +1,15 @@
+export * from './Cli.js';
 export * from './Command.js';
-export * from './CommandIO.js';
 export * from './CommandParser.js';
 export * from './CommandRegistry.js';
 export * from './CommandSignatureParser.js';
 export * from './CommandWithSignature.js';
-export * from './Cli.js';
-export * from './Logger.js';
 export * from './ExceptionHandler.js';
+export * from './Logger.js';
 export * from './StringSimilarity.js';
-export * from './lib/types.js';
-export * from './Flags.js';
+export * from './contracts/index.js';
 export * from './errors/index.js';
+export * from './flags/index.js';
+export * from './lib/types.js';
 export * from './options/index.js';
-export * from './contracts/index.js';
+export * from './ux/index.js';