@optique/core 1.0.0-dev.513 → 1.0.0-dev.517

package/dist/constructs.d.cts

@@ -849,40 +849,40 @@ type LongestMatchArityGuard<TParsers extends readonly unknown[]> = IsTuple<TPars
 declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
- * the most input tokens.
+ * the most input tokens, with custom error options.
  *
  * The resulting parser tries every given parser and returns the
  * successful result that consumed more input than the others.
  *
- * @param parsers Parsers to evaluate and compare by consumed input.
+ * @param rest Parsers to compare, followed by error customization options.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.3.0
+ * @since 0.5.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
  * the most input tokens, with custom error options.
  *
- * The resulting parser tries every given parser and returns the
- * successful result that consumed more input than the others.
- *
  * @param rest Parsers to compare, followed by error customization options.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
  * @since 0.5.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
- * the most input tokens, with custom error options.
+ * the most input tokens.
  *
- * @param rest Parsers to compare, followed by error customization options.
+ * The resulting parser tries every given parser and returns the
+ * successful result that consumed more input than the others.
+ *
+ * @param parsers Parsers to evaluate and compare by consumed input.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.5.0
+ * @since 0.3.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Options for the {@link object} parser.
  * @since 0.5.0
@@ -1097,18 +1097,6 @@ type EnsureMergeParsers<TParsers extends MergeParsers> = { readonly [K in keyof
 type IntersectMergeValues<TParsers extends MergeParsers> = TParsers extends readonly [infer THead extends Parser<Mode, unknown, unknown>, ...infer TRest extends MergeParsers] ? ExtractObjectTypes<THead> & IntersectMergeValues<TRest> : unknown;
 type MergeValues<TParsers extends MergeParsers> = IsTuple<TParsers> extends true ? IntersectMergeValues<TParsers> : Record<string | symbol, unknown>;
 type MergeReturnType<TParsers extends MergeParsers> = Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, MergeValues<TParsers>, Record<string | symbol, unknown>>;
-/**
- * Merges multiple object-like parsers into one parser.
- *
- * This is useful for combining separate object parsers into one
- * unified parser while keeping fields grouped by parser boundaries.
- *
- * @param parsers Parsers to merge in declaration order.
- * @returns A parser that merges parsed object fields from all parsers.
- * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.4.0
- */
-declare function merge<const TParsers extends MergeParsers>(...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
 /**
  * Merges multiple object-like parsers into one parser, with options.
  *
@@ -1147,6 +1135,18 @@ declare function merge<const TParsers extends MergeParsers>(label: string, ...pa
  * @since 0.7.0
  */
 declare function merge<const TParsers extends MergeParsers>(label: string, ...rest: [...parsers: EnsureMergeParsers<TParsers>, options: MergeTailOptions] & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
+/**
+ * Merges multiple object-like parsers into one parser.
+ *
+ * This is useful for combining separate object parsers into one
+ * unified parser while keeping fields grouped by parser boundaries.
+ *
+ * @param parsers Parsers to merge in declaration order.
+ * @returns A parser that merges parsed object fields from all parsers.
+ * Type inference is precise for tuple calls up to 15 parser arguments.
+ * @since 0.4.0
+ */
+declare function merge<const TParsers extends MergeParsers>(...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
 type ConcatParserArity = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
 type ConcatArityLimitError = {
   readonly __optiqueConcatArityLimit: "concat() requires between 1 and 15 parser arguments. Nest concat() to combine more.";
@@ -1164,8 +1164,28 @@ type ConcatValues<TParsers extends ConcatParsers> = IsTuple<TParsers> extends tr
  *
  * @example
  * ```typescript
- * const parser = concat(tuple([string()]), tuple([number()]));
- * // parser value: [string, number]
+ * import { parse } from "@optique/core/parser";
+ * import { option } from "@optique/core/primitives";
+ * import { integer, string } from "@optique/core/valueparser";
+ *
+ * const basicTuple = tuple([
+ *   option("-v", "--verbose"),
+ *   option("-p", "--port", integer()),
+ * ]);
+ *
+ * const serverTuple = tuple([
+ *   option("-h", "--host", string()),
+ *   option("-d", "--debug"),
+ * ]);
+ *
+ * const combined = concat(basicTuple, serverTuple);
+ * // Inferred type: Parser<..., [boolean, number, string, boolean], ...>
+ *
+ * const result = parse(
+ *   combined,
+ *   ["-v", "-p", "8080", "-h", "localhost", "-d"],
+ * );
+ * // result.value: [true, 8080, "localhost", true]
  * ```
  *
  * @param parsers Tuple parsers to concatenate.

package/dist/constructs.d.ts

@@ -849,40 +849,40 @@ type LongestMatchArityGuard<TParsers extends readonly unknown[]> = IsTuple<TPars
 declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
- * the most input tokens.
+ * the most input tokens, with custom error options.
  *
  * The resulting parser tries every given parser and returns the
  * successful result that consumed more input than the others.
  *
- * @param parsers Parsers to evaluate and compare by consumed input.
+ * @param rest Parsers to compare, followed by error customization options.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.3.0
+ * @since 0.5.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
  * the most input tokens, with custom error options.
  *
- * The resulting parser tries every given parser and returns the
- * successful result that consumed more input than the others.
- *
  * @param rest Parsers to compare, followed by error customization options.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
  * @since 0.5.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<"sync", unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<"sync", InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Creates a parser that selects the successful branch that consumed
- * the most input tokens, with custom error options.
+ * the most input tokens.
  *
- * @param rest Parsers to compare, followed by error customization options.
+ * The resulting parser tries every given parser and returns the
+ * successful result that consumed more input than the others.
+ *
+ * @param parsers Parsers to evaluate and compare by consumed input.
  * @returns A parser that yields the best successful branch result.
  * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.5.0
+ * @since 0.3.0
  */
-declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...rest: [...parsers: TParsers, options: LongestMatchTailOptions] & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
+declare function longestMatch<const TParsers extends readonly Parser<Mode, unknown, unknown>[]>(...parsers: TParsers & LongestMatchArityGuard<TParsers>): Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, InferValue<TParsers[number]>, LongestMatchState<TParsers>>;
 /**
  * Options for the {@link object} parser.
  * @since 0.5.0
@@ -1097,18 +1097,6 @@ type EnsureMergeParsers<TParsers extends MergeParsers> = { readonly [K in keyof
 type IntersectMergeValues<TParsers extends MergeParsers> = TParsers extends readonly [infer THead extends Parser<Mode, unknown, unknown>, ...infer TRest extends MergeParsers] ? ExtractObjectTypes<THead> & IntersectMergeValues<TRest> : unknown;
 type MergeValues<TParsers extends MergeParsers> = IsTuple<TParsers> extends true ? IntersectMergeValues<TParsers> : Record<string | symbol, unknown>;
 type MergeReturnType<TParsers extends MergeParsers> = Parser<CombineModes<{ readonly [K in keyof TParsers]: ExtractMode<TParsers[K]> }>, MergeValues<TParsers>, Record<string | symbol, unknown>>;
-/**
- * Merges multiple object-like parsers into one parser.
- *
- * This is useful for combining separate object parsers into one
- * unified parser while keeping fields grouped by parser boundaries.
- *
- * @param parsers Parsers to merge in declaration order.
- * @returns A parser that merges parsed object fields from all parsers.
- * Type inference is precise for tuple calls up to 15 parser arguments.
- * @since 0.4.0
- */
-declare function merge<const TParsers extends MergeParsers>(...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
 /**
  * Merges multiple object-like parsers into one parser, with options.
  *
@@ -1147,6 +1135,18 @@ declare function merge<const TParsers extends MergeParsers>(label: string, ...pa
  * @since 0.7.0
  */
 declare function merge<const TParsers extends MergeParsers>(label: string, ...rest: [...parsers: EnsureMergeParsers<TParsers>, options: MergeTailOptions] & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
+/**
+ * Merges multiple object-like parsers into one parser.
+ *
+ * This is useful for combining separate object parsers into one
+ * unified parser while keeping fields grouped by parser boundaries.
+ *
+ * @param parsers Parsers to merge in declaration order.
+ * @returns A parser that merges parsed object fields from all parsers.
+ * Type inference is precise for tuple calls up to 15 parser arguments.
+ * @since 0.4.0
+ */
+declare function merge<const TParsers extends MergeParsers>(...parsers: EnsureMergeParsers<TParsers> & MergeArityGuard<TParsers>): MergeReturnType<TParsers>;
 type ConcatParserArity = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
 type ConcatArityLimitError = {
   readonly __optiqueConcatArityLimit: "concat() requires between 1 and 15 parser arguments. Nest concat() to combine more.";
@@ -1164,8 +1164,28 @@ type ConcatValues<TParsers extends ConcatParsers> = IsTuple<TParsers> extends tr
  *
  * @example
  * ```typescript
- * const parser = concat(tuple([string()]), tuple([number()]));
- * // parser value: [string, number]
+ * import { parse } from "@optique/core/parser";
+ * import { option } from "@optique/core/primitives";
+ * import { integer, string } from "@optique/core/valueparser";
+ *
+ * const basicTuple = tuple([
+ *   option("-v", "--verbose"),
+ *   option("-p", "--port", integer()),
+ * ]);
+ *
+ * const serverTuple = tuple([
+ *   option("-h", "--host", string()),
+ *   option("-d", "--debug"),
+ * ]);
+ *
+ * const combined = concat(basicTuple, serverTuple);
+ * // Inferred type: Parser<..., [boolean, number, string, boolean], ...>
+ *
+ * const result = parse(
+ *   combined,
+ *   ["-v", "-p", "8080", "-h", "localhost", "-d"],
+ * );
+ * // result.value: [true, 8080, "localhost", true]
  * ```
  *
  * @param parsers Tuple parsers to concatenate.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "1.0.0-dev.513+486612c6",
+  "version": "1.0.0-dev.517+e46c5180",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",