@clerc/core 1.0.0-beta.13 → 1.0.0-beta.15

package/dist/index.d.ts

@@ -6,6 +6,9 @@ import { ErrorHandler as ErrorHandler$1 } from "lite-emit";
 declare class InvalidSchemaError extends Error {
   constructor(message: string);
 }
+declare class MissingRequiredFlagError extends Error {
+  constructor(name: string);
+}
 //#endregion
 //#region ../parser/src/flag-types.d.ts
 /**
@@ -43,7 +46,9 @@ type UnionToIntersection<U$1> = (U$1 extends any ? (k: U$1) => void : never) ext
 type CamelCase<S extends string> = S extends `${infer Head} ${infer Tail}` ? `${Head}${Capitalize<CamelCase<Tail>>}` : S extends `${infer Head}-${infer Tail}` ? `${Head}${Capitalize<CamelCase<Tail>>}` : S;
 //#endregion
 //#region ../parser/src/types.d.ts
-type FlagDefaultValue<T = unknown> = T | (() => T);
+type FlagDefaultValue<T = unknown> = T | ((() => T) & {
+  display?: string;
+});
 /**
 * Defines how a string input is converted to the target type T.
 *
@@ -54,7 +59,7 @@ type FlagTypeFunction<T = unknown> = ((value: string) => T) & {
   * Optional display name for the type, useful in help output.
   * If provided, this will be shown instead of the function name.
   */
-  displayName?: string;
+  display?: string;
 };
 /**
 * A callback function to conditionally stop parsing.
@@ -77,6 +82,8 @@ interface BaseFlagOptions<T extends FlagType = FlagType> {
   alias?: MaybeArray<string>;
   /** The default value of the flag. */
   default?: unknown;
