@optique/inquirer 1.0.0-dev.0 → 1.0.0-dev.461

package/README.md

@@ -0,0 +1,81 @@
+@optique/inquirer
+=================
+
+Interactive prompt support for [Optique] via [Inquirer.js].
+
+This package wraps any Optique parser with an interactive prompt that fires
+when no CLI value is provided.  The fallback priority is:
+
+CLI arguments > interactive prompt.
+
+Because interactive prompts are inherently asynchronous, the returned parser
+always has `$mode: "async"`.
+
+[Optique]: https://optique.dev/
+[Inquirer.js]: https://github.com/SBoudrias/Inquirer.js
+
+
+Installation
+------------
+
+~~~~ bash
+deno add jsr:@optique/inquirer
+npm add @optique/inquirer
+pnpm add @optique/inquirer
+yarn add @optique/inquirer
+bun add @optique/inquirer
+~~~~
+
+
+Quick start
+-----------
+
+~~~~ typescript
+import { object } from "@optique/core/constructs";
+import { option } from "@optique/core/primitives";
+import { integer, string } from "@optique/core/valueparser";
+import { prompt } from "@optique/inquirer";
+import { run } from "@optique/run";
+
+const parser = object({
+  name: prompt(option("--name", string()), {
+    type: "input",
+    message: "Enter your name:",
+  }),
+  port: prompt(option("--port", integer()), {
+    type: "number",
+    message: "Enter the port number:",
+    default: 3000,
+  }),
+});
+
+await run(parser);
+~~~~
+
+When `--name` and `--port` are provided on the command line, the prompts are
+skipped.  When they are absent, the user sees interactive prompts.
+
+
+Features
+--------
+
+ -  *Ten prompt types*: `input`, `password`, `number`, `confirm`, `select`,
+    `rawlist`, `expand`, `checkbox`, `editor`, and a custom `prompter` for
+    testing
+ -  *Transparent composition* with `bindEnv()` and `bindConfig()` — the
+    prompt fires only when no higher-priority source supplies a value
+ -  *Prompt-only values* via `prompt(fail<T>(), …)` when a value should not
+    be exposed as a CLI option
+ -  *TTY-free testing* via the `prompter` escape hatch on every config type
+
+
+Documentation
+-------------
+
+For full documentation, visit <https://optique.dev/integrations/inquirer>.
+
+
+License
+-------
+
+MIT License. See [LICENSE](../../LICENSE) for details.

package/dist/index.cjs

@@ -173,9 +173,13 @@ function prompt(parser, config) {
 		parse: (context) => {
 			const annotations = (0, __optique_core_annotations.getAnnotations)(context.state);
 			const innerState = isPromptBindState(context.state) ? context.state.hasCliValue ? context.state.cliState : parser.initialState : context.state;
-			const innerContext = innerState !== context.state ? {
+			const innerStateWithAnnotations = annotations != null && (innerState == null || typeof innerState === "object" && !(__optique_core_annotations.annotationKey in innerState)) ? {
+				...innerState != null && typeof innerState === "object" ? innerState : {},
+				[__optique_core_annotations.annotationKey]: annotations
+			} : innerState;
+			const innerContext = innerStateWithAnnotations !== context.state ? {
 				...context,
-				state: innerState
+				state: innerStateWithAnnotations
 			} : context;
 			const processResult = (result$1) => {
 				if (result$1.success) {
@@ -226,9 +230,21 @@ function prompt(parser, config) {
 					promptCache = null;
 					return cached;
 				}
-				promptCache = executePrompt();
+				const innerState = parser.initialState;
+				const r = parser.complete(innerState);
+				const fallback = (res) => res.success ? Promise.resolve(res) : executePrompt();
+				promptCache = r instanceof Promise ? r.then(fallback) : fallback(r);
 				return promptCache;
 			}
+			const cliState = isPromptBindState(state) ? state.cliState : void 0;
+			const cliStateHasAnnotations = cliState != null && typeof cliState === "object" && __optique_core_annotations.annotationKey in cliState;
+			if (cliStateHasAnnotations) {
+				const innerState = cliState;
+				const r = parser.complete(innerState);
+				const fallback = (res) => res.success ? Promise.resolve(res) : executePrompt();
+				if (r instanceof Promise) return r.then(fallback);
+				return fallback(r);
+			}
 			return executePrompt();
 		},
 		suggest: (context, prefix) => {

package/dist/index.js

@@ -150,9 +150,13 @@ function prompt(parser, config) {
 		parse: (context) => {
 			const annotations = getAnnotations(context.state);
 			const innerState = isPromptBindState(context.state) ? context.state.hasCliValue ? context.state.cliState : parser.initialState : context.state;
-			const innerContext = innerState !== context.state ? {
+			const innerStateWithAnnotations = annotations != null && (innerState == null || typeof innerState === "object" && !(annotationKey in innerState)) ? {
+				...innerState != null && typeof innerState === "object" ? innerState : {},
+				[annotationKey]: annotations
+			} : innerState;
+			const innerContext = innerStateWithAnnotations !== context.state ? {
 				...context,
-				state: innerState
+				state: innerStateWithAnnotations
 			} : context;
 			const processResult = (result$1) => {
 				if (result$1.success) {
@@ -203,9 +207,21 @@ function prompt(parser, config) {
 					promptCache = null;
 					return cached;
 				}
-				promptCache = executePrompt();
+				const innerState = parser.initialState;
+				const r = parser.complete(innerState);
+				const fallback = (res) => res.success ? Promise.resolve(res) : executePrompt();
+				promptCache = r instanceof Promise ? r.then(fallback) : fallback(r);
 				return promptCache;
 			}
+			const cliState = isPromptBindState(state) ? state.cliState : void 0;
+			const cliStateHasAnnotations = cliState != null && typeof cliState === "object" && annotationKey in cliState;
+			if (cliStateHasAnnotations) {
+				const innerState = cliState;
+				const r = parser.complete(innerState);
+				const fallback = (res) => res.success ? Promise.resolve(res) : executePrompt();
+				if (r instanceof Promise) return r.then(fallback);
+				return fallback(r);
+			}
 			return executePrompt();
 		},
 		suggest: (context, prefix) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/inquirer",
-  "version": "1.0.0-dev.0",
+  "version": "1.0.0-dev.461+42812276",
   "description": "Interactive prompt support for Optique via Inquirer.js",
   "keywords": [
     "CLI",
@@ -56,12 +56,13 @@
   "sideEffects": false,
   "dependencies": {
     "@inquirer/prompts": "^8.3.0",
-    "@optique/core": "1.0.0"
+    "@optique/core": "1.0.0-dev.461+42812276"
   },
   "devDependencies": {
     "@types/node": "^20.19.9",
     "tsdown": "^0.13.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "@optique/env": "1.0.0-dev.461+42812276"
   },
   "scripts": {
     "build": "tsdown",