bob-core 2.0.0-beta.4 → 2.0.0-beta.6

package/dist/esm/{package-ye8xt3By.js → package-B_VxJm2q.js}

@@ -1,4 +1,4 @@
-const s = "bob-core", t = "2.0.0-beta.4", e = "BOB Core", i = "module", l = !1, n = ["dist/**"], r = { ".": { import: "./dist/esm/index.js", require: "./dist/cjs/index.js" } }, o = { "*": { "*": ["./dist/cjs/*.d.ts"] } }, c = { start: "node -r @swc-node/register debug/main.ts", build: "rimraf ./dist && vite build", typecheck: "tsc --noEmit", prepare: "npm run build", test: "vitest run" }, d = "Léo Hubert", p = "ISC", a = { "@faker-js/faker": "^10.0.0", "@swc-node/register": "^1.11.1", "@types/minimist": "^1.2.5", "@types/node": "^20.14.5", "@types/prompts": "^2.4.9", "@types/string-similarity": "^4.0.2", "@vitest/coverage-v8": "^3.2.4", rimraf: "^6.0.1", tsx: "^4.20.6", typescript: "^5.7.3", vite: "^7.1.6", "vite-plugin-dts": "^4.5.4", vitest: "^3.2.4" }, m = { chalk: "^4.1.2", minimist: "^1.2.8", prompts: "^2.4.2", "string-similarity": "^4.0.4" }, u = {
+const s = "bob-core", t = "2.0.0-beta.6", e = "BOB Core", i = "module", l = !1, n = ["dist/**"], r = { ".": { import: "./dist/esm/index.js", require: "./dist/cjs/index.js" } }, o = { "*": { "*": ["./dist/cjs/*.d.ts"] } }, c = { start: "node -r @swc-node/register debug/main.ts", build: "rimraf ./dist && vite build", typecheck: "tsc --noEmit", prepare: "npm run build", test: "vitest run" }, d = "Léo Hubert", p = "ISC", a = { "@faker-js/faker": "^10.0.0", "@swc-node/register": "^1.11.1", "@types/minimist": "^1.2.5", "@types/node": "^20.14.5", "@types/prompts": "^2.4.9", "@types/string-similarity": "^4.0.2", "@vitest/coverage-v8": "^3.2.4", rimraf: "^6.0.1", tsx: "^4.20.6", typescript: "^5.7.3", vite: "^7.1.6", "vite-plugin-dts": "^4.5.4", vitest: "^3.2.4" }, m = { chalk: "^4.1.2", minimist: "^1.2.8", prompts: "^2.4.2", "string-similarity": "^4.0.4" }, u = {
   name: s,
   version: t,
   description: e,

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

@@ -1,6 +1,5 @@
 import { OptionsSchema, OptionsObject, ArgumentsSchema, ArgumentsObject } from './lib/types.js';
 import { CommandParser } from './CommandParser.js';
-import { CommandSignatureParser } from './CommandSignatureParser.js';
 import { CommandOption } from './contracts/index.js';
 import { CommandIO } from './CommandIO.js';
 import { Logger } from './Logger.js';
@@ -28,29 +27,35 @@ export type CommandExample = {
 export declare class Command<C = any, Options extends OptionsSchema = {}, Arguments extends ArgumentsSchema = {}> {
     readonly _command: string;
     readonly description: string;
+    readonly group?: string;
     protected commandsExamples: CommandExample[];
     get command(): string;
     protected ctx: C;
     protected io: CommandIO;
     protected logger: Logger;
-    protected _handler?: CommandHandler<C, Options, Arguments>;
     protected parser: CommandParser<Options, Arguments>;
+    protected disablePromptingFlag: boolean;
+    protected preHandle?(): Promise<void | number>;
+    protected _preHandler?: CommandHandler<C, Options, Arguments>;
+    protected handle?(ctx: C, opts: CommandHandlerOptions<Options, Arguments>): Promise<number | void> | number | void;
+    protected _handler?: CommandHandler<C, Options, Arguments>;
     private tmp?;
     protected defaultOptions(): CommandOption<Command<any, any, any>>[];
     protected newCommandParser(opts: {
         io: CommandIO;
         options: Options;
         arguments: Arguments;
-    }): CommandParser<Options, Arguments> | CommandSignatureParser;
+    }): CommandParser<Options, Arguments>;
     protected newCommandIO(opts: {
         logger: Logger;
     }): CommandIO;
     constructor(command: string, opts?: {
         description?: string;
+        group?: string;
     });
-    protected preHandle?(): Promise<void | number>;
-    protected handle?(ctx: C, opts: CommandHandlerOptions<Options, Arguments>): Promise<number | void> | number | void;
-    handler(handler: CommandHandler<C, Options, Arguments>): Command<C, Options, Arguments>;
+    disablePrompting(): this;
+    preHandler(handler: CommandHandler<C, Options, Arguments>): this;
+    handler(handler: CommandHandler<C, Options, Arguments>): this;
     options<Opts extends OptionsSchema>(opts: Opts): Command<C, Options & Opts, Arguments>;
     arguments<Args extends ArgumentsSchema>(args: Args): Command<C, Options, Arguments & Args>;
     run(opts: CommandRunOption<C, Options, Arguments>): Promise<number | void>;

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

@@ -27,6 +27,15 @@ export declare class CommandIO {
         min?: number;
         max?: number;
     }): Promise<string | null>;
+    askForDate(message: string, defaultValue?: Date, opts?: {
+        validate?: (value: Date) => boolean | string;
+        mask?: string;
+    }): Promise<Date | null>;
+    askForList(message: string, defaultValue?: string | number, opts?: {
+        validate?: (value: string[]) => boolean | string;
+        format?: (value: string) => string;
+        separator?: string;
+    }): Promise<string[] | null>;
     askForToggle(message: string, defaultValue?: boolean, opts?: {
         active?: string;
         inactive?: string;

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

@@ -1,4 +1,4 @@
-import { OptionsSchema, OptionReturnType, OptionsObject } from './lib/types.js';
+import { OptionsSchema, OptionReturnType, OptionsObject, OptionDefinition } from './lib/types.js';
 import { OptionDetails } from './lib/optionHelpers.js';
 import { CommandIO } from './CommandIO.js';
 /**
@@ -11,6 +11,7 @@ export declare class CommandParser<Options extends OptionsSchema, Arguments exte
     protected arguments: Arguments;
     protected parsedArguments: OptionsObject<Arguments> | null;
     protected io: CommandIO;
+    protected shouldPromptForMissingOptions: boolean;
     constructor(opts: {
         io: CommandIO;
         options: Options;
@@ -39,6 +40,7 @@ export declare class CommandParser<Options extends OptionsSchema, Arguments exte
      * @throws {Error} If init() has not been called yet
      */
     option<OptsName extends keyof Options>(name: OptsName): OptionReturnType<Options[OptsName]>;
+    setOption<OptsName extends keyof Options>(name: OptsName, value: OptionReturnType<Options[OptsName]>): void;
     /**
      * Retrieves a parsed argument value by name
      * @param name - The argument name
@@ -46,6 +48,7 @@ export declare class CommandParser<Options extends OptionsSchema, Arguments exte
      * @throws {Error} If init() has not been called yet
      */
     argument<ArgName extends keyof Arguments>(name: ArgName): OptionReturnType<Arguments[ArgName]>;
+    setArgument<ArgName extends keyof Arguments>(name: ArgName, value: OptionReturnType<Arguments[ArgName]>): void;
     /**
      * Validates that all provided options are recognized
      * @throws {InvalidOption} If an unknown option is found
@@ -77,4 +80,17 @@ export declare class CommandParser<Options extends OptionsSchema, Arguments exte
     argumentDefinitions(): Record<string, OptionDetails>;
     availableOptions(): string[];
     availableArguments(): string[];
+    /**
+     * Disables prompting for missing argument values
+     * Useful for non-interactive environments
+     */
+    disablePrompting(): 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 argDef - The argument's definition for type and description
+     * @returns The user-provided value, or null if none given
+     */
+    protected promptForArgument(argumentName: string, argDef: OptionDefinition): Promise<string | number | string[] | null>;
 }

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

@@ -1,7 +1,7 @@
 import { CommandIO } from './CommandIO.js';
 import { Command } from './Command.js';
 import { Logger } from './Logger.js';
-export type CommandResolver = (path: string) => Promise<Command>;
+export type CommandResolver = (path: string) => Promise<Command | null>;
 export declare class CommandRegistry {
     private readonly commands;
     protected readonly io: CommandIO;
@@ -12,6 +12,8 @@ export declare class CommandRegistry {
     getCommands(): Array<Command>;
     private commandResolver;
     setCommandResolver(resolver: CommandResolver): void;
+    fileCheck: (filePath: string) => boolean;
+    setFileCheck(check: (filePath: string) => boolean): this;
     registerCommand(command: Command<any, any, any>, force?: boolean): void;
     loadCommandsPath(commandsPath: string): Promise<void>;
     runCommand(ctx: any, command: string | Command, ...args: any[]): Promise<number>;

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

@@ -1,6 +1,6 @@
 import { CommandOption } from './contracts/index.js';
 import { CommandIO } from './CommandIO.js';
-import { OptionsObject, OptionsSchema } from './lib/types.js';
+import { OptionsSchema } from './lib/types.js';
 import { CommandParser } from './CommandParser.js';
 /**
  * Extends CommandParser to parse command signatures like "command {arg} {--option}"
@@ -8,8 +8,6 @@ import { CommandParser } from './CommandParser.js';
  */
 export declare class CommandSignatureParser<Opts extends OptionsSchema = any, Args extends OptionsSchema = any> extends CommandParser<Opts, Args> {
     readonly command: string;
-    private readonly argumentsSchema;
-    private readonly optionsSchema;
     constructor(opts: {
         io: CommandIO;
         signature: string;
@@ -23,38 +21,6 @@ export declare class CommandSignatureParser<Opts extends OptionsSchema = any, Ar
      * Example: "migrate {name} {--force}" -> { command: "migrate", arguments: {name: ...}, options: {force: ...} }
      */
     private static parseSignature;
-    /**
-     * Retrieves an option value by name, with signature validation
-     */
-    option(name: any): any;
-    /**
-     * Sets an option value programmatically
-     */
-    setOption(name: string, value: any): void;
-    /**
-     * Retrieves the description/help text for an option
-     */
-    optionHelp(name: string): string | undefined;
-    /**
-     * Retrieves the description/help text for an argument
-     */
-    argumentHelp(name: string): string | undefined;
-    /**
-     * Retrieves an argument value by name, with signature validation
-     */
-    argument(name: any): any;
-    /**
-     * Sets an argument value programmatically
-     */
-    setArgument(name: string, value: any): void;
-    /**
-     * Returns all argument definitions from the signature
-     */
-    getArgumentSignatures(): OptionsSchema;
-    /**
-     * Returns all option definitions from the signature
-     */
-    getOptionSignatures(): OptionsSchema;
     /**
      * Parses a single parameter signature like "{name}" or "{--force}" or "{files*}"
      * Extracts name, type, default value, aliases, description, etc.
@@ -70,16 +36,4 @@ export declare class CommandSignatureParser<Opts extends OptionsSchema = any, Ar
      * - {--opt|o}      -> option with alias
      */
     private static parseParamSignature;
-    /**
-     * Validates that all required arguments are present
-     * If missing, prompts the user via CommandIO to provide them
-     * @throws {MissingRequiredArgumentValue} If a required argument cannot be obtained
-     */
-    validate(): Promise<void>;
-    /**
-     * Prompts the user to provide a missing argument value via CommandIO
-     */
-    private promptForArgument;
-    optionValues(): OptionsObject<Opts>;
-    argumentValues(): OptionsObject<Args>;
 }

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

@@ -14,22 +14,13 @@ export declare abstract class CommandWithSignature<C = any, Opts extends Options
         io: CommandIO;
         options: Opts;
         arguments: Args;
-    }): CommandSignatureParser;
+    }): CommandSignatureParser<Opts, Args>;
     constructor();
     protected abstract handle(ctx: C, opts: CommandHandlerOptions<Opts, Args>): Promise<number | void>;
-    protected setOption(name: string, value: any): void;
-    protected setArgument(name: string, value: any): void;
     protected option<T = string>(key: string): T | null;
     protected option<T = string>(key: string, defaultValue: T): NoInfer<T>;
-    protected optionBoolean(key: string, defaultValue?: boolean): boolean;
-    protected optionArray<T = string>(key: string, defaultValue?: Array<T>): Array<NoInfer<T>>;
-    protected optionNumber(key: string): number | null;
-    protected optionNumber(key: string, defaultValue: number): number;
     protected argument<T = string>(key: string): T | null;
     protected argument<T = string>(key: string, defaultValue: T): NoInfer<T>;
-    protected argumentArray<T = string>(key: string, defaultValue?: Array<any>): Array<T>;
-    protected argumentBoolean(key: string, defaultValue?: boolean): boolean;
-    protected argumentNumber(key: string, defaultValue?: number | null): number | null;
     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>;

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

@@ -3,7 +3,5 @@ export * from './BadCommandParameter.js';
 export * from './BadCommandOption.js';
 export * from './InvalidOption.js';
 export * from './CommandNotFoundError.js';
-export * from './MissingSignatureArgument.js';
-export * from './MissingSignatureOption.js';
 export * from './MissingRequiredArgumentValue.js';
 export * from './MissingRequiredOptionValue.js';

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

@@ -1,5 +1,5 @@
 import { Option, OptionDefinition, OptionReturnType } from './types.js';
 export declare function getOptionPrimitiveDefaultValue<Opts extends Option>(type: Opts): OptionReturnType<Opts>;
-export declare function getOptionDefaultValue<Opts extends Option>(option: Opts): OptionReturnType<Opts>;
+export declare function getOptionDefaultValue<Opts extends Option>(option: Opts): OptionReturnType<Opts> | null;
 export type OptionDetails = Required<OptionDefinition>;
 export declare function getOptionDetails(option: Option): OptionDetails;

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

@@ -1,4 +1,4 @@
-export type OptionPrimitive = 'string' | 'number' | 'boolean' | ['string'] | ['number'];
+export type OptionPrimitive = 'secret' | 'string' | 'number' | 'boolean' | ['string'] | ['number'];
 export type OptionDefinition = {
     type: OptionPrimitive;
     description?: string;
@@ -8,7 +8,7 @@ export type OptionDefinition = {
     variadic?: boolean;
 };
 export type Option = OptionPrimitive | OptionDefinition;
-export type OptionType<O extends Option> = O extends 'string' ? string : O extends 'number' ? number : O extends 'boolean' ? boolean : O extends Array<'string'> ? Array<string> : O extends Array<'number'> ? Array<number> : O extends {
+export type OptionType<O extends Option> = O extends 'secret' ? string : O extends 'string' ? string : O extends 'number' ? number : O extends 'boolean' ? boolean : O extends Array<'string'> ? Array<string> : O extends Array<'number'> ? Array<number> : O extends {
     type: infer T extends Option;
 } ? OptionType<T> : never;
 export type IsRequired<O extends Option> = O extends {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bob-core",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "description": "BOB Core",
   "type": "module",
   "sideEffects": false,

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

@@ -1,8 +0,0 @@
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class MissingSignatureArgument extends BobError {
-    private argument;
-    private argumentsSchema;
-    constructor(argument: string, argumentsSchema: OptionsSchema);
-    pretty(io: any): void;
-}

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

@@ -1,8 +0,0 @@
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class MissingSignatureOption extends BobError {
-    private option;
-    private optionsSchema;
-    constructor(option: string, optionsSchema: OptionsSchema);
-    pretty(io: any): void;
-}

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

@@ -1,8 +0,0 @@
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class MissingSignatureArgument extends BobError {
-    private argument;
-    private argumentsSchema;
-    constructor(argument: string, argumentsSchema: OptionsSchema);
-    pretty(io: any): void;
-}

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

@@ -1,8 +0,0 @@
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class MissingSignatureOption extends BobError {
-    private option;
-    private optionsSchema;
-    constructor(option: string, optionsSchema: OptionsSchema);
-    pretty(io: any): void;
-}