scenv-inquirer 0.4.0 → 0.4.1

package/README.md

@@ -18,7 +18,7 @@ npm install scenv scenv-inquirer inquirer
 
 ### Variable prompt
 
-Use `prompt()` as the `prompt` option for a variable. Scenv calls it with `(name, defaultValue)` when it needs to ask the user.
+Use `prompt()` as the `prompt` option for a variable. Scenv calls it with `(name, defaultValue)` when it needs to ask the user. **Scenv does not prompt by default** — enable prompting via config (e.g. `configure({ prompt: "fallback" })`, `SCENV_PROMPT=fallback`, or `prompt` in `scenv.config.json`).
 
 ```ts
 import { scenv } from "scenv";
@@ -29,7 +29,8 @@ const apiUrl = scenv("API URL", {
   prompt: prompt(),
 });
 
-const url = await apiUrl.get(); // prompts via inquirer if no env/context/default
+configure({ prompt: "fallback" }); // or "always" / "no-env"
+const url = await apiUrl.get(); // prompts via inquirer if no env/context
 ```
 
 ### Default prompt for all variables
@@ -56,7 +57,7 @@ configure(callbacks());
 configure({ ...yourConfig, ...callbacks() });
 ```
 
-This sets **defaultPrompt** so variable values are prompted via inquirer when no value is resolved from set/env/context.
+This sets **defaultPrompt** so variable values are prompted via inquirer when no value is resolved from set/env/context. You must still enable prompting in scenv (e.g. `configure({ prompt: "fallback" })`).
 
 ## API
 

package/dist/index.d.cts

@@ -4,9 +4,9 @@ import { ScenvCallbacks, DefaultPromptFn } from 'scenv';
  * Returns an inquirer-based prompt function for use with scenv variables. Use as the
  * variable's `prompt` option or as `callbacks.defaultPrompt`. Scenv calls it with the
  * variable name and default value when prompting; this shows an inquirer input prompt.
- * Returned value is a string; use a validator (e.g. scenv-zod) for type coercion.
+ * Returned value is a string; use a parser (e.g. scenv-zod) for type coercion.
  *
- * @typeParam T - Value type (default string). Cast or validate in your validator.
+ * @typeParam T - Value type (default string). Cast or parse in your parser.
  * @returns A function `(name, defaultValue) => Promise<T>` suitable for scenv's prompt or defaultPrompt.
  *
  * @example

package/dist/index.d.ts

@@ -4,9 +4,9 @@ import { ScenvCallbacks, DefaultPromptFn } from 'scenv';
  * Returns an inquirer-based prompt function for use with scenv variables. Use as the
  * variable's `prompt` option or as `callbacks.defaultPrompt`. Scenv calls it with the
  * variable name and default value when prompting; this shows an inquirer input prompt.
- * Returned value is a string; use a validator (e.g. scenv-zod) for type coercion.
+ * Returned value is a string; use a parser (e.g. scenv-zod) for type coercion.
  *
- * @typeParam T - Value type (default string). Cast or validate in your validator.
+ * @typeParam T - Value type (default string). Cast or parse in your parser.
  * @returns A function `(name, defaultValue) => Promise<T>` suitable for scenv's prompt or defaultPrompt.
  *
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scenv-inquirer",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Inquirer prompt for scenv variables",
   "repository": {"type": "git", "url": "https://github.com/PKWadsy/scenv"},
   "publishConfig": {"access": "public", "provenance": true},