@clerc/parser 1.0.0-beta.16 → 1.0.0-beta.18

package/dist/index.d.ts

@@ -6,23 +6,6 @@ declare class MissingRequiredFlagError extends Error {
   constructor(name: string);
 }
 //#endregion
-//#region src/flag-types.d.ts
-/**
-* Creates a Enum type function that validates the input against allowed values.
-* The display name will be formatted as "value1 | value2 | ..." for help output.
-*
-* @param values - Array of allowed string values
-* @returns A FlagTypeFunction that validates and returns the input value
-* @throws {Error} If the value is not in the allowed values list
-*
-* @example
-* ```typescript
-* const format = Enum(['json', 'yaml', 'xml']);
-* // Help output will show: json | yaml | xml
-* ```
-*/
-declare function Enum<T extends string>(...values: T[]): FlagTypeFunction<T>;
-//#endregion
 //#region ../utils/src/types/type-fest.d.ts
 type Prettify<T> = { [K in keyof T]: T[K] } & {};
 type IsAny<T> = 0 extends 1 & T ? true : false;
@@ -30,6 +13,11 @@ type IsAny<T> = 0 extends 1 & T ? true : false;
 //#region ../utils/src/types/index.d.ts
 type MaybeArray<T> = T | T[];
 //#endregion
