bob-core 2.1.0 → 3.0.0-alpha.0

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

@@ -2,3 +2,4 @@ import { Command } from '../Command.js';
 import { BobError } from '../errors/index.js';
 export declare function isBobError(err: Error): err is BobError;
 export declare function isBobCommand(obj: unknown): obj is Command;
+export declare function isBobCommandClass(cls: unknown): cls is typeof Command;

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

@@ -1,31 +1,85 @@
-export type OptionPrimitive = 'string' | 'number' | 'boolean' | ['string'] | ['number'];
-export type OptionDefinition = {
-    type: OptionPrimitive;
+import { Command } from '../Command.js';
+export type BaseFlagConfig<T> = {
     description?: string;
     alias?: string | Array<string>;
     required?: boolean;
+    default?: T | T[] | null | (() => Promise<T | T[] | null>);
+    multiple?: boolean;
+    help?: string;
+    parse: (input: string, ctx: ContextDefinition) => T;
+    validate?(value: T): FlagValidationResult;
+    handler?(value: T, ctx: ContextDefinition, cmd: typeof Command): {
+        shouldStop: boolean;
+    } | void;
+};
+export type StringFlagDef = BaseFlagConfig<string> & {
+    type: 'string';
     secret?: boolean;
-    default?: any;
-    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 {
-    type: infer T extends Option;
-} ? OptionType<T> : never;
-export type IsRequired<O extends Option> = O extends {
+};
+export type NumberFlagDef = BaseFlagConfig<number> & {
+    type: 'number';
+    min?: number;
+    max?: number;
+};
+export type BooleanFlagDef = BaseFlagConfig<boolean> & {
+    type: 'boolean';
+};
+export type EnumFlagDef<T extends readonly string[] = readonly string[]> = BaseFlagConfig<T[number]> & {
+    type: 'enum';
+    options: T;
+};
+export type FileFlagDef = BaseFlagConfig<string> & {
+    type: 'file';
+    exists?: boolean;
+};
+export type DirectoryFlagDef = BaseFlagConfig<string> & {
+    type: 'directory';
+    exists?: boolean;
+};
+export type UrlFlagDef = BaseFlagConfig<URL> & {
+    type: 'url';
+};
+export type CustomFlagDef<R = unknown> = BaseFlagConfig<R> & {
+    type: 'custom';
+};
+export type FlagDefinition = StringFlagDef | NumberFlagDef | BooleanFlagDef | EnumFlagDef | FileFlagDef | DirectoryFlagDef | UrlFlagDef | CustomFlagDef<any>;
+export type FlagInput<T extends FlagDefinition, K extends string = never> = Partial<Omit<T, 'type' | K>>;
+export type FlagValidationResult = true | string | Promise<true | string>;
+type MaybeArray<T, O> = O extends {
+    multiple: true;
+} ? T[] : T;
+type InferParseReturn<O> = O extends {
+    parse: (...args: any[]) => infer R;
+} ? R : never;
+export type FlagType<O extends FlagDefinition> = O extends {
+    type: 'enum';
+    options: infer T extends readonly string[];
+} ? MaybeArray<T[number], O> : MaybeArray<InferParseReturn<O>, O>;
+export type IsRequired<O extends FlagDefinition> = O extends {
     required: true;
 } ? true : false;
-export type OptionReturnType<O extends Option> = IsRequired<O> extends true ? OptionType<O> : OptionType<O> | null;
-export type OptionsSchema = {
-    [key: string]: Option;
+export type FlagReturnType<O extends FlagDefinition> = IsRequired<O> extends true ? FlagType<O> : FlagType<O> | null;
+export type FlagsSchema = {
+    [key: string]: FlagDefinition;
 };
-export type OptionsObject<Options extends OptionsSchema> = {
-    [Key in keyof Options]: OptionReturnType<Options[Key]>;
+export type FlagsObject<Options extends FlagsSchema> = {
+    [Key in keyof Options]: FlagReturnType<Options[Key]>;
 };
 export type ArgumentsSchema = {
-    [key: string]: Option;
+    [key: string]: FlagDefinition;
 };
 export type ArgumentsObject<Arguments extends ArgumentsSchema> = {
-    [Key in keyof Arguments]: OptionReturnType<Arguments[Key]>;
+    [Key in keyof Arguments]: FlagReturnType<Arguments[Key]>;
 };
 export type ContextDefinition = any;
+export type InferFlags<T> = T extends {
+    flags: infer O extends FlagsSchema;
+} ? O : any;
+export type InferArgs<T> = T extends {
+    args: infer A extends ArgumentsSchema;
+} ? A : any;
+export type Parsed<T> = {
+    flags: FlagsObject<InferFlags<T>>;
+    args: ArgumentsObject<InferArgs<T>>;
+};
+export {};

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

@@ -1,11 +1,12 @@
 import { Command } from '../Command.js';
-import { CommandOption } from '../contracts/index.js';
-import { OptionPrimitive } from '../lib/types.js';
-export declare class HelpOption implements CommandOption<Command> {
-    type: OptionPrimitive;
-    option: string;
-    alias: string[];
-    default: boolean;
-    description: string;
-    handler(this: Command): Promise<number | void>;
-}
+import { ContextDefinition } from '../lib/types.js';
+export declare const HelpCommandFlag: import('../lib/types.js').BaseFlagConfig<boolean> & {
+    type: "boolean";
+} & {
+    readonly alias: ["h"];
+    readonly handler: (value: boolean, ctx: ContextDefinition, cmd: typeof Command) => {
+        shouldStop: false;
+    } | {
+        shouldStop: true;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bob-core",
-  "version": "2.1.0",
+  "version": "3.0.0-alpha.0",
   "description": "BOB Core",
   "type": "module",
   "main": "./dist/cjs/src/index.js",
@@ -21,7 +21,7 @@
   },
   "scripts": {
     "start": "node -r @swc-node/register debug/main.ts",
-    "build": "rimraf ./dist && vite build",
+    "build": "rm -rf ./dist && vite build",
     "typecheck": "tsc --noEmit",
     "prepack": "npm run build",
     "test": "vitest run",
@@ -31,26 +31,25 @@
   "author": "Léo Hubert",
   "license": "ISC",
   "devDependencies": {
-    "@eslint/js": "^9.37.0",
-    "@faker-js/faker": "^10.0.0",
+    "@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/prompts": "^2.4.9",
     "@types/string-similarity": "^4.0.2",
-    "@vitest/coverage-v8": "^3.2.4",
-    "eslint": "^9.37.0",
+    "@vitest/coverage-v8": "^4.1.0",
+    "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-prettier": "^5.5.5",
     "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "tsx": "^4.20.6",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.0",
-    "vite": "^7.2.7",
+    "typescript-eslint": "^8.57.0",
+    "vite": "^8.0.0",
     "vite-plugin-dts": "^4.5.4",
-    "vitest": "^3.2.4"
+    "vitest": "^4.1.0"
   },
   "dependencies": {
     "chalk": "^4.1.2",

package/dist/cjs/package-DYSfqWOt.cjs

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="bob-core",t="2.1.0",s="BOB Core",i="module",n="./dist/cjs/src/index.js",r="./dist/esm/src/index.js",c="./dist/esm/src/index.d.ts",o=["dist"],d={".":{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"}}},p={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"},l="Léo Hubert",m="ISC",a={"@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.9.3","typescript-eslint":"^8.46.0",vite:"^7.2.7","vite-plugin-dts":"^4.5.4",vitest:"^3.2.4"},u={chalk:"^4.1.2",minimist:"^1.2.8",prompts:"^2.4.2"},y={name:e,version:t,description:s,type:i,main:n,module:r,types:c,files:o,exports:d,scripts:p,author:l,license:m,devDependencies:a,dependencies:u};exports.author=l;exports.default=y;exports.dependencies=u;exports.description=s;exports.devDependencies=a;exports.exports=d;exports.files=o;exports.license=m;exports.main=n;exports.module=r;exports.name=e;exports.scripts=p;exports.type=i;exports.types=c;exports.version=t;

package/dist/cjs/src/contracts/CommandOption.d.ts

@@ -1,6 +0,0 @@
-import { Command } from '../Command.js';
-import { OptionDefinition } from '../lib/types.js';
-export interface CommandOption<Cmd extends Command> extends OptionDefinition {
-    option: string;
-    handler(this: Cmd): Promise<number | void>;
-}

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

@@ -1,12 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export type OptionProps = {
-    option: string;
-    value?: string;
-    reason?: string;
-};
-export declare class BadCommandOption extends BobError {
-    readonly param: OptionProps;
-    constructor(param: OptionProps);
-    pretty(logger: Logger): void;
-}

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

@@ -1,12 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export type ParameterProps = {
-    param: string;
-    value?: string;
-    reason?: string;
-};
-export declare class BadCommandParameter extends BobError {
-    readonly param: ParameterProps;
-    constructor(param: ParameterProps);
-    pretty(logger: Logger): void;
-}

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

@@ -1,9 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class InvalidOption extends BobError {
-    private option;
-    private optionsSchema;
-    constructor(option: string, optionsSchema?: OptionsSchema);
-    pretty(logger: Logger): void;
-}

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

@@ -1,7 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export declare class MissingRequiredOptionValue extends BobError {
-    readonly option: string;
-    constructor(option: string);
-    pretty(logger: Logger): void;
-}

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

@@ -1,5 +0,0 @@
-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> | null;
-export type OptionDetails = Required<OptionDefinition>;
-export declare function getOptionDetails(option: Option): OptionDetails;

package/dist/cjs/src/lib/valueConverter.d.ts

@@ -1,10 +0,0 @@
-import { OptionPrimitive } from './types.js';
-/**
- * Converts a value to the specified type with validation
- * @param value - The value to convert
- * @param type - The target type
- * @param name - The parameter name (for error messages)
- * @param defaultValue - Optional default value if value is null/undefined
- * @returns The converted value
- */
-export declare function convertValue(value: any, type: OptionPrimitive, name: string, defaultValue?: any): any;

package/dist/esm/package-uVOgoItG.js

@@ -1,33 +0,0 @@
-const t = "bob-core", s = "2.1.0", e = "BOB Core", i = "module", n = "./dist/cjs/src/index.js", r = "./dist/esm/src/index.js", c = "./dist/esm/src/index.d.ts", o = ["dist"], d = { ".": { 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" } } }, p = { 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" }, l = "Léo Hubert", m = "ISC", a = { "@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.9.3", "typescript-eslint": "^8.46.0", vite: "^7.2.7", "vite-plugin-dts": "^4.5.4", vitest: "^3.2.4" }, u = { chalk: "^4.1.2", minimist: "^1.2.8", prompts: "^2.4.2" }, x = {
-  name: t,
-  version: s,
-  description: e,
-  type: i,
-  main: n,
-  module: r,
-  types: c,
-  files: o,
-  exports: d,
-  scripts: p,
-  author: l,
-  license: m,
-  devDependencies: a,
-  dependencies: u
-};
-export {
-  l as author,
-  x as default,
-  u as dependencies,
-  e as description,
-  a as devDependencies,
-  d as exports,
-  o as files,
-  m as license,
-  n as main,
-  r as module,
-  t as name,
-  p as scripts,
-  i as type,
-  c as types,
-  s as version
-};

package/dist/esm/src/contracts/CommandOption.d.ts

@@ -1,6 +0,0 @@
-import { Command } from '../Command.js';
-import { OptionDefinition } from '../lib/types.js';
-export interface CommandOption<Cmd extends Command> extends OptionDefinition {
-    option: string;
-    handler(this: Cmd): Promise<number | void>;
-}

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

@@ -1,12 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export type OptionProps = {
-    option: string;
-    value?: string;
-    reason?: string;
-};
-export declare class BadCommandOption extends BobError {
-    readonly param: OptionProps;
-    constructor(param: OptionProps);
-    pretty(logger: Logger): void;
-}

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

@@ -1,12 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export type ParameterProps = {
-    param: string;
-    value?: string;
-    reason?: string;
-};
-export declare class BadCommandParameter extends BobError {
-    readonly param: ParameterProps;
-    constructor(param: ParameterProps);
-    pretty(logger: Logger): void;
-}

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

@@ -1,9 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-import { OptionsSchema } from '../lib/types.js';
-export declare class InvalidOption extends BobError {
-    private option;
-    private optionsSchema;
-    constructor(option: string, optionsSchema?: OptionsSchema);
-    pretty(logger: Logger): void;
-}

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

@@ -1,7 +0,0 @@
-import { Logger } from '../Logger.js';
-import { BobError } from './BobError.js';
-export declare class MissingRequiredOptionValue extends BobError {
-    readonly option: string;
-    constructor(option: string);
-    pretty(logger: Logger): void;
-}

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

@@ -1,5 +0,0 @@
-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> | null;
-export type OptionDetails = Required<OptionDefinition>;
-export declare function getOptionDetails(option: Option): OptionDetails;

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

@@ -1,10 +0,0 @@
-import { OptionPrimitive } from './types.js';
-/**
- * Converts a value to the specified type with validation
- * @param value - The value to convert
- * @param type - The target type
- * @param name - The parameter name (for error messages)
- * @param defaultValue - Optional default value if value is null/undefined
- * @returns The converted value
- */
-export declare function convertValue(value: any, type: OptionPrimitive, name: string, defaultValue?: any): any;