@optique/core 1.0.0-dev.908 → 1.0.0

package/dist/primitives.d.cts

@@ -1,17 +1,11 @@
 import { Message } from "./message.cjs";
 import { HiddenVisibility, OptionName, Usage } from "./usage.cjs";
 import { ValueParser, ValueParserResult } from "./valueparser.cjs";
-import { DeferredParseState, PendingDependencySourceState } from "./dependency.cjs";
-import { Mode, Parser } from "./parser.cjs";
+import { Mode, Parser } from "./internal/parser.cjs";
 
 //#region src/primitives.d.ts
-/**
- * State type for options that may use deferred parsing (DerivedValueParser).
- * This extends the normal ValueParserResult to also support DeferredParseState
- * and PendingDependencySourceState.
- * @internal
- */
-type OptionState<T> = ValueParserResult<T> | DeferredParseState<T> | PendingDependencySourceState | undefined;
+/** @internal */
+type OptionState<T> = ValueParserResult<T> | undefined;
 /**
  * Creates a parser that always succeeds without consuming any input and
  * produces a constant value of the type {@link T}.
@@ -119,7 +113,7 @@ interface OptionErrorOptions {
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option<M extends Mode, T>(...args: readonly [...readonly OptionName[], ValueParser<M, T>]): Parser<M, T, ValueParserResult<T> | undefined>;
+declare function option<M extends Mode, T>(...args: readonly [OptionName, ...readonly OptionName[], ValueParser<M, T>]): Parser<M, T, ValueParserResult<T> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that take an
  * argument value, such as `--option=value`, `-option=value`, `-o value`,
@@ -133,7 +127,7 @@ declare function option<M extends Mode, T>(...args: readonly [...readonly Option
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option<M extends Mode, T>(...args: readonly [...readonly OptionName[], ValueParser<M, T>, OptionOptions]): Parser<M, T, ValueParserResult<T> | undefined>;
+declare function option<M extends Mode, T>(...args: readonly [OptionName, ...readonly OptionName[], ValueParser<M, T>, OptionOptions]): Parser<M, T, ValueParserResult<T> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that do not
  * take an argument value, such as `--option`, `-o`, or `/option`.
@@ -141,7 +135,7 @@ declare function option<M extends Mode, T>(...args: readonly [...readonly Option
  * @return A {@link Parser} that can parse the specified options as Boolean
  *         flags, producing `true` if the option is present.
  */
