bob-core 1.4.0 → 2.0.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +316 -175
  2. package/dist/cjs/index.js +18 -6
  3. package/dist/cjs/package-D82wayAe.cjs +1 -0
  4. package/dist/cjs/src/Cli.d.ts +21 -12
  5. package/dist/cjs/src/Command.d.ts +51 -35
  6. package/dist/cjs/src/CommandIO.d.ts +21 -1
  7. package/dist/cjs/src/CommandParser.d.ts +92 -44
  8. package/dist/cjs/src/CommandRegistry.d.ts +12 -7
  9. package/dist/cjs/src/CommandSignatureParser.d.ts +40 -0
  10. package/dist/cjs/src/CommandWithSignature.d.ts +28 -0
  11. package/dist/cjs/src/ExceptionHandler.d.ts +3 -0
  12. package/dist/cjs/src/Logger.d.ts +16 -0
  13. package/dist/cjs/src/commands/HelpCommand.d.ts +1 -3
  14. package/dist/cjs/src/contracts/CommandOption.d.ts +4 -5
  15. package/dist/cjs/src/contracts/LoggerContract.d.ts +13 -0
  16. package/dist/cjs/src/contracts/index.d.ts +1 -0
  17. package/dist/cjs/src/errors/BadCommandOption.d.ts +2 -1
  18. package/dist/cjs/src/errors/BadCommandParameter.d.ts +2 -1
  19. package/dist/cjs/src/errors/BobError.d.ts +2 -1
  20. package/dist/cjs/src/errors/CommandNotFoundError.d.ts +2 -1
  21. package/dist/cjs/src/errors/InvalidOption.d.ts +5 -4
  22. package/dist/cjs/src/errors/MissingRequiredArgumentValue.d.ts +4 -4
  23. package/dist/cjs/src/errors/MissingRequiredOptionValue.d.ts +7 -0
  24. package/dist/cjs/src/errors/index.d.ts +4 -0
  25. package/dist/cjs/src/index.d.ts +8 -1
  26. package/dist/cjs/src/lib/optionHelpers.d.ts +5 -0
  27. package/dist/cjs/src/lib/types.d.ts +33 -0
  28. package/dist/cjs/src/lib/valueConverter.d.ts +10 -0
  29. package/dist/cjs/src/options/HelpOption.d.ts +3 -1
  30. package/dist/cjs/src/testFixtures.d.ts +11 -0
  31. package/dist/esm/index.js +1108 -475
  32. package/dist/esm/package-O5nP1XlU.js +31 -0
  33. package/dist/esm/src/Cli.d.ts +21 -12
  34. package/dist/esm/src/Command.d.ts +51 -35
  35. package/dist/esm/src/CommandIO.d.ts +21 -1
  36. package/dist/esm/src/CommandParser.d.ts +92 -44
  37. package/dist/esm/src/CommandRegistry.d.ts +12 -7
  38. package/dist/esm/src/CommandSignatureParser.d.ts +40 -0
  39. package/dist/esm/src/CommandWithSignature.d.ts +28 -0
  40. package/dist/esm/src/ExceptionHandler.d.ts +3 -0
  41. package/dist/esm/src/Logger.d.ts +16 -0
  42. package/dist/esm/src/commands/HelpCommand.d.ts +1 -3
  43. package/dist/esm/src/contracts/CommandOption.d.ts +4 -5
  44. package/dist/esm/src/contracts/LoggerContract.d.ts +13 -0
  45. package/dist/esm/src/contracts/index.d.ts +1 -0
  46. package/dist/esm/src/errors/BadCommandOption.d.ts +2 -1
  47. package/dist/esm/src/errors/BadCommandParameter.d.ts +2 -1
  48. package/dist/esm/src/errors/BobError.d.ts +2 -1
  49. package/dist/esm/src/errors/CommandNotFoundError.d.ts +2 -1
  50. package/dist/esm/src/errors/InvalidOption.d.ts +5 -4
  51. package/dist/esm/src/errors/MissingRequiredArgumentValue.d.ts +4 -4
  52. package/dist/esm/src/errors/MissingRequiredOptionValue.d.ts +7 -0
  53. package/dist/esm/src/errors/index.d.ts +4 -0
  54. package/dist/esm/src/index.d.ts +8 -1
  55. package/dist/esm/src/lib/optionHelpers.d.ts +5 -0
  56. package/dist/esm/src/lib/types.d.ts +33 -0
  57. package/dist/esm/src/lib/valueConverter.d.ts +10 -0
  58. package/dist/esm/src/options/HelpOption.d.ts +3 -1
  59. package/dist/esm/src/testFixtures.d.ts +11 -0
  60. package/package.json +17 -4
  61. package/dist/cjs/package-6sByjm31.cjs +0 -1
  62. package/dist/cjs/src/errors/MissingSignatureArgument.d.ts +0 -8
  63. package/dist/cjs/src/errors/MissingSignatureOption.d.ts +0 -8
  64. package/dist/esm/package-eljsfLkU.js +0 -31
  65. package/dist/esm/src/errors/MissingSignatureArgument.d.ts +0 -8
  66. package/dist/esm/src/errors/MissingSignatureOption.d.ts +0 -8