+  /** Whether the flag is required. */
+  required?: boolean;
 }
 type FlagOptions = (BaseFlagOptions<BooleanConstructor> & {
   /**
@@ -147,13 +154,15 @@ type IsTypeAny<T extends FlagDefinitionValue> = IsAny<T> extends true ? true : T
 } ? IsAny<Type> extends true ? true : false : false;
 type _InferFlags<T extends FlagsDefinition> = { [K in keyof T]: IsTypeAny<T[K]> extends true ? any : T[K] extends readonly [BooleanConstructor] | {
   type: readonly [BooleanConstructor];
-} ? number : T[K] extends ObjectConstructor | {
+} ? number | InferFlagDefault<T[K], never> : T[K] extends ObjectConstructor | {
   type: ObjectConstructor;
-} ? ObjectInputType : T[K] extends readonly [FlagType<infer U>] | {
+} ? ObjectInputType | InferFlagDefault<T[K], never> : T[K] extends readonly [FlagType<infer U>] | {
   type: readonly [FlagType<infer U>];
 } ? U[] | InferFlagDefault<T[K], never> : T[K] extends FlagType<infer U> | {
   type: FlagType<infer U>;
-} ? U | InferFlagDefault<T[K], [U] extends [boolean] ? never : undefined> : never };
+} ? U | InferFlagDefault<T[K], [U] extends [boolean] ? never : T[K] extends {
+  required: true;
+} ? never : undefined> : never };
 /**
 * An advanced utility type that infers the exact type of the `flags` object in the parsed result,
 * based on the provided `flags` configuration object T.
@@ -175,7 +184,7 @@ declare function createParser<T extends FlagsDefinition>(options?: ParserOptions
 };
 declare const parse: <T extends FlagsDefinition>(args: string[], options?: ParserOptions<T>) => ParsedResult<InferFlags<T>>;
 declare namespace index_d_exports {
-  export { BaseFlagOptions, Choices, DOUBLE_DASH, FlagDefaultValue, FlagDefinitionValue, FlagOptions, FlagType, FlagTypeFunction, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, RawInputType, UNKNOWN_FLAG, createParser, parse };
+  export { BaseFlagOptions, Choices, DOUBLE_DASH, FlagDefaultValue, FlagDefinitionValue, FlagOptions, FlagType, FlagTypeFunction, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, RawInputType, UNKNOWN_FLAG, createParser, parse };
 }
 //#endregion
 //#region src/types/clerc.d.ts
@@ -197,6 +206,7 @@ type InferParameters<T extends readonly string[]> = T extends readonly (infer U
 //#region src/types/context.d.ts
 type AddStringIndex<T> = T & Record<string, any>;
 type InferFlagsWithGlobal<C extends Command, GF extends ClercFlagsDefinition> = AddStringIndex<InferFlags<NonNullable<C["flags"]> & Omit<GF, keyof NonNullable<C["flags"]>>>>;
+interface ContextStore {}
 interface BaseContext<C extends Command = Command, GF extends ClercFlagsDefinition = {}> {
   resolved: boolean;
   command?: C;
@@ -206,6 +216,7 @@ interface BaseContext<C extends Command = Command, GF extends ClercFlagsDefiniti
   ignored: string[];
   rawParsed: ParsedResult<InferFlagsWithGlobal<C, GF>>;
   missingParameters: boolean;
+  store: ContextStore;
 }
 //#endregion
 //#region src/types/command.d.ts
@@ -273,6 +284,7 @@ declare class Clerc<Commands extends CommandsRecord = {}, GlobalFlags extends Cl
   get _version(): string;
   get _commands(): CommandsMap;
   get _globalFlags(): GlobalFlags;
+  get store(): ContextStore;
   static create(options?: CreateOptions): Clerc;
   name(name: string): this;
   scriptName(scriptName: string): this;
@@ -319,4 +331,4 @@ declare function createStopAtFirstParameter(): IgnoreFunction;
 //#region src/plugin.d.ts
 declare const definePlugin: (plugin: Plugin) => Plugin;
 //#endregion
-export { BaseContext, Choices, Clerc, ClercFlagOptions, ClercFlagOptionsWithDescription, ClercFlagsDefinition, ClercGlobalFlagDefinitionValue, Command, CommandCustomOptions, CommandHandler, CommandHandlerContext, CommandOptions, CommandWithHandler, CommandsMap, CommandsRecord, type CreateOptions, DOUBLE_DASH, ErrorHandler, FlagCustomOptions, InferParameters, Interceptor, InterceptorContext, InterceptorHandler, InterceptorNext, InterceptorObject, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MakeEmitterEvents, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, type ParseOptions, type index_d_exports as Parser, Plugin, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, resolveCommand };
+export { BaseContext, Choices, Clerc, ClercFlagOptions, ClercFlagOptionsWithDescription, ClercFlagsDefinition, ClercGlobalFlagDefinitionValue, Command, CommandCustomOptions, CommandHandler, CommandHandlerContext, CommandOptions, CommandWithHandler, CommandsMap, CommandsRecord, ContextStore, type CreateOptions, DOUBLE_DASH, ErrorHandler, FlagCustomOptions, InferParameters, Interceptor, InterceptorContext, InterceptorHandler, InterceptorNext, InterceptorObject, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MakeEmitterEvents, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, type ParseOptions, type index_d_exports as Parser, Plugin, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, resolveCommand };

package/dist/index.js

@@ -157,6 +157,7 @@ var Clerc = class Clerc {
 	#commands = /* @__PURE__ */ new Map();
 	#emitter = new LiteEmit({ errorHandler: (error) => this.#handleError(error) });
 	#globalFlags = {};
+	#store = {};
 	#interceptors = [];
 	#errorHandlers = [];
 	#name = "";
@@ -187,6 +188,9 @@ var Clerc = class Clerc {
 	get _globalFlags() {
 		return this.#globalFlags;
 	}
+	get store() {
+		return this.#store;
+	}
 	static create(options) {
 		return new Clerc(options);
 	}
@@ -300,7 +304,8 @@ var Clerc = class Clerc {
 			flags: parsed.flags,
 			ignored: parsed.ignored,
 			rawParsed: parsed,
-			missingParameters: !!parametersError
+			missingParameters: !!parametersError,
+			store: { ...this.#store }
 		};
 		const emitInterceptor = {
 			enforce: "post",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "1.0.0-beta.13",
+  "version": "1.0.0-beta.15",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc core",
@@ -45,10 +45,10 @@
   },
   "dependencies": {
     "lite-emit": "^3.1.0",
-    "@clerc/parser": "^1.0.0-beta.13"
+    "@clerc/parser": "^1.0.0-beta.15"
   },
   "devDependencies": {
     "is-platform": "^1.0.0",
-    "@clerc/utils": "1.0.0-beta.13"
+    "@clerc/utils": "1.0.0-beta.15"
   }
 }