-declare function option(...optionNames: readonly OptionName[]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
+declare function option(...optionNames: readonly [OptionName, ...readonly OptionName[]]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that take an
  * argument value, such as `--option=value`, `-option=value`, `-o value`,
@@ -152,7 +146,7 @@ declare function option(...optionNames: readonly OptionName[]): Parser<"sync", b
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option(...args: readonly [...readonly OptionName[], OptionOptions]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
+declare function option(...args: readonly [OptionName, ...readonly OptionName[], OptionOptions]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
 /**
  * Options for the {@link flag} parser.
  */
@@ -242,7 +236,7 @@ interface FlagErrorOptions {
  * });
  * ```
  */
-declare function flag(...args: readonly [...readonly OptionName[], FlagOptions] | readonly OptionName[]): Parser<"sync", true, ValueParserResult<true> | undefined>;
+declare function flag(...args: readonly [OptionName, ...readonly OptionName[], FlagOptions] | readonly [OptionName, ...readonly OptionName[]]): Parser<"sync", true, ValueParserResult<true> | undefined>;
 /**
  * Options for the {@link argument} parser.
  */
@@ -396,6 +390,8 @@ type CommandState<TState> = undefined | ["matched", string] | ["parsing", TState
  *                a description for documentation.
  * @returns A {@link Parser} that matches the command name and delegates
  *          to the inner parser for the remaining arguments.
+ * @throws {TypeError} If `name` is empty, whitespace-only, contains
+ *         embedded whitespace, or contains control characters.
  */
 declare function command<M extends Mode, T, TState>(name: string, parser: Parser<M, T, TState>, options?: CommandOptions): Parser<M, T, CommandState<TState>>;
 /**

package/dist/primitives.d.ts

@@ -1,17 +1,11 @@
 import { Message } from "./message.js";
 import { HiddenVisibility, OptionName, Usage } from "./usage.js";
 import { ValueParser, ValueParserResult } from "./valueparser.js";
-import { DeferredParseState, PendingDependencySourceState } from "./dependency.js";
-import { Mode, Parser } from "./parser.js";
+import { Mode, Parser } from "./internal/parser.js";
 
 //#region src/primitives.d.ts
-/**
- * State type for options that may use deferred parsing (DerivedValueParser).
- * This extends the normal ValueParserResult to also support DeferredParseState
- * and PendingDependencySourceState.
- * @internal
- */
-type OptionState<T> = ValueParserResult<T> | DeferredParseState<T> | PendingDependencySourceState | undefined;
+/** @internal */
+type OptionState<T> = ValueParserResult<T> | undefined;
 /**
  * Creates a parser that always succeeds without consuming any input and
  * produces a constant value of the type {@link T}.
@@ -119,7 +113,7 @@ interface OptionErrorOptions {
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option<M extends Mode, T>(...args: readonly [...readonly OptionName[], ValueParser<M, T>]): Parser<M, T, ValueParserResult<T> | undefined>;
+declare function option<M extends Mode, T>(...args: readonly [OptionName, ...readonly OptionName[], ValueParser<M, T>]): Parser<M, T, ValueParserResult<T> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that take an
  * argument value, such as `--option=value`, `-option=value`, `-o value`,
@@ -133,7 +127,7 @@ declare function option<M extends Mode, T>(...args: readonly [...readonly Option
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option<M extends Mode, T>(...args: readonly [...readonly OptionName[], ValueParser<M, T>, OptionOptions]): Parser<M, T, ValueParserResult<T> | undefined>;
+declare function option<M extends Mode, T>(...args: readonly [OptionName, ...readonly OptionName[], ValueParser<M, T>, OptionOptions]): Parser<M, T, ValueParserResult<T> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that do not
  * take an argument value, such as `--option`, `-o`, or `/option`.
@@ -141,7 +135,7 @@ declare function option<M extends Mode, T>(...args: readonly [...readonly Option
  * @return A {@link Parser} that can parse the specified options as Boolean
  *         flags, producing `true` if the option is present.
  */
-declare function option(...optionNames: readonly OptionName[]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
+declare function option(...optionNames: readonly [OptionName, ...readonly OptionName[]]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
 /**
  * Creates a parser for various styles of command-line options that take an
  * argument value, such as `--option=value`, `-option=value`, `-o value`,
@@ -152,7 +146,7 @@ declare function option(...optionNames: readonly OptionName[]): Parser<"sync", b
  * @returns A {@link Parser} that can parse the specified options and their
  *          values.
  */
-declare function option(...args: readonly [...readonly OptionName[], OptionOptions]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
+declare function option(...args: readonly [OptionName, ...readonly OptionName[], OptionOptions]): Parser<"sync", boolean, ValueParserResult<boolean> | undefined>;
 /**
  * Options for the {@link flag} parser.
  */
@@ -242,7 +236,7 @@ interface FlagErrorOptions {
  * });
  * ```
  */
-declare function flag(...args: readonly [...readonly OptionName[], FlagOptions] | readonly OptionName[]): Parser<"sync", true, ValueParserResult<true> | undefined>;
+declare function flag(...args: readonly [OptionName, ...readonly OptionName[], FlagOptions] | readonly [OptionName, ...readonly OptionName[]]): Parser<"sync", true, ValueParserResult<true> | undefined>;
 /**
  * Options for the {@link argument} parser.
  */
@@ -396,6 +390,8 @@ type CommandState<TState> = undefined | ["matched", string] | ["parsing", TState
  *                a description for documentation.
  * @returns A {@link Parser} that matches the command name and delegates
  *          to the inner parser for the remaining arguments.
+ * @throws {TypeError} If `name` is empty, whitespace-only, contains
+ *         embedded whitespace, or contains control characters.
  */
 declare function command<M extends Mode, T, TState>(name: string, parser: Parser<M, T, TState>, options?: CommandOptions): Parser<M, T, CommandState<TState>>;
 /**