@@ -0,0 +1,31 @@
1
+ const t = "bob-core", e = "2.0.0-beta.10", s = "BOB Core", i = "module", m = !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", prepack: "npm run build", test: "vitest run", lint: "eslint .", "lint:fix": "eslint . --fix" }, p = "Léo Hubert", d = "ISC", l = { "@eslint/js": "^9.37.0", "@faker-js/faker": "^10.0.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/prompts": "^2.4.9", "@types/string-similarity": "^4.0.2", "@vitest/coverage-v8": "^3.2.4", eslint: "^9.37.0", "eslint-config-prettier": "^10.1.8", "eslint-plugin-prettier": "^5.5.4", prettier: "^3.6.2", rimraf: "^6.0.1", tsx: "^4.20.6", typescript: "^5.7.3", "typescript-eslint": "^8.46.0", vite: "^7.1.6", "vite-plugin-dts": "^4.5.4", vitest: "^3.2.4" }, a = { chalk: "^5.6.2", minimist: "^1.2.8", prompts: "^2.4.2", "string-similarity": "^4.0.4" }, f = {
2
+ name: t,
3
+ version: e,
4
+ description: s,
5
+ type: i,
6
+ sideEffects: !1,
7
+ files: n,
8
+ exports: r,
9
+ typesVersions: o,
10
+ scripts: c,
11
+ author: p,
12
+ license: d,
13
+ devDependencies: l,
14
+ dependencies: a
15
+ };
16
+ export {
17
+ p as author,
18
+ f as default,
19
+ a as dependencies,
20
+ s as description,
21
+ l as devDependencies,
22
+ r as exports,
23
+ n as files,
24
+ d as license,
25
+ t as name,
26
+ c as scripts,
27
+ m as sideEffects,
28
+ i as type,
29
+ o as typesVersions,
30
+ e as version
31
+ };
@@ -1,26 +1,35 @@
1
- import { CommandRegistry } from './CommandRegistry.js';
2
1
  import { Command } from './Command.js';
3
- import { default as HelpCommand } from './commands/HelpCommand.js';
2
+ import { CommandRegistry, CommandResolver, FileImporter } from './CommandRegistry.js';
4
3
  import { ExceptionHandler } from './ExceptionHandler.js';
