@clerc/core 1.0.0-beta.24 → 1.0.0-beta.26

package/dist/index.d.ts

@@ -5,9 +5,6 @@ import { Clerc as Clerc$1, CreateOptions as CreateOptions$1, Plugin as Plugin$1
 declare class InvalidSchemaError extends Error {
   constructor(message: string);
 }
-declare class MissingRequiredFlagError extends Error {
-  constructor(name: string);
-}
 //#endregion
 //#region ../utils/src/types/type-fest.d.ts
 type LiteralUnion<LiteralType, BaseType> = LiteralType | (BaseType & Record<never, never>);
@@ -20,6 +17,7 @@ type MapsSetsOrArrays = ReadonlyMap<unknown, unknown> | WeakMap<WeakKey, unknown
 type ConditionalDeepPrettify<T, E = never, I$1 = unknown> = T extends E ? T : T extends I$1 ? { [TypeKey in keyof T]: ConditionalDeepPrettify<T[TypeKey], E, I$1> } : T;
 type DeepPrettify<T, E = never> = ConditionalDeepPrettify<T, E | NonRecursiveType | MapsSetsOrArrays, object>;
 type IsAny<T> = 0 extends 1 & T ? true : false;
+type RequireExactlyOneOrNone<T, Keys extends keyof T = keyof T> = ({ [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, never>> }[Keys] & Omit<T, Keys>) | (Partial<Record<Keys, never>> & Omit<T, Keys>);
 //#endregion
 //#region ../utils/src/types/index.d.ts
 type MaybeArray<T> = T | T[];
@@ -61,20 +59,22 @@ interface TypeFunction<T = unknown> {
 */
 type IgnoreFunction = (type: typeof KNOWN_FLAG | typeof UNKNOWN_FLAG | typeof PARAMETER, arg: string) => boolean;
 type TypeValue<T = unknown> = TypeFunction<T> | readonly [TypeFunction<T>];
-interface BaseFlagOptions<T extends TypeValue = TypeValue> {
+type Foo = RequireExactlyOneOrNone<{
+  /** The default value of the flag. */
+  default?: unknown;
+  /** Whether the flag is required. */
+  required?: boolean;
+}, "default" | "required">;
+type BaseFlagOptions<T extends TypeValue = TypeValue> = Foo & {
   /**
   * The type constructor or a function to convert the string value.
   * To support multiple occurrences of a flag (e.g., --file a --file b), wrap the type in an array: [String], [Number].
   * e.g., String, Number, [String], (val) => val.split(',')
   */
   type: T;
-  /** Aliases for the flag. */
-  alias?: MaybeArray<string>;
-  /** The default value of the flag. */
-  default?: unknown;
-  /** Whether the flag is required. */
-  required?: boolean;
-}
+  /** Short flag alias (single character). */
+  short?: string;
+};
 type FlagOptions = (BaseFlagOptions<BooleanConstructor> & {
   /**
   * Whether to enable the `--no-<flag>` syntax to set the value to false.
@@ -135,6 +135,8 @@ interface ParsedResult<TFlags extends Record<string, any>> {
   unknown: Record<string, RawInputType>;
   /** Arguments that were not parsed due to ignore callback. */
   ignored: string[];
+  /** List of required flags that were not provided. */
+  missingRequiredFlags: string[];
 }
 type InferFlagDefault<T extends FlagDefinitionValue, Fallback> = T extends {
   default: FlagDefaultValue<infer DefaultType>;
@@ -204,7 +206,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, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, TypeFunction, TypeValue, UNKNOWN_FLAG, createParser, parse };
+  export { BaseFlagOptions, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, TypeFunction, TypeValue, UNKNOWN_FLAG, createParser, parse };
 }
 //#endregion
 //#region src/types/clerc.d.ts
@@ -234,14 +236,12 @@ 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;
   calledAs?: string;
   parameters: InferParameters<NonNullable<C["parameters"]>>;
   flags: InferFlagsWithGlobal<C, GF>;
   ignored: string[];
   rawParsed: ParsedResult<InferFlagsWithGlobal<C, GF>>;
-  missingParameters: boolean;
   store: Partial<ContextStore>;
 }
 //#endregion
@@ -349,6 +349,9 @@ declare class MissingRequiredMetadataError extends Error {
 declare class InvalidParametersError extends Error {
   constructor(message: string);
 }
+declare class MissingRequiredFlagError extends Error {
+  constructor(flags: string[]);
+}
 declare namespace flag_types_d_exports {
   export { Enum, Range, Regex };
 }
@@ -378,14 +381,7 @@ declare module "@clerc/core" {
     };
   }
 }
-interface CompletionsPluginOptions {
-  /**
-  * Whether to register the `completions install` and `completions uninstall` commands.
-  * @default true
-  */
-  managementCommands?: boolean;
-}
-declare const completionsPlugin: (options?: CompletionsPluginOptions) => Plugin$1;
+declare const completionsPlugin: () => Plugin$1;
 //#endregion
 //#region ../plugin-friendly-error/src/index.d.ts
 interface FriendlyErrorPluginOptions {
@@ -550,15 +546,15 @@ declare const versionPlugin: ({
   flag
 }?: VersionPluginOptions) => Plugin$1;
 declare namespace re_exports_d_exports {
-  export { CommandHelpOptions, CompletionsPluginOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+  export { CommandHelpOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
 }
 import * as import___clerc_core from "@clerc/core";
 declare namespace index_d_exports$1 {
-  export { Cli, CommandHelpOptions, CompletionsPluginOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
+  export { Cli, CommandHelpOptions, FriendlyErrorPluginOptions, GroupDefinition, GroupsOptions, HelpOptions, HelpPluginOptions, completionsPlugin, defaultFormatters, friendlyErrorPlugin, helpPlugin, notFoundPlugin, strictFlagsPlugin, versionPlugin };
 }
 declare const Cli: (options?: CreateOptions$1) => Clerc$1;
 //#endregion
 //#region src/utils.d.ts
 declare const normalizeFlagValue: (flag: index_d_exports$1.ClercFlagDefinitionValue) => index_d_exports$1.ClercFlagOptions;
 //#endregion
-export { BaseContext, Clerc, ClercFlagDefinitionValue, ClercFlagOptions, ClercFlagsDefinition, 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, Parameter, ParameterDefinition, type ParseOptions, type index_d_exports as Parser, Plugin, flag_types_d_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, normalizeFlagValue, resolveCommand };
+export { BaseContext, Clerc, ClercFlagDefinitionValue, ClercFlagOptions, ClercFlagsDefinition, 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, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, Parameter, ParameterDefinition, type ParseOptions, type index_d_exports as Parser, Plugin, flag_types_d_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, normalizeFlagValue, resolveCommand };

package/dist/index.js

@@ -64,6 +64,12 @@ var InvalidParametersError = class extends Error {
 		super(message);
 	}
 };
+var MissingRequiredFlagError = class extends Error {
+	constructor(flags) {
+		const s = flags.length > 1 ? "s" : "";
+		super(`Missing required flag${s}: ${flags.join(", ")}`);
+	}
+};
 
 //#endregion
 //#region src/interceptor.ts
@@ -304,19 +310,18 @@ var Clerc = class Clerc {
 			parametersError = e;
 		}
 		const context = {
-			resolved: !!command,
 			command,
 			calledAs,
 			parameters,
 			flags: parsed.flags,
 			ignored: parsed.ignored,
 			rawParsed: parsed,
-			missingParameters: !!parametersError,
 			store: { ...this.#store }
 		};
 		const emitInterceptor = {
 			enforce: "post",
 			handler: async (ctx) => {
+				if (parsed.missingRequiredFlags.length > 0) throw new MissingRequiredFlagError(parsed.missingRequiredFlags);
 				if (parametersError) throw parametersError;
 				if (command) await this.#emitter.emit(command.name, ctx);
 				else throw parametersToResolve.length > 0 ? new NoSuchCommandError(parametersToResolve.join(" ")) : new NoCommandSpecifiedError();
@@ -372,4 +377,4 @@ const definePlugin = (plugin) => plugin;
 const normalizeFlagValue = (flag) => typeof flag === "function" || looseIsArray(flag) ? { type: flag } : flag;
 
 //#endregion
-export { Clerc, DOUBLE_DASH, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, flag_types_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, normalizeFlagValue, resolveCommand };
+export { Clerc, DOUBLE_DASH, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, flag_types_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, normalizeFlagValue, resolveCommand };

package/package.json

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