@optique/inquirer 1.2.0-dev.2188 → 1.2.0-dev.2194

package/dist/index.d.cts

@@ -32,6 +32,15 @@ interface Choice {
    */
   readonly disabled?: boolean | string;
 }
+/**
+ * A choice item for the `checkbox` prompt type.
+ *
+ * @since 1.2.0
+ */
+interface CheckboxChoice extends Choice {
+  /** Whether the choice is initially selected. */
+  readonly checked?: boolean;
+}
 /**
  * A choice item for the `expand` prompt type.
  *
@@ -61,19 +70,11 @@ interface ExpandChoice {
  */
 interface ConfirmConfig {
   readonly type: "confirm";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default answer when the user just presses Enter.
-   */
+  /** Default answer when the user just presses Enter. */
   readonly default?: boolean;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<boolean>;
 }
 /**
@@ -83,34 +84,17 @@ interface ConfirmConfig {
  */
 interface NumberPromptConfig {
   readonly type: "number";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default number shown to the user.
-   */
+  /** Default number shown to the user. */
   readonly default?: number;
-  /**
-   * Minimum accepted value.
-   */
+  /** Minimum accepted value. */
   readonly min?: number;
-  /**
-   * Maximum accepted value.
-   */
+  /** Maximum accepted value. */
   readonly max?: number;
-  /**
-   * Granularity of valid values. Use `"any"` for arbitrary decimals.
-   */
+  /** Granularity of valid values. Use `"any"` for arbitrary decimals. */
   readonly step?: number | "any";
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   *
-   * Return `undefined` to simulate the user leaving the field empty (which
-   * results in a parse failure).
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<number | undefined>;
 }
 /**
@@ -120,24 +104,13 @@ interface NumberPromptConfig {
  */
 interface InputConfig {
   readonly type: "input";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default text pre-filled in the prompt.
-   */
+  /** Default text pre-filled in the prompt. */
   readonly default?: string;
-  /**
-   * Validation function called when the user submits.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the user submits. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -147,54 +120,29 @@ interface InputConfig {
  */
 interface PasswordConfig {
   readonly type: "password";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * If `true`, show `*` characters for each keystroke.
-   * If `false` or omitted, input is invisible.
-   */
+  /** If `true`, show `*` characters for each keystroke. */
   readonly mask?: boolean;
-  /**
-   * Validation function called when the user submits.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the user submits. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
  * Configuration for an `editor` prompt (external editor).
  *
- * Opens the user's `$VISUAL` or `$EDITOR` for multi-line text input.
- *
  * @since 1.0.0
  */
 interface EditorConfig {
   readonly type: "editor";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default content pre-filled in the editor.
-   */
+  /** Default content pre-filled in the editor. */
   readonly default?: string;
-  /**
-   * Validation function called when the editor is closed.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the editor is closed. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -204,24 +152,13 @@ interface EditorConfig {
  */
 interface SelectConfig {
   readonly type: "select";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   * Use `new Separator(...)` for visual dividers.
-   */
+  /** Available choices. */
   readonly choices: readonly (string | Choice | Separator)[];
-  /**
-   * Initially highlighted choice value.
-   */
+  /** Initially highlighted choice value. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -231,23 +168,13 @@ interface SelectConfig {
  */
 interface RawlistConfig {
   readonly type: "rawlist";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   */
+  /** Available choices. */
   readonly choices: readonly (string | Choice)[];
-  /**
-   * Pre-selected choice value.
-   */
+  /** Pre-selected choice value. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -257,49 +184,27 @@ interface RawlistConfig {
  */
 interface ExpandConfig {
   readonly type: "expand";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Each choice requires a `key` field.
-   */
+  /** Available choices. Each choice requires a `key` field. */
   readonly choices: readonly ExpandChoice[];
-  /**
-   * Default choice key.
-   */
+  /** Default choice key. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
  * Configuration for a `checkbox` prompt (multi-select).
  *
- * Use with parsers that return `string[]`, typically via
- * `multiple(option(...))`.
- *
  * @since 1.0.0
  */
 interface CheckboxConfig {
   readonly type: "checkbox";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   * Use `new Separator(...)` for visual dividers.
-   */
-  readonly choices: readonly (string | Choice | Separator)[];
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Available choices. */
+  readonly choices: readonly (string | CheckboxChoice | Separator)[];
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<readonly string[]>;
 }
 /**
@@ -311,13 +216,6 @@ type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectCo
 /**
  * Type-safe prompt configuration for a given parser value type `T`.
  *
- * The available prompt types are constrained by the expected value type:
- *
- *  - `boolean` or `boolean | undefined` → {@link ConfirmConfig}
- *  - `number` or `number | undefined` → {@link NumberPromptConfig}
- *  - `string` or `string | undefined` → {@link StringPromptConfig}
- *  - `readonly string[]` → {@link CheckboxConfig}
- *
  * @since 1.0.0
  */
 type PromptConfig<T> = BasePromptConfig<Exclude<T, null | undefined>>;
@@ -325,33 +223,17 @@ type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number
 /**
  * Wraps a parser with an interactive Inquirer.js prompt fallback.
  *
- * When the inner parser finds a value in the CLI arguments (consumed tokens),
- * that value is used directly. When no CLI value is found, an interactive
- * prompt is shown to the user.
- *
- * The returned parser always has `mode: "async"` because Inquirer.js prompts
- * are inherently asynchronous.
- *
- * Example:
- *
- * ```typescript
- * import { option } from "@optique/core/primitives";
- * import { string } from "@optique/core/valueparser";
- * import { prompt } from "@optique/inquirer";
- *
- * const nameParser = prompt(option("--name", string()), {
- *   type: "input",
- *   message: "Enter your name:",
- * });
- * ```
+ * When the inner parser finds a value in the CLI arguments, that value is used
+ * directly.  When no CLI value is found, an interactive prompt is shown to the
+ * user.
  *
  * @param parser Inner parser that reads CLI values.
  * @param config Type-safe Inquirer.js prompt configuration.
  * @returns A parser with interactive prompt fallback, always in async mode.
- * @throws {Error} If prompt execution fails with an unexpected error or if
- *                 the inner parser throws while parsing or completing.
+ * @throws {Error} If prompt execution fails with an unexpected error or if the
+ *                 inner parser throws while parsing or completing.
  * @since 1.0.0
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { CheckboxConfig, Choice, ConfirmConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, RawlistConfig, SelectConfig, Separator, StringPromptConfig, prompt };
+export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, RawlistConfig, SelectConfig, Separator, StringPromptConfig, prompt };

package/dist/index.d.ts

@@ -32,6 +32,15 @@ interface Choice {
    */
   readonly disabled?: boolean | string;
 }
+/**
+ * A choice item for the `checkbox` prompt type.
+ *
+ * @since 1.2.0
+ */
+interface CheckboxChoice extends Choice {
+  /** Whether the choice is initially selected. */
+  readonly checked?: boolean;
+}
 /**
  * A choice item for the `expand` prompt type.
  *
@@ -61,19 +70,11 @@ interface ExpandChoice {
  */
 interface ConfirmConfig {
   readonly type: "confirm";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default answer when the user just presses Enter.
-   */
+  /** Default answer when the user just presses Enter. */
   readonly default?: boolean;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<boolean>;
 }
 /**
@@ -83,34 +84,17 @@ interface ConfirmConfig {
  */
 interface NumberPromptConfig {
   readonly type: "number";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default number shown to the user.
-   */
+  /** Default number shown to the user. */
   readonly default?: number;
-  /**
-   * Minimum accepted value.
-   */
+  /** Minimum accepted value. */
   readonly min?: number;
-  /**
-   * Maximum accepted value.
-   */
+  /** Maximum accepted value. */
   readonly max?: number;
-  /**
-   * Granularity of valid values. Use `"any"` for arbitrary decimals.
-   */
+  /** Granularity of valid values. Use `"any"` for arbitrary decimals. */
   readonly step?: number | "any";
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   *
-   * Return `undefined` to simulate the user leaving the field empty (which
-   * results in a parse failure).
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<number | undefined>;
 }
 /**
@@ -120,24 +104,13 @@ interface NumberPromptConfig {
  */
 interface InputConfig {
   readonly type: "input";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default text pre-filled in the prompt.
-   */
+  /** Default text pre-filled in the prompt. */
   readonly default?: string;
-  /**
-   * Validation function called when the user submits.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the user submits. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -147,54 +120,29 @@ interface InputConfig {
  */
 interface PasswordConfig {
   readonly type: "password";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * If `true`, show `*` characters for each keystroke.
-   * If `false` or omitted, input is invisible.
-   */
+  /** If `true`, show `*` characters for each keystroke. */
   readonly mask?: boolean;
-  /**
-   * Validation function called when the user submits.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the user submits. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
  * Configuration for an `editor` prompt (external editor).
  *
- * Opens the user's `$VISUAL` or `$EDITOR` for multi-line text input.
- *
  * @since 1.0.0
  */
 interface EditorConfig {
   readonly type: "editor";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Default content pre-filled in the editor.
-   */
+  /** Default content pre-filled in the editor. */
   readonly default?: string;
-  /**
-   * Validation function called when the editor is closed.
-   * Return `true` or a string error message.
-   */
+  /** Validation function called when the editor is closed. */
   readonly validate?: (value: string) => boolean | string | Promise<boolean | string>;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -204,24 +152,13 @@ interface EditorConfig {
  */
 interface SelectConfig {
   readonly type: "select";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   * Use `new Separator(...)` for visual dividers.
-   */
+  /** Available choices. */
   readonly choices: readonly (string | Choice | Separator)[];
-  /**
-   * Initially highlighted choice value.
-   */
+  /** Initially highlighted choice value. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -231,23 +168,13 @@ interface SelectConfig {
  */
 interface RawlistConfig {
   readonly type: "rawlist";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   */
+  /** Available choices. */
   readonly choices: readonly (string | Choice)[];
-  /**
-   * Pre-selected choice value.
-   */
+  /** Pre-selected choice value. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
@@ -257,49 +184,27 @@ interface RawlistConfig {
  */
 interface ExpandConfig {
   readonly type: "expand";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Each choice requires a `key` field.
-   */
+  /** Available choices. Each choice requires a `key` field. */
   readonly choices: readonly ExpandChoice[];
-  /**
-   * Default choice key.
-   */
+  /** Default choice key. */
   readonly default?: string;
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<string>;
 }
 /**
  * Configuration for a `checkbox` prompt (multi-select).
  *
- * Use with parsers that return `string[]`, typically via
- * `multiple(option(...))`.
- *
  * @since 1.0.0
  */
 interface CheckboxConfig {
   readonly type: "checkbox";
-  /**
-   * The question to display to the user.
-   */
+  /** The question to display to the user. */
   readonly message: string;
-  /**
-   * Available choices. Plain strings and {@link Choice} objects can be mixed.
-   * Use `new Separator(...)` for visual dividers.
-   */
-  readonly choices: readonly (string | Choice | Separator)[];
-  /**
-   * Override the prompt execution. When provided, this function is called
-   * instead of launching an interactive Inquirer.js prompt. Useful for
-   * testing.
-   */
+  /** Available choices. */
+  readonly choices: readonly (string | CheckboxChoice | Separator)[];
+  /** Override the prompt execution. Useful for testing. */
   readonly prompter?: () => Promise<readonly string[]>;
 }
 /**
@@ -311,13 +216,6 @@ type StringPromptConfig = InputConfig | PasswordConfig | EditorConfig | SelectCo
 /**
  * Type-safe prompt configuration for a given parser value type `T`.
  *
- * The available prompt types are constrained by the expected value type:
- *
- *  - `boolean` or `boolean | undefined` → {@link ConfirmConfig}
- *  - `number` or `number | undefined` → {@link NumberPromptConfig}
- *  - `string` or `string | undefined` → {@link StringPromptConfig}
- *  - `readonly string[]` → {@link CheckboxConfig}
- *
  * @since 1.0.0
  */
 type PromptConfig<T> = BasePromptConfig<Exclude<T, null | undefined>>;
@@ -325,33 +223,17 @@ type BasePromptConfig<T> = T extends boolean ? ConfirmConfig : T extends number
 /**
  * Wraps a parser with an interactive Inquirer.js prompt fallback.
  *
- * When the inner parser finds a value in the CLI arguments (consumed tokens),
- * that value is used directly. When no CLI value is found, an interactive
- * prompt is shown to the user.
- *
- * The returned parser always has `mode: "async"` because Inquirer.js prompts
- * are inherently asynchronous.
- *
- * Example:
- *
- * ```typescript
- * import { option } from "@optique/core/primitives";
- * import { string } from "@optique/core/valueparser";
- * import { prompt } from "@optique/inquirer";
- *
- * const nameParser = prompt(option("--name", string()), {
- *   type: "input",
- *   message: "Enter your name:",
- * });
- * ```
+ * When the inner parser finds a value in the CLI arguments, that value is used
+ * directly.  When no CLI value is found, an interactive prompt is shown to the
+ * user.
  *
  * @param parser Inner parser that reads CLI values.
  * @param config Type-safe Inquirer.js prompt configuration.
  * @returns A parser with interactive prompt fallback, always in async mode.
- * @throws {Error} If prompt execution fails with an unexpected error or if
- *                 the inner parser throws while parsing or completing.
+ * @throws {Error} If prompt execution fails with an unexpected error or if the
+ *                 inner parser throws while parsing or completing.
  * @since 1.0.0
  */
 declare function prompt<M extends Mode, TValue, TState>(parser: Parser<M, TValue, TState>, config: PromptConfig<TValue>): FluentParser<"async", TValue, TState>;
 //#endregion
-export { CheckboxConfig, Choice, ConfirmConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, RawlistConfig, SelectConfig, Separator, StringPromptConfig, prompt };
+export { CheckboxChoice, CheckboxConfig, Choice, ConfirmConfig, EditorConfig, ExpandChoice, ExpandConfig, InputConfig, NumberPromptConfig, PasswordConfig, PromptConfig, RawlistConfig, SelectConfig, Separator, StringPromptConfig, prompt };