+//#region src/iterator.d.ts
+declare const KNOWN_FLAG = "known-flag";
+declare const UNKNOWN_FLAG = "unknown-flag";
+declare const PARAMETER = "parameter";
+//#endregion
 //#region src/types.d.ts
 interface FlagDefaultValueFunction<T> {
   (): T;
@@ -159,10 +147,40 @@ type _InferFlags<T extends FlagsDefinition> = { [K in keyof T]: IsTypeAny<T[K]>
 */
 type InferFlags<T extends FlagsDefinition> = Prettify<_InferFlags<T>>;
 //#endregion
-//#region src/iterator.d.ts
-declare const KNOWN_FLAG = "known-flag";
-declare const UNKNOWN_FLAG = "unknown-flag";
-declare const PARAMETER = "parameter";
+//#region src/flag-types.d.ts
+/**
+* Creates a Enum type function that validates the input against allowed values.
+* The display name will be formatted as "value1 | value2 | ..." for help output.
+*
+* @param values - Array of allowed string values
+* @returns A FlagTypeFunction that validates and returns the input value
+* @throws {Error} If the value is not in the allowed values list
+*
+* @example
+* ```typescript
+* const format = Enum(['json', 'yaml', 'xml']);
+* // Help output will show: json | yaml | xml
+* ```
+*/
+declare function Enum<T extends string>(...values: T[]): FlagTypeFunction<T>;
+/**
+* Creates a range type function that validates the input is a number within the specified range.
+*
+* @param min - The minimum acceptable value (inclusive)
+* @param max - The maximum acceptable value (inclusive)
+* @returns A FlagTypeFunction that validates the input value
+* @throws {Error} If the value is not a number or is outside the specified range
+*/
+declare function Range(min: number, max: number): FlagTypeFunction<number>;
+/**
+* Creates a regex type function that validates the input against the provided pattern.
+*
+* @param pattern - The regular expression pattern to validate against
+* @param description - Optional description for display purposes
+* @returns A FlagTypeFunction that validates the input value
+* @throws {Error} If the value does not match the regex pattern
+*/
+declare function Regex(pattern: RegExp, description?: string): FlagTypeFunction<string>;
 //#endregion
 //#region src/parse.d.ts
 declare const DOUBLE_DASH = "--";
@@ -172,4 +190,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, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagType, FlagTypeFunction, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, RawInputType, UNKNOWN_FLAG, createParser, parse };
+export { BaseFlagOptions, DOUBLE_DASH, Enum, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagType, FlagTypeFunction, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, UNKNOWN_FLAG, createParser, parse };

package/dist/index.js

@@ -36,6 +36,39 @@ function Enum(...values) {
 	fn.display = values.join(" | ");
 	return fn;
 }
+/**
+* Creates a range type function that validates the input is a number within the specified range.
+*
+* @param min - The minimum acceptable value (inclusive)
+* @param max - The maximum acceptable value (inclusive)
+* @returns A FlagTypeFunction that validates the input value
+* @throws {Error} If the value is not a number or is outside the specified range
+*/
+function Range(min, max) {
+	const fn = ((value) => {
+		const num = Number(value);
+		if (Number.isNaN(num) || num < min || num > max) throw new Error(`Invalid value: ${value}. Must be a number between ${min} and ${max}`);
+		return num;
+	});
+	fn.display = `${min}-${max}`;
+	return fn;
+}
+/**
+* Creates a regex type function that validates the input against the provided pattern.
+*
+* @param pattern - The regular expression pattern to validate against
+* @param description - Optional description for display purposes
+* @returns A FlagTypeFunction that validates the input value
+* @throws {Error} If the value does not match the regex pattern
+*/
+function Regex(pattern, description) {
+	const fn = ((value) => {
+		if (!pattern.test(value)) throw new Error(`Invalid value: ${value}. Must match pattern: ${pattern}`);
+		return value;
+	});
+	fn.display = description ?? pattern.toString();
+	return fn;
+}
 
 //#endregion
 //#region src/iterator.ts
@@ -88,6 +121,7 @@ function iterateArgs(args, result, shouldProcessAsFlag, isKnownFlag, ignore, cal
 
 //#endregion
 //#region ../utils/src/index.ts
+const looseIsArray = (arr) => Array.isArray(arr);
 const toArray = (a) => Array.isArray(a) ? a : [a];
 /**
 * Converts a dash- or space-separated string to camelCase.
@@ -110,9 +144,45 @@ function camelCase(str) {
 	return result;
 }
 
+//#endregion
+//#region src/config.ts
+const defaultParserOptions = { delimiters: ["=", ":"] };
+const resolveParserOptions = (options = {}) => ({
+	...defaultParserOptions,
+	...options
+});
+const normalizeConfig = (config) => typeof config === "function" || looseIsArray(config) ? { type: config } : config;
+const BUILDTIN_DELIMITERS_RE = /[\s.]/;
+function buildConfigsAndAliases(delimiters, flags) {
+	const configs = /* @__PURE__ */ new Map();
+	const aliases = /* @__PURE__ */ new Map();
+	const isNameInvalid = (name) => delimiters.some((char) => name.includes(char)) || BUILDTIN_DELIMITERS_RE.test(name);
+	function validateFlagOptions(name, options) {
+		const prefix = `Flag "${name}"`;
+		if (Array.isArray(options.type) && options.type.length > 1) throw new InvalidSchemaError(`${prefix} has an invalid type array. Only single-element arrays are allowed to denote multiple occurrences.`);
+		const names = [name];
+		if (options.alias) names.push(...toArray(options.alias));
+		if (names.some(isNameInvalid)) throw new InvalidSchemaError(`${prefix} contains reserved characters, which are used as delimiters.`);
+	}
+	for (const [name, config] of Object.entries(flags)) {
+		const normalized = normalizeConfig(config);
+		validateFlagOptions(name, normalized);
+		configs.set(name, normalized);
+		aliases.set(name, name);
+		aliases.set(camelCase(name), name);
+		if (normalized.alias) {
+			const list = Array.isArray(normalized.alias) ? normalized.alias : [normalized.alias];
+			for (const a of list) aliases.set(a, name);
+		}
+	}
+	return {
+		configs,
+		aliases
+	};
+}
+
 //#endregion
 //#region src/utils.ts
-const looseIsArray = (arr) => Array.isArray(arr);
 const isArrayOfType = (arr, type) => Array.isArray(arr) && arr[0] === type;
 /**
 * Check if it's a letter (a-z: 97-122, A-Z: 65-90)
@@ -163,43 +233,6 @@ function splitNameAndValue(arg, delimiters) {
 	};
 }
 
-//#endregion
-//#region src/config.ts
-const defaultParserOptions = { delimiters: ["=", ":"] };
-const resolveParserOptions = (options = {}) => ({
-	...defaultParserOptions,
-	...options
-});
-const normalizeConfig = (config) => typeof config === "function" || looseIsArray(config) ? { type: config } : config;
-const BUILDTIN_DELIMITERS_RE = /[\s.]/;
-function buildConfigsAndAliases(delimiters, flags) {
-	const configs = /* @__PURE__ */ new Map();
-	const aliases = /* @__PURE__ */ new Map();
-	const isNameInvalid = (name) => delimiters.some((char) => name.includes(char)) || BUILDTIN_DELIMITERS_RE.test(name);
-	function validateFlagOptions(name, options) {
-		const prefix = `Flag "${name}"`;
-		if (Array.isArray(options.type) && options.type.length > 1) throw new InvalidSchemaError(`${prefix} has an invalid type array. Only single-element arrays are allowed to denote multiple occurrences.`);
-		const names = [name];
-		if (options.alias) names.push(...toArray(options.alias));
-		if (names.some(isNameInvalid)) throw new InvalidSchemaError(`${prefix} contains reserved characters, which are used as delimiters.`);
-	}
-	for (const [name, config] of Object.entries(flags)) {
-		const normalized = normalizeConfig(config);
-		validateFlagOptions(name, normalized);
-		configs.set(name, normalized);
-		aliases.set(name, name);
-		aliases.set(camelCase(name), name);
-		if (normalized.alias) {
-			const list = Array.isArray(normalized.alias) ? normalized.alias : [normalized.alias];
-			for (const a of list) aliases.set(a, name);
-		}
-	}
-	return {
-		configs,
-		aliases
-	};
-}
-
 //#endregion
 //#region src/parse.ts
 const DOUBLE_DASH = "--";
@@ -348,4 +381,4 @@ function createParser(options = {}) {
 const parse = (args, options = {}) => createParser(options).parse(args);
 
 //#endregion
-export { DOUBLE_DASH, Enum, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, PARAMETER, UNKNOWN_FLAG, createParser, parse };
+export { DOUBLE_DASH, Enum, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, PARAMETER, Range, Regex, UNKNOWN_FLAG, createParser, parse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/parser",
-  "version": "1.0.0-beta.16",
+  "version": "1.0.0-beta.18",
   "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.16"
+    "@clerc/utils": "1.0.0-beta.18"
   }
 }