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

package/dist/index.d.ts

@@ -2,6 +2,9 @@
 declare class InvalidSchemaError extends Error {
   constructor(message: string);
 }
+declare class MissingRequiredFlagError extends Error {
+  constructor(name: string);
+}
 //#endregion
 //#region src/flag-types.d.ts
 /**
@@ -28,7 +31,9 @@ type IsAny<T> = 0 extends 1 & T ? true : false;
 type MaybeArray<T> = T | T[];
 //#endregion
 //#region 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.
 *
@@ -39,7 +44,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.
@@ -62,6 +67,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> & {
   /**
@@ -132,13 +139,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.
@@ -160,4 +169,4 @@ declare function createParser<T extends FlagsDefinition>(options?: ParserOptions
 };
 declare const parse: <T extends FlagsDefinition>(args: string[], options?: ParserOptions<T>) => ParsedResult<InferFlags<T>>;
 //#endregion
-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 };

package/dist/index.js

@@ -5,6 +5,12 @@ var InvalidSchemaError = class extends Error {
 		this.name = "InvalidSchemaError";
 	}
 };
+var MissingRequiredFlagError = class extends Error {
+	constructor(name) {
+		super(`Missing required flag: ${name}`);
+		this.name = "MissingRequiredFlagError";
+	}
+};
 
 //#endregion
 //#region src/flag-types.ts
@@ -27,7 +33,7 @@ function Choices(...values) {
 		if (!values.includes(value)) throw new Error(`Invalid value: ${value}. Must be one of: ${values.join(", ")}`);
 		return value;
 	});
-	fn.displayName = values.join(" | ");
+	fn.display = values.join(" | ");
 	return fn;
 }
 
@@ -333,6 +339,7 @@ function createParser(options = {}) {
 			else if (Array.isArray(config.type)) result.flags[key] = isArrayOfType(config.type, Boolean) ? 0 : [];
 			else if (config.type === Object) result.flags[key] = {};
 			else if (config.type === Boolean) result.flags[key] = false;
+			else if (config.required) throw new MissingRequiredFlagError(key);
 		}
 		return result;
 	};
@@ -341,4 +348,4 @@ function createParser(options = {}) {
 const parse = (args, options = {}) => createParser(options).parse(args);
 
 //#endregion
-export { Choices, DOUBLE_DASH, InvalidSchemaError, KNOWN_FLAG, PARAMETER, UNKNOWN_FLAG, createParser, parse };
+export { Choices, DOUBLE_DASH, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, PARAMETER, UNKNOWN_FLAG, createParser, parse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/parser",
-  "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 parser",
@@ -56,6 +56,6 @@
     "nopt": "^9.0.0",
     "type-flag": "^4.0.3",
     "yargs-parser": "^22.0.0",
-    "@clerc/utils": "1.0.0-beta.13"
+    "@clerc/utils": "1.0.0-beta.15"
   }
 }