@optique/core 1.0.0-dev.1901 → 1.0.0-dev.1970

package/dist/valueparser.cjs

@@ -6,12 +6,12 @@ const require_nonempty = require('./nonempty.cjs');
 * A predicate function that checks if an object is a {@link ValueParser}.
 * @param object The object to check.
 * @return `true` if the object is a {@link ValueParser}, `false` otherwise.
-* @throws {TypeError} If the object looks like a value parser (has `$mode`,
+* @throws {TypeError} If the object looks like a value parser (has `mode`,
 *   `metavar`, `parse`, and `format`) but is missing the required
 *   `placeholder` property.
 */
 function isValueParser(object) {
-	if (typeof object !== "object" || object == null || !("$mode" in object) || object.$mode !== "sync" && object.$mode !== "async") return false;
+	if (typeof object !== "object" || object == null || !("mode" in object) || object.mode !== "sync" && object.mode !== "async") return false;
 	const hasMetavar = "metavar" in object && typeof object.metavar === "string";
 	const hasParse = "parse" in object && typeof object.parse === "function";
 	const hasFormat = "format" in object && typeof object.format === "function";
@@ -56,7 +56,7 @@ function choice(choices, options = {}) {
 		const numberStrings = numberChoices.map((v) => Object.is(v, -0) ? "-0" : String(v));
 		const frozenNumberChoices = Object.freeze(numberChoices);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar,
 			placeholder: choices[0],
 			choices: frozenNumberChoices,
@@ -138,7 +138,7 @@ function choice(choices, options = {}) {
 	}
 	const stringInvalidChoice = stringOptions.errors?.invalidChoice;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: choices[0],
 		choices: stringChoices,
@@ -300,7 +300,7 @@ function string(options = {}) {
 	const patternFlags = options.pattern?.flags ?? null;
 	const patternMismatch = options.errors?.patternMismatch;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options.placeholder ?? "",
 		parse(input) {
@@ -373,7 +373,7 @@ function integer(options) {
 		const metavar$1 = options.metavar ?? "INTEGER";
 		require_nonempty.ensureNonEmptyString(metavar$1);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar: metavar$1,
 			placeholder: options?.placeholder ?? (options?.min != null && options.min > 0n ? options.min : options?.max != null && options.max < 0n ? options.max : 0n),
 			parse(input) {
@@ -417,7 +417,7 @@ function integer(options) {
 		};
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (firstAllowed > 0 ? firstAllowed : lastAllowed < 0 ? lastAllowed : 0),
 		parse(input) {
@@ -468,7 +468,7 @@ function float(options = {}) {
 	const metavar = options.metavar ?? "NUMBER";
 	require_nonempty.ensureNonEmptyString(metavar);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.min != null && options.min > 0 ? options.min : options?.max != null && options.max < 0 ? options.max : 0),
 		parse(input) {
@@ -553,7 +553,7 @@ function url(options = {}) {
 	const invalidUrl = options.errors?.invalidUrl;
 	const disallowedProtocol = options.errors?.disallowedProtocol;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return new URL(`${allowedProtocols?.[0] ?? "http:"}//0.invalid`);
@@ -625,7 +625,7 @@ function locale(options = {}) {
 	const metavar = options.metavar ?? "LOCALE";
 	require_nonempty.ensureNonEmptyString(metavar);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: new Intl.Locale("und"),
 		parse(input) {
@@ -921,7 +921,7 @@ function uuid(options = {}) {
 	const disallowedVersion = options.errors?.disallowedVersion;
 	const invalidVariant = options.errors?.invalidVariant;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: "00000000-0000-0000-0000-000000000000",
 		parse(input) {
@@ -1029,7 +1029,7 @@ function port(options) {
 		if (min$1 > max$1) throw new RangeError(`Expected min to be less than or equal to max, but got min: ${min$1} and max: ${max$1}.`);
 		if (options.disallowWellKnown && min$1 < 1024n && max$1 < 1024n) throw new RangeError(`disallowWellKnown is incompatible with the configured port range: all ports ${min$1}..${max$1} are well-known.`);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar: metavar$1,
 			placeholder: options.placeholder ?? (options.disallowWellKnown && min$1 < 1024n ? 1024n > min$1 ? 1024n : min$1 : min$1),
 			parse(input) {
@@ -1069,7 +1069,7 @@ function port(options) {
 	if (min > max) throw new RangeError(`Expected min to be less than or equal to max, but got min: ${min} and max: ${max}.`);
 	if (options?.disallowWellKnown && min < 1024 && max < 1024) throw new RangeError(`disallowWellKnown is incompatible with the configured port range: all ports ${min}..${max} are well-known.`);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.disallowWellKnown && min < 1024 ? Math.max(1024, min) : min),
 		parse(input) {
@@ -1163,7 +1163,7 @@ function ipv4(options) {
 	const allowBroadcast = options?.allowBroadcast ?? true;
 	const allowZero = options?.allowZero ?? true;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: allowZero ? "0.0.0.0" : allowLoopback ? "127.0.0.1" : "192.0.2.1",
 		parse(input) {
@@ -1280,7 +1280,7 @@ function hostname(options) {
 	const maxLength = options?.maxLength ?? 253;
 	if (!Number.isInteger(maxLength) || maxLength < 1) throw new RangeError("maxLength must be an integer greater than or equal to 1.");
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (allowLocalhost ? maxLength >= 9 ? "localhost" : "a.bc" : maxLength >= 11 ? "example.com" : "a.bc"),
 		parse(input) {
@@ -1500,7 +1500,7 @@ function email(options) {
 		return result;
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.allowMultiple ? [`user@${options?.allowedDomains?.[0] ?? "example.com"}`] : `user@${options?.allowedDomains?.[0] ?? "example.com"}`),
 		parse(input) {
@@ -1735,7 +1735,7 @@ function socketAddress(options) {
 		}
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return {
@@ -1973,7 +1973,7 @@ function portRange(options) {
 		errors: options?.errors
 	});
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return isBigInt ? {
@@ -2181,7 +2181,7 @@ function macAddress(options) {
 		return joinOctets(octets, sep);
 	}
 	const parserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			const octets = [
@@ -2374,7 +2374,7 @@ function domain(options) {
 	const subdomainsNotAllowed = options?.errors?.subdomainsNotAllowed;
 	const tldNotAllowed = options?.errors?.tldNotAllowed;
 	const domainParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? `example.${allowedTldsLower?.[0] ?? "com"}`,
 		parse(input) {
@@ -2658,7 +2658,7 @@ function ipv6(options) {
 	const errors = options?.errors;
 	const metavar = options?.metavar ?? "IPV6";
 	const ipv6ParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: allowZero ? "::" : allowLoopback ? "::1" : "2001:db8::1",
 		parse(input) {
@@ -3137,7 +3137,7 @@ function ip(options) {
 		zeroNotAllowed: errors?.zeroNotAllowed
 	} : void 0;
 	const ipParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: version === 6 ? ipv6Parser.placeholder : ipv4Parser.placeholder,
 		parse(input) {
@@ -3316,7 +3316,7 @@ function cidr(options) {
 		zeroNotAllowed: errors?.zeroNotAllowed
 	} : void 0;
 	const cidrParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return version === 6 || version === "both" && (minPrefix ?? 0) > 32 ? {

package/dist/valueparser.d.cts

@@ -1,6 +1,6 @@
 import { NonEmptyString, ensureNonEmptyString, isNonEmptyString } from "./nonempty.cjs";
 import { Message } from "./message.cjs";
-import { Mode, ModeIterable, ModeValue, Suggestion } from "./parser.cjs";
+import { Mode, ModeIterable, ModeValue, Suggestion } from "./internal/parser.cjs";
 
 //#region src/valueparser.d.ts
 
@@ -23,7 +23,7 @@ interface ValueParser<M extends Mode = "sync", T = unknown> {
    *
    * @since 0.9.0
    */
-  readonly $mode: M;
+  readonly mode: M;
   /**
    * The metavariable name for this parser.  Used in help messages
    * to indicate what kind of value this parser expects.  Usually
@@ -279,7 +279,7 @@ type ChoiceOptions = ChoiceOptionsString;
  * A predicate function that checks if an object is a {@link ValueParser}.
  * @param object The object to check.
  * @return `true` if the object is a {@link ValueParser}, `false` otherwise.
- * @throws {TypeError} If the object looks like a value parser (has `$mode`,
+ * @throws {TypeError} If the object looks like a value parser (has `mode`,
  *   `metavar`, `parse`, and `format`) but is missing the required
  *   `placeholder` property.
  */

package/dist/valueparser.d.ts

@@ -1,6 +1,6 @@
 import { NonEmptyString, ensureNonEmptyString, isNonEmptyString } from "./nonempty.js";
 import { Message } from "./message.js";
-import { Mode, ModeIterable, ModeValue, Suggestion } from "./parser.js";
+import { Mode, ModeIterable, ModeValue, Suggestion } from "./internal/parser.js";
 
 //#region src/valueparser.d.ts
 
@@ -23,7 +23,7 @@ interface ValueParser<M extends Mode = "sync", T = unknown> {
    *
    * @since 0.9.0
    */
-  readonly $mode: M;
+  readonly mode: M;
   /**
    * The metavariable name for this parser.  Used in help messages
    * to indicate what kind of value this parser expects.  Usually
@@ -279,7 +279,7 @@ type ChoiceOptions = ChoiceOptionsString;
  * A predicate function that checks if an object is a {@link ValueParser}.
  * @param object The object to check.
  * @return `true` if the object is a {@link ValueParser}, `false` otherwise.
- * @throws {TypeError} If the object looks like a value parser (has `$mode`,
+ * @throws {TypeError} If the object looks like a value parser (has `mode`,
  *   `metavar`, `parse`, and `format`) but is missing the required
  *   `placeholder` property.
  */

package/dist/valueparser.js

@@ -6,12 +6,12 @@ import { ensureNonEmptyString, isNonEmptyString } from "./nonempty.js";
 * A predicate function that checks if an object is a {@link ValueParser}.
 * @param object The object to check.
 * @return `true` if the object is a {@link ValueParser}, `false` otherwise.
-* @throws {TypeError} If the object looks like a value parser (has `$mode`,
+* @throws {TypeError} If the object looks like a value parser (has `mode`,
 *   `metavar`, `parse`, and `format`) but is missing the required
 *   `placeholder` property.
 */
 function isValueParser(object) {
-	if (typeof object !== "object" || object == null || !("$mode" in object) || object.$mode !== "sync" && object.$mode !== "async") return false;
+	if (typeof object !== "object" || object == null || !("mode" in object) || object.mode !== "sync" && object.mode !== "async") return false;
 	const hasMetavar = "metavar" in object && typeof object.metavar === "string";
 	const hasParse = "parse" in object && typeof object.parse === "function";
 	const hasFormat = "format" in object && typeof object.format === "function";
@@ -56,7 +56,7 @@ function choice(choices, options = {}) {
 		const numberStrings = numberChoices.map((v) => Object.is(v, -0) ? "-0" : String(v));
 		const frozenNumberChoices = Object.freeze(numberChoices);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar,
 			placeholder: choices[0],
 			choices: frozenNumberChoices,
@@ -138,7 +138,7 @@ function choice(choices, options = {}) {
 	}
 	const stringInvalidChoice = stringOptions.errors?.invalidChoice;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: choices[0],
 		choices: stringChoices,
@@ -300,7 +300,7 @@ function string(options = {}) {
 	const patternFlags = options.pattern?.flags ?? null;
 	const patternMismatch = options.errors?.patternMismatch;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options.placeholder ?? "",
 		parse(input) {
@@ -373,7 +373,7 @@ function integer(options) {
 		const metavar$1 = options.metavar ?? "INTEGER";
 		ensureNonEmptyString(metavar$1);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar: metavar$1,
 			placeholder: options?.placeholder ?? (options?.min != null && options.min > 0n ? options.min : options?.max != null && options.max < 0n ? options.max : 0n),
 			parse(input) {
@@ -417,7 +417,7 @@ function integer(options) {
 		};
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (firstAllowed > 0 ? firstAllowed : lastAllowed < 0 ? lastAllowed : 0),
 		parse(input) {
@@ -468,7 +468,7 @@ function float(options = {}) {
 	const metavar = options.metavar ?? "NUMBER";
 	ensureNonEmptyString(metavar);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.min != null && options.min > 0 ? options.min : options?.max != null && options.max < 0 ? options.max : 0),
 		parse(input) {
@@ -553,7 +553,7 @@ function url(options = {}) {
 	const invalidUrl = options.errors?.invalidUrl;
 	const disallowedProtocol = options.errors?.disallowedProtocol;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return new URL(`${allowedProtocols?.[0] ?? "http:"}//0.invalid`);
@@ -625,7 +625,7 @@ function locale(options = {}) {
 	const metavar = options.metavar ?? "LOCALE";
 	ensureNonEmptyString(metavar);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: new Intl.Locale("und"),
 		parse(input) {
@@ -921,7 +921,7 @@ function uuid(options = {}) {
 	const disallowedVersion = options.errors?.disallowedVersion;
 	const invalidVariant = options.errors?.invalidVariant;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: "00000000-0000-0000-0000-000000000000",
 		parse(input) {
@@ -1029,7 +1029,7 @@ function port(options) {
 		if (min$1 > max$1) throw new RangeError(`Expected min to be less than or equal to max, but got min: ${min$1} and max: ${max$1}.`);
 		if (options.disallowWellKnown && min$1 < 1024n && max$1 < 1024n) throw new RangeError(`disallowWellKnown is incompatible with the configured port range: all ports ${min$1}..${max$1} are well-known.`);
 		return {
-			$mode: "sync",
+			mode: "sync",
 			metavar: metavar$1,
 			placeholder: options.placeholder ?? (options.disallowWellKnown && min$1 < 1024n ? 1024n > min$1 ? 1024n : min$1 : min$1),
 			parse(input) {
@@ -1069,7 +1069,7 @@ function port(options) {
 	if (min > max) throw new RangeError(`Expected min to be less than or equal to max, but got min: ${min} and max: ${max}.`);
 	if (options?.disallowWellKnown && min < 1024 && max < 1024) throw new RangeError(`disallowWellKnown is incompatible with the configured port range: all ports ${min}..${max} are well-known.`);
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.disallowWellKnown && min < 1024 ? Math.max(1024, min) : min),
 		parse(input) {
@@ -1163,7 +1163,7 @@ function ipv4(options) {
 	const allowBroadcast = options?.allowBroadcast ?? true;
 	const allowZero = options?.allowZero ?? true;
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: allowZero ? "0.0.0.0" : allowLoopback ? "127.0.0.1" : "192.0.2.1",
 		parse(input) {
@@ -1280,7 +1280,7 @@ function hostname(options) {
 	const maxLength = options?.maxLength ?? 253;
 	if (!Number.isInteger(maxLength) || maxLength < 1) throw new RangeError("maxLength must be an integer greater than or equal to 1.");
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (allowLocalhost ? maxLength >= 9 ? "localhost" : "a.bc" : maxLength >= 11 ? "example.com" : "a.bc"),
 		parse(input) {
@@ -1500,7 +1500,7 @@ function email(options) {
 		return result;
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? (options?.allowMultiple ? [`user@${options?.allowedDomains?.[0] ?? "example.com"}`] : `user@${options?.allowedDomains?.[0] ?? "example.com"}`),
 		parse(input) {
@@ -1735,7 +1735,7 @@ function socketAddress(options) {
 		}
 	}
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return {
@@ -1973,7 +1973,7 @@ function portRange(options) {
 		errors: options?.errors
 	});
 	return {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return isBigInt ? {
@@ -2181,7 +2181,7 @@ function macAddress(options) {
 		return joinOctets(octets, sep);
 	}
 	const parserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			const octets = [
@@ -2374,7 +2374,7 @@ function domain(options) {
 	const subdomainsNotAllowed = options?.errors?.subdomainsNotAllowed;
 	const tldNotAllowed = options?.errors?.tldNotAllowed;
 	const domainParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: options?.placeholder ?? `example.${allowedTldsLower?.[0] ?? "com"}`,
 		parse(input) {
@@ -2658,7 +2658,7 @@ function ipv6(options) {
 	const errors = options?.errors;
 	const metavar = options?.metavar ?? "IPV6";
 	const ipv6ParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: allowZero ? "::" : allowLoopback ? "::1" : "2001:db8::1",
 		parse(input) {
@@ -3137,7 +3137,7 @@ function ip(options) {
 		zeroNotAllowed: errors?.zeroNotAllowed
 	} : void 0;
 	const ipParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		placeholder: version === 6 ? ipv6Parser.placeholder : ipv4Parser.placeholder,
 		parse(input) {
@@ -3316,7 +3316,7 @@ function cidr(options) {
 		zeroNotAllowed: errors?.zeroNotAllowed
 	} : void 0;
 	const cidrParserObj = {
-		$mode: "sync",
+		mode: "sync",
 		metavar,
 		get placeholder() {
 			return version === 6 || version === "both" && (minPrefix ?? 0) > 32 ? {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "1.0.0-dev.1901+a2ce4da0",
+  "version": "1.0.0-dev.1970+0182ae32",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",
@@ -99,6 +99,14 @@
       "import": "./dist/doc.js",
       "require": "./dist/doc.cjs"
     },
+    "./extension": {
+      "types": {
+        "import": "./dist/extension.d.ts",
+        "require": "./dist/extension.d.cts"
+      },
+      "import": "./dist/extension.js",
+      "require": "./dist/extension.cjs"
+    },
     "./facade": {
       "types": {
         "import": "./dist/facade.d.ts",
@@ -115,14 +123,6 @@
       "import": "./dist/message.js",
       "require": "./dist/message.cjs"
     },
-    "./mode-dispatch": {
-      "types": {
-        "import": "./dist/mode-dispatch.d.ts",
-        "require": "./dist/mode-dispatch.d.cts"
-      },
-      "import": "./dist/mode-dispatch.js",
-      "require": "./dist/mode-dispatch.cjs"
-    },
     "./modifiers": {
       "types": {
         "import": "./dist/modifiers.d.ts",