5
- export type CliOptions<C> = {
4
+ import { Logger } from './Logger.js';
5
+ import { default as HelpCommand, HelpCommandOptions } from './commands/HelpCommand.js';
6
+ import { ContextDefinition, OptionsSchema } from './lib/types.js';
7
+ export type CliOptions<C extends ContextDefinition = ContextDefinition> = {
6
8
  ctx?: C;
7
9
  name?: string;
8
10
  version?: string;
11
+ logger?: Logger;
9
12
  };
10
- export declare class Cli<C> {
13
+ export declare class Cli<C extends ContextDefinition = ContextDefinition> {
14
+ private readonly ctx?;
15
+ private readonly logger;
11
16
  readonly commandRegistry: CommandRegistry;
12
17
  private readonly exceptionHandler;
13
- private readonly ctx?;
14
18
  private readonly helpCommand;
15
- get CommandRegistryClass(): typeof CommandRegistry;
16
- get HelpCommandClass(): typeof HelpCommand;
17
- get ExceptionHandlerClass(): typeof ExceptionHandler;
19
+ protected newCommandRegistry(opts: {
20
+ logger: Logger;
21
+ }): CommandRegistry;
22
+ protected newHelpCommand(opts: HelpCommandOptions): HelpCommand;
23
+ protected newExceptionHandler(opts: {
24
+ logger: Logger;
25
+ }): ExceptionHandler;
18
26
  constructor(opts?: CliOptions<C>);
19
- setCommandResolver(resolver: (path: string) => Promise<Command<C>>): void;
20
- withCommands(...commands: Array<Command<C> | {
27
+ withCommandResolver(resolver: CommandResolver): this;
28
+ withFileImporter(importer: FileImporter): this;
29
+ withCommands(...commands: Array<Command<C, OptionsSchema, OptionsSchema> | {
21
30
  new (): Command<C>;
22
31
  } | string>): Promise<void>;
23
- runCommand(command: string | Command, ...args: any[]): Promise<number>;
32
+ runCommand(command: string | Command | undefined, ...args: string[]): Promise<number>;
24
33
  runHelpCommand(): Promise<number>;
25
- protected registerCommand(command: Command<C>): void;
34
+ protected registerCommand(command: Command<C, OptionsSchema, OptionsSchema>): void;
26
35
  }
@@ -1,45 +1,61 @@
1
+ import { CommandIO } from './CommandIO.js';
1
2
  import { CommandParser } from './CommandParser.js';
3
+ import { Logger } from './Logger.js';
2
4
  import { CommandOption } from './contracts/index.js';
3
- import { CommandIO } from './CommandIO.js';
5
+ import { ArgumentsObject, ArgumentsSchema, ContextDefinition, OptionsObject, OptionsSchema } from './lib/types.js';
6
+ export type CommandHandlerOptions<Options extends OptionsSchema, Arguments extends ArgumentsSchema> = {
7
+ options: OptionsObject<Options>;
8
+ arguments: ArgumentsObject<Arguments>;
9
+ };
10
+ export type CommandHandler<C extends ContextDefinition, Options extends OptionsSchema, Arguments extends ArgumentsSchema> = (ctx: C, opts: CommandHandlerOptions<Options, Arguments>) => Promise<number | void> | number | void;
11
+ export type CommandRunOption<C, Options extends OptionsSchema, Arguments extends ArgumentsSchema> = {
12
+ logger: Logger;
13
+ ctx: C;
14
+ } & ({
15
+ args: string[];
16
+ } | {
17
+ options: OptionsObject<Options>;
18
+ arguments: ArgumentsObject<Arguments>;
19
+ });
4
20
  export type CommandExample = {
5
21
  description: string;
6
22
  command: string;
7
23
  };
8
- export declare abstract class Command<C = any> {
9
- abstract signature: string;
10
- abstract description: string;
11
- protected ctx: C;
12
- protected helperDefinitions: {
13
- [key: string]: string;
14
- };
24
+ export declare class Command<C extends ContextDefinition = ContextDefinition, Options extends OptionsSchema = OptionsSchema, Arguments extends ArgumentsSchema = ArgumentsSchema> {
25
+ readonly _command: string;
26
+ readonly description: string;
27
+ readonly group?: string;
15
28
  protected commandsExamples: CommandExample[];
16
- protected parser: CommandParser;
29
+ get command(): string;
30
+ protected ctx: C | undefined;
17
31
  protected io: CommandIO;
18
- protected abstract handle(): Promise<void | number>;
32
+ protected logger: Logger;
33
+ protected parser: CommandParser<Options, Arguments>;
34
+ protected disablePromptingFlag: boolean;
19
35
  protected preHandle?(): Promise<void | number>;
20
- protected get CommandParserClass(): typeof CommandParser;
21
- protected get CommandIOClass(): typeof CommandIO;
22
- protected defaultOptions(): CommandOption<Command<C>>[];
23
- get command(): string;
24
- run(ctx: C, ...args: any[]): Promise<number>;
25
- protected setOption(name: string, value: any): void;
26
- protected setArgument(name: string, value: any): void;
27
- protected option<T = string>(key: string): T | null;
28
- protected option<T = string>(key: string, defaultValue: T): NoInfer<T>;
29
- protected optionBoolean(key: string, defaultValue?: boolean): boolean;
30
- protected optionArray<T = string>(key: string, defaultValue?: Array<T>): Array<NoInfer<T>>;
31
- protected optionNumber(key: string): number | null;
32
- protected optionNumber(key: string, defaultValue: number): number;
33
- protected argument<T = string>(key: string): T | null;
34
- protected argument<T = string>(key: string, defaultValue: T): NoInfer<T>;
35
- protected argumentArray<T = string>(key: string, defaultValue?: Array<any>): Array<T>;
36
- protected argumentBoolean(key: string, defaultValue?: boolean): boolean;
37
- protected argumentNumber(key: string, defaultValue?: number | null): number | null;
38
- /**
39
- * Prompt utils
40
- */
41
- askForConfirmation(...opts: Parameters<typeof this.io.askForConfirmation>): ReturnType<typeof this.io.askForConfirmation>;
42
- askForInput(...opts: Parameters<typeof this.io.askForInput>): ReturnType<typeof this.io.askForInput>;
43
- askForSelect(...opts: Parameters<typeof this.io.askForSelect>): ReturnType<typeof this.io.askForSelect>;
44
- newLoader(...opts: Parameters<typeof this.io.newLoader>): ReturnType<typeof this.io.newLoader>;
36
+ protected _preHandler?: CommandHandler<C, Options, Arguments>;
37
+ protected handle?(ctx: C, opts: CommandHandlerOptions<Options, Arguments>): Promise<number | void> | number | void;
38
+ protected _handler?: CommandHandler<C, Options, Arguments>;
39
+ private tmp?;
40
+ protected defaultOptions(): CommandOption<Command>[];
41
+ protected newCommandParser(opts: {
42
+ io: CommandIO;
43
+ options: Options;
44
+ arguments: Arguments;
45
+ }): CommandParser<Options, Arguments>;
46
+ protected newCommandIO(opts: {
47
+ logger: Logger;
48
+ }): CommandIO;
49
+ constructor(command: string, opts?: {
50
+ description?: string;
51
+ group?: string;
52
+ options?: Options;
53
+ arguments?: Arguments;
54
+ });
55
+ disablePrompting(): this;
56
+ preHandler(handler: CommandHandler<C, Options, Arguments>): this;
57
+ handler(handler: CommandHandler<C, Options, Arguments>): this;
58
+ options<Opts extends OptionsSchema>(opts: Opts): Command<C, Options & Opts, Arguments>;
59
+ arguments<Args extends ArgumentsSchema>(args: Args): Command<C, Options, Arguments & Args>;
60
+ run(opts: CommandRunOption<C, Options, Arguments>): Promise<number | void>;
45
61
  }
@@ -1,11 +1,22 @@
1
+ import { Logger } from './Logger.js';
1
2
  export type SelectOption = {
2
3
  title: string;
3
- value?: any;
4
+ value?: unknown;
4
5
  disabled?: boolean | undefined;
5
6
  selected?: boolean | undefined;
6
7
  description?: string | undefined;
7
8
  };
8
9
  export declare class CommandIO {
10
+ private logger;
11
+ constructor(logger: Logger);
12
+ /**
13
+ * Logger methods
14
+ */
15
+ log(...args: unknown[]): void;
16
+ info(...args: unknown[]): void;
17
+ warn(...args: unknown[]): void;
18
+ error(...args: unknown[]): void;
19
+ debug(...args: unknown[]): void;
9
20
  /**
10
21
  * Prompt utils
11
22
  */
@@ -16,6 +27,15 @@ export declare class CommandIO {
16
27
  min?: number;
17
28
  max?: number;
18
29
  }): Promise<string | null>;
30
+ askForDate(message: string, defaultValue?: Date, opts?: {
31
+ validate?: (value: Date) => boolean | string;
32
+ mask?: string;
33
+ }): Promise<Date | null>;
34
+ askForList(message: string, defaultValue?: string | number, opts?: {
35
+ validate?: (value: string) => boolean | string;
36
+ format?: (value: string) => string;
37
+ separator?: string;
38
+ }): Promise<string[] | null>;
19
39
  askForToggle(message: string, defaultValue?: boolean, opts?: {
20
40
  active?: string;
21
41
  inactive?: string;
@@ -1,48 +1,96 @@
1
- import { CommandOption } from './contracts/index.js';
2
1
  import { CommandIO } from './CommandIO.js';
3
- export type ArgSignature = {
4
- name: string;
5
- type: 'string' | 'boolean' | 'array';
6
- optional?: boolean;
7
- variadic?: boolean;
8
- alias?: string[];
9
- help?: string;
10
- defaultValue: string | boolean | Array<string> | null;
11
- isOption?: boolean;
12
- };
13
- export declare class CommandParser {
14
- protected readonly io: CommandIO;
15
- protected readonly signature: string;
16
- protected readonly helperDefinitions: {
17
- [key: string]: string;
2
+ import { OptionDetails } from './lib/optionHelpers.js';
3
+ import { OptionDefinition, OptionReturnType, OptionsObject, OptionsSchema } from './lib/types.js';
4
+ /**
5
+ * Parses command-line arguments into typed options and arguments
6
+ * Handles validation, type conversion, and default values
7
+ */
8
+ export declare class CommandParser<Options extends OptionsSchema, Arguments extends OptionsSchema> {
9
+ protected options: Options;
10
+ protected parsedOptions: OptionsObject<Options> | null;
11
+ protected arguments: Arguments;
12
+ protected parsedArguments: OptionsObject<Arguments> | null;
13
+ protected io: CommandIO;
14
+ protected shouldPromptForMissingOptions: boolean;
15
+ constructor(opts: {
16
+ io: CommandIO;
17
+ options: Options;
18
+ arguments: Arguments;
19
+ });
20
+ /**
21
+ * Parses raw command-line arguments into structured options and arguments
22
+ * @param args - Raw command line arguments (typically from process.argv.slice(2))
23
+ * @returns Object containing parsed options and arguments
24
+ * @throws {InvalidOption} If an unknown option is provided
25
+ * @throws {BadCommandOption} If a value cannot be converted to the expected type
26
+ */
27
+ init(args: string[]): {
28
+ options: OptionsObject<Options>;
29
+ arguments: OptionsObject<Arguments>;
18
30
  };
19
- protected readonly defaultCommandOptions: CommandOption<any>[];
20
- command: string;
21
- private arguments;
22
- private options;
23
- private argumentsSignature;
24
- private optionSignatures;
25
- private optionAliases;
26
- constructor(io: CommandIO, signature: string, helperDefinitions: {
27
- [key: string]: string;
28
- }, defaultCommandOptions: CommandOption<any>[], ...args: any[]);
29
- option(name: string): any;
30
- setOption(name: string, value: any): void;
31
- optionHelp(name: string): string | undefined;
32
- argument(name: string): any;
33
- setArgument(name: string, value: any): void;
34
- argumentHelp(name: string): string | undefined;
35
- getArgumentSignatures(): {
36
- [argument: string]: ArgSignature;
37
- };
38
- getOptionSignatures(): {
39
- [option: string]: ArgSignature;
40
- };
41
- private getParamValue;
42
- private handleArguments;
43
- private handleOptions;
44
- private parseSignature;
45
- private parseDefaultOptions;
46
- private parseParamSignature;
31
+ /**
32
+ * Validates the parsed options and arguments
33
+ * @throws {Error} If validation fails
34
+ */
47
35
  validate(): Promise<void>;
36
+ /**
37
+ * Retrieves a parsed option value by name
38
+ * @param name - The option name
39
+ * @returns The typed option value
40
+ * @throws {Error} If init() has not been called yet
41
+ */
42
+ option<OptsName extends keyof Options>(name: OptsName): OptionReturnType<Options[OptsName]>;
43
+ setOption<OptsName extends keyof Options>(name: OptsName, value: OptionReturnType<Options[OptsName]>): void;
44
+ /**
45
+ * Retrieves a parsed argument value by name
46
+ * @param name - The argument name
47
+ * @returns The typed argument value
48
+ * @throws {Error} If init() has not been called yet
49
+ */
50
+ argument<ArgName extends keyof Arguments>(name: ArgName): OptionReturnType<Arguments[ArgName]>;
51
+ setArgument<ArgName extends keyof Arguments>(name: ArgName, value: OptionReturnType<Arguments[ArgName]>): void;
52
+ /**
53
+ * Validates that all provided options are recognized
54
+ * @throws {InvalidOption} If an unknown option is found
55
+ */
56
+ private validateUnknownOptions;
57
+ /**
58
+ * Processes named options from minimist output
59
+ */
60
+ private handleOptions;
61
+ /**
62
+ * Processes positional arguments from minimist output
63
+ */
64
+ private handleArguments;
65
+ /**
66
+ * Handles variadic arguments that consume all remaining positional values
67
+ */
68
+ private handleVariadicArgument;
69
+ /**
70
+ * Resolves a single positional argument value with defaults and type conversion
71
+ * Note: Does not validate required arguments - validation happens in subclass validate() methods
72
+ */
73
+ private resolveArgumentValue;
74
+ /**
75
+ * Resolves an option value from the parsed option values object
76
+ * Handles alias resolution, defaults, and type conversion
77
+ */
78
+ private resolveOptionValue;
79
+ optionDefinitions(): Record<string, OptionDetails>;
80
+ argumentDefinitions(): Record<string, OptionDetails>;
81
+ availableOptions(): string[];
82
+ availableArguments(): string[];
83
+ /**
84
+ * Disables prompting for missing argument values
85
+ * Useful for non-interactive environments
86
+ */
87
+ disablePrompting(): this;
88
+ /**
89
+ * Prompts the user to provide a missing argument value via CommandIO
90
+ * Used by validate() when shouldPromptForMissingArgs is enabled
91
+ * @param argumentName - The name of the missing argument
92
+ * @param argDef - The argument's definition for type and description
93
+ * @returns The user-provided value, or null if none given
94
+ */
95
+ protected promptForArgument(argumentName: string, argDef: OptionDefinition): Promise<string | number | string[] | null>;
48
96
  }
@@ -1,19 +1,24 @@
1
1
  import { Command } from './Command.js';
2
2
  import { CommandIO } from './CommandIO.js';
3
- export type CommandResolver = (path: string) => Promise<Command>;
3
+ import { Logger } from './Logger.js';
4
+ import { ArgumentsSchema, ContextDefinition, OptionsSchema } from './lib/types.js';
5
+ export type CommandResolver = (path: string) => Promise<Command | null>;
6
+ export type FileImporter = (filePath: string) => Promise<unknown>;
4
7
  export declare class CommandRegistry {
5
8
  private readonly commands;
6
9
  protected readonly io: CommandIO;
7
- get commandSuffix(): string;
10
+ protected readonly logger: Logger;
8
11
  protected get CommandIOClass(): typeof CommandIO;
9
- constructor();
12
+ constructor(logger?: Logger);
10
13
  getAvailableCommands(): string[];
11
- getCommands(): Command[];
14
+ getCommands(): Array<Command>;
15
+ private importFile;
12
16
  private commandResolver;
13
- setCommandResolver(resolver: (path: string) => Promise<Command>): void;
14
- registerCommand(command: Command, force?: boolean): void;
17
+ withCommandResolver(resolver: CommandResolver): this;
18
+ withFileImporter(importer: FileImporter): this;
19
+ registerCommand<C extends ContextDefinition = ContextDefinition, Opts extends OptionsSchema = OptionsSchema, Args extends ArgumentsSchema = ArgumentsSchema>(command: Command<C, Opts, Args>, force?: boolean): void;
15
20
  loadCommandsPath(commandsPath: string): Promise<void>;
16
- runCommand(ctx: any, command: string | Command, ...args: any[]): Promise<number>;
21
+ runCommand(ctx: ContextDefinition, command: string | Command, ...args: string[]): Promise<number>;
17
22
  private suggestCommand;
18
23
  private askRunSimilarCommand;
19
24
  private listCommandsFiles;
@@ -0,0 +1,40 @@
1
+ import { Command } from './Command.js';
2
+ import { CommandIO } from './CommandIO.js';
3
+ import { CommandParser } from './CommandParser.js';
4
+ import { CommandOption } from './contracts/index.js';
5
+ import { OptionsSchema } from './lib/types.js';
6
+ /**
7
+ * Extends CommandParser to parse command signatures like "command {arg} {--option}"
8
+ * Handles interactive prompting for missing required arguments via CommandIO
9
+ */
10
+ export declare class CommandSignatureParser<Opts extends OptionsSchema = OptionsSchema, Args extends OptionsSchema = OptionsSchema> extends CommandParser<Opts, Args> {
11
+ readonly command: string;
12
+ constructor(opts: {
13
+ io: CommandIO;
14
+ signature: string;
15
+ helperDefinitions: {
16
+ [key: string]: string;
17
+ };
18
+ defaultOptions: CommandOption<Command>[];
19
+ });
20
+ /**
21
+ * Parses command signature string into command name and parameter schemas
22
+ * Example: "migrate {name} {--force}" -> { command: "migrate", arguments: {name: ...}, options: {force: ...} }
23
+ */
24
+ private static parseSignature;
25
+ /**
26
+ * Parses a single parameter signature like "{name}" or "{--force}" or "{files*}"
27
+ * Extracts name, type, default value, aliases, description, etc.
28
+ *
29
+ * Signature syntax:
30
+ * - {arg} -> required string argument
31
+ * - {arg?} -> optional argument
32
+ * - {arg=default} -> argument with default value
33
+ * - {arg*} -> variadic argument (array)
34
+ * - {arg:desc} -> argument with description
35
+ * - {--opt} -> boolean option
36
+ * - {--opt=} -> string option
37
+ * - {--opt|o} -> option with alias
38
+ */
39
+ private static parseParamSignature;
40
+ }
@@ -0,0 +1,28 @@
1
+ import { Command, CommandHandlerOptions } from './Command.js';
2
+ import { CommandIO } from './CommandIO.js';
3
+ import { CommandSignatureParser } from './CommandSignatureParser.js';
4
+ import { ContextDefinition, OptionsSchema } from './lib/types.js';
5
+ export declare abstract class CommandWithSignature<C extends ContextDefinition = ContextDefinition, Opts extends OptionsSchema = OptionsSchema, Args extends OptionsSchema = OptionsSchema> extends Command<C, Opts, Args> {
6
+ abstract signature: string;
7
+ abstract description: string;
8
+ protected helperDefinitions: {
9
+ [key: string]: string;
10
+ };
11
+ get command(): string;
12
+ parser: CommandSignatureParser<Opts, Args>;
13
+ protected newCommandParser(opts: {
14
+ io: CommandIO;
15
+ options: Opts;
16
+ arguments: Args;
17
+ }): CommandSignatureParser<Opts, Args>;
18
+ constructor();
19
+ protected abstract handle(ctx: C, opts: CommandHandlerOptions<Opts, Args>): Promise<number | void>;
20
+ protected option<T = string>(key: string): T | null;
21
+ protected option<T = string>(key: string, defaultValue: T): NoInfer<T>;
22
+ protected argument<T = string>(key: string): T | null;
23
+ protected argument<T = string>(key: string, defaultValue: T): NoInfer<T>;
24
+ askForConfirmation(...opts: Parameters<typeof this.io.askForConfirmation>): ReturnType<typeof this.io.askForConfirmation>;
25
+ askForInput(...opts: Parameters<typeof this.io.askForInput>): ReturnType<typeof this.io.askForInput>;
26
+ askForSelect(...opts: Parameters<typeof this.io.askForSelect>): ReturnType<typeof this.io.askForSelect>;
27
+ newLoader(...opts: Parameters<typeof this.io.newLoader>): ReturnType<typeof this.io.newLoader>;
28
+ }
@@ -1,4 +1,7 @@
1
+ import { Logger } from './Logger.js';
1
2
  import { BobError } from './errors/index.js';
2
3
  export declare class ExceptionHandler {
4
+ private readonly logger;
5
+ constructor(logger: Logger);
3
6
  handle(err: Error | BobError): number;
4
7
  }
@@ -0,0 +1,16 @@
1
+ import { LogLevel, LoggerContract } from './contracts/index.js';
2
+ export type LoggerOptions = {
3
+ level?: LogLevel;
4
+ };
5
+ export declare class Logger implements LoggerContract {
6
+ private level;
7
+ constructor(opts?: LoggerOptions);
8
+ private shouldLog;
9
+ setLevel(level: LogLevel): void;
10
+ getLevel(): LogLevel;
11
+ log(...args: unknown[]): void;
12
+ info(...args: unknown[]): void;
13
+ warn(...args: unknown[]): void;
14
+ error(...args: unknown[]): void;
15
+ debug(...args: unknown[]): void;
16
+ }
@@ -7,8 +7,6 @@ export type HelpCommandOptions = {
7
7
  };
8
8
  export default class HelpCommand extends Command {
9
9
  private opts;
10
- signature: string;
11
- description: string;
12
10
  constructor(opts: HelpCommandOptions);
13
- protected handle(): Promise<void>;
11
+ handle(): Promise<void>;
14
12
  }
@@ -1,7 +1,6 @@
1
- export interface CommandOption<C> {
1
+ import { Command } from '../Command.js';
2
+ import { OptionDefinition } from '../lib/types.js';
3
+ export interface CommandOption<Cmd extends Command> extends OptionDefinition {
2
4
  option: string;
3
- alias?: string[];
4
- defaultValue: string | boolean | Array<string> | null;
5
- description?: string;
6
- handler(this: C): Promise<number | void>;
5
+ handler(this: Cmd): Promise<number | void>;
7
6
  }
@@ -0,0 +1,13 @@
1
+ export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
2
+ /**
3
+ * Logger interface defining standard logging methods and level management
4
+ */
5
+ export interface LoggerContract {
6
+ log(message: string, ...args: unknown[]): void;
7
+ info(message: string, ...args: unknown[]): void;
8
+ warn(message: string, ...args: unknown[]): void;
9
+ error(message: string, ...args: unknown[]): void;
10
+ debug(message: string, ...args: unknown[]): void;
11
+ setLevel(level: LogLevel): void;
12
+ getLevel(): LogLevel;
13
+ }
@@ -1 +1,2 @@
1
1
  export * from './CommandOption.js';
2
+ export * from './LoggerContract.js';
@@ -1,3 +1,4 @@
1
+ import { Logger } from '../Logger.js';
1
2
  import { BobError } from './BobError.js';
2
3
  export type OptionProps = {
3
4
  option: string;
@@ -7,5 +8,5 @@ export type OptionProps = {
7
8
  export declare class BadCommandOption extends BobError {
8
9
  readonly param: OptionProps;
9
10
  constructor(param: OptionProps);
10
- pretty(): void;
11
+ pretty(io: Logger): void;
11
12
  }
@@ -1,3 +1,4 @@
1
+ import { Logger } from '../Logger.js';
1
2
  import { BobError } from './BobError.js';
2
3
  export type ParameterProps = {
3
4
  param: string;
@@ -7,5 +8,5 @@ export type ParameterProps = {
7
8
  export declare class BadCommandParameter extends BobError {
8
9
  readonly param: ParameterProps;
9
10
  constructor(param: ParameterProps);
10
- pretty(): void;
11
+ pretty(io: Logger): void;
11
12
  }
@@ -1,3 +1,4 @@
1
+ import { Logger } from '../Logger.js';
1
2
  export declare abstract class BobError extends Error {
2
- abstract pretty(): void;
3
+ abstract pretty(logger: Logger): void;
3
4
  }
@@ -1,6 +1,7 @@
1
+ import { Logger } from '../Logger.js';
1
2
  import { BobError } from './BobError.js';
2
3
  export declare class CommandNotFoundError extends BobError {
3
4
  readonly command: string;
4
5
  constructor(command: string);
5
- pretty(): void;
6
+ pretty(io: Logger): void;
6
7
  }
@@ -1,8 +1,9 @@
1
+ import { Logger } from '../Logger.js';
1
2
  import { BobError } from './BobError.js';
2
- import { ArgSignature } from '../CommandParser.js';
3
+ import { OptionsSchema } from '../lib/types.js';
3
4
  export declare class InvalidOption extends BobError {
4
5
  private option;
5
- private optionsSignature;
6
- constructor(option: string, optionsSignature: ArgSignature[]);
7
- pretty(): void;
6
+ private optionsSchema;
7
+ constructor(option: string, optionsSchema?: OptionsSchema);
8
+ pretty(io: Logger): void;
8
9
  }
@@ -1,7 +1,7 @@
1
+ import { Logger } from '../Logger.js';
1
2
  import { BobError } from './BobError.js';
2
- import { ArgSignature } from '../CommandParser.js';
3
3
  export declare class MissingRequiredArgumentValue extends BobError {
4
- readonly paramSignature: ArgSignature;
5
- constructor(paramSignature: ArgSignature);
6
- pretty(): void;
4
+ readonly argument: string;
5
+ constructor(argument: string);
6
+ pretty(io: Logger): void;
7
7
  }
@@ -0,0 +1,7 @@
1
+ import { Logger } from '../Logger.js';
2
+ import { BobError } from './BobError.js';
3
+ export declare class MissingRequiredOptionValue extends BobError {
4
+ readonly option: string;
5
+ constructor(option: string);
6
+ pretty(io: Logger): void;
7
+ }
@@ -1,3 +1,7 @@
1
1
  export * from './BobError.js';
2
2
  export * from './BadCommandParameter.js';
3
3
  export * from './BadCommandOption.js';
4
+ export * from './InvalidOption.js';
5
+ export * from './CommandNotFoundError.js';
6
+ export * from './MissingRequiredArgumentValue.js';
7
+ export * from './MissingRequiredOptionValue.js';
@@ -1,6 +1,13 @@
1
1
  export * from './Command.js';
2
+ export * from './CommandWithSignature.js';
2
3
  export * from './CommandIO.js';
4
+ export * from './CommandParser.js';
5
+ export * from './CommandSignatureParser.js';
6
+ export * from './CommandRegistry.js';
3
7
  export * from './Cli.js';
8
+ export * from './Logger.js';
9
+ export * from './ExceptionHandler.js';
10
+ export * from './lib/types.js';
4
11
  export * from './errors/index.js';
5
- export * from './contracts/index.js';
6
12
  export * from './options/index.js';
13
+ export * from './contracts/index.js';
@@ -0,0 +1,5 @@
1
+ import { Option, OptionDefinition, OptionReturnType } from './types.js';
2
+ export declare function getOptionPrimitiveDefaultValue<Opts extends Option>(type: Opts): OptionReturnType<Opts>;
3
+ export declare function getOptionDefaultValue<Opts extends Option>(option: Opts): OptionReturnType<Opts> | null;
4
+ export type OptionDetails = Required<OptionDefinition>;
5
+ export declare function getOptionDetails(option: Option): OptionDetails;