@clerc/parser 1.0.0-beta.28 → 1.0.0-beta.29

package/README.md

@@ -1,15 +1,15 @@
 # @clerc/parser
 
+[![NPM version](https://img.shields.io/npm/v/@clerc/parser?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/parser)
+
 A powerful, lightweight, and flexible command-line arguments parser.
 
 ## Installation
 
 ```bash
-npm install @clerc/parser
-# or
-yarn add @clerc/parser
-# or
-pnpm add @clerc/parser
+$ npm install @clerc/parser
+$ yarn add @clerc/parser
+$ pnpm add @clerc/parser
 ```
 
 ## Usage
@@ -360,3 +360,7 @@ BENCH  Summary
     3.85x faster than nopt
     27.11x faster than yargs-parser
 ```
+
+## 📝 License
+
+[MIT](../../LICENSE). Made with ❤️ by [Ray](https://github.com/so1ve)

package/dist/index.d.ts

@@ -8,11 +8,6 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
 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 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;
@@ -146,40 +141,10 @@ type _InferFlags<T extends FlagsDefinition> = { [K in keyof T]: IsTypeAny<T[K]>
 */
 type InferFlags<T extends FlagsDefinition> = Prettify<_InferFlags<T>>;
 //#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 TypeFunction 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[]): TypeFunction<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 TypeFunction 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): TypeFunction<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 TypeFunction that validates the input value
-* @throws {Error} If the value does not match the regex pattern
-*/
-declare function Regex(pattern: RegExp, description?: string): TypeFunction<string>;
+//#region src/iterator.d.ts
+declare const KNOWN_FLAG = "known-flag";
+declare const UNKNOWN_FLAG = "unknown-flag";
+declare const PARAMETER = "parameter";
 //#endregion
 //#region src/parse.d.ts
 declare const DOUBLE_DASH = "--";
@@ -189,4 +154,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, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, Range, RawInputType, Regex, TypeFunction, TypeValue, UNKNOWN_FLAG, createParser, parse };
+export { BaseFlagOptions, DOUBLE_DASH, FlagDefaultValue, FlagDefaultValueFunction, FlagDefinitionValue, FlagOptions, FlagsDefinition, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, ObjectInputType, PARAMETER, ParsedResult, ParserOptions, RawInputType, TypeFunction, TypeValue, UNKNOWN_FLAG, createParser, parse };

package/dist/index.js

@@ -6,64 +6,6 @@ var InvalidSchemaError = class extends Error {
 	}
 };
 
-//#endregion
-//#region src/flag-types.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 TypeFunction 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
-* ```
-*/
-function Enum(...values) {
-	const fn = ((value) => {
-		if (!values.includes(value)) throw new Error(`Invalid value: ${value}. Must be one of: ${values.join(", ")}`);
-		return value;
-	});
-	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 TypeFunction 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 TypeFunction 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 ?? `Regex: ${pattern.toString()}`;
-	return fn;
-}
-
 //#endregion
 //#region src/iterator.ts
 const KNOWN_FLAG = "known-flag";
@@ -380,4 +322,4 @@ function createParser(options = {}) {
 const parse = (args, options = {}) => createParser(options).parse(args);
 
 //#endregion
-export { DOUBLE_DASH, Enum, InvalidSchemaError, KNOWN_FLAG, PARAMETER, Range, Regex, UNKNOWN_FLAG, createParser, parse };
+export { DOUBLE_DASH, InvalidSchemaError, KNOWN_FLAG, PARAMETER, UNKNOWN_FLAG, createParser, parse };

package/package.json

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