scenv-inquirer 0.3.2 → 0.3.3

package/README.md

@@ -47,7 +47,7 @@ Variable-level `prompt` overrides this default.
 
 ### Save and context callbacks
 
-`askSaveAfterPrompt()` and `askContext()` return functions for scenv's `onAskSaveAfterPrompt` and `onAskContext` callbacks. Use them when `SCENV_SAVE_PROMPT=ask` or `saveContextTo: "ask"`.
+`askWhetherToSave()` and `askContext()` return functions for scenv's `onAskWhetherToSave` and `onAskContext` callbacks. Use them when `shouldSavePrompt` is `ask` or when `saveContextTo: "ask"`.
 
 **`callbacks()`** wires all of the above in one go:
 
@@ -63,17 +63,17 @@ configure({ ...yourConfig, ...callbacks() });
 This sets:
 
 - **defaultPrompt** – inquirer for variable values when no value is resolved
-- **onAskSaveAfterPrompt** – "Save '{name}' for next time?" then "Which context?"
-- **onAskContext** – "Save to which context?" (list or new)
+- **onAskWhetherToSave** – "Save '{name}' for next time?" (y/n). Only used when `shouldSavePrompt` is "ask".
+- **onAskContext** – "Save to which context?" (list or new). Used when `saveContextTo` is "ask" or when saving after prompt and destination is "ask".
 
 ## API
 
 | Export | Description |
 |--------|-------------|
 | `prompt()` | Returns `(name, defaultValue) => Promise<T>` for use as variable `prompt` or `callbacks.defaultPrompt`. |
-| `askSaveAfterPrompt()` | Returns `onAskSaveAfterPrompt`: asks whether to save and which context. |
+| `askWhetherToSave()` | Returns `onAskWhetherToSave`: asks whether to save (y/n). Where to save is handled by `saveContextTo` or `onAskContext`. |
 | `askContext()` | Returns `onAskContext`: asks which context to save to. |
-| `callbacks()` | Returns `{ callbacks: { defaultPrompt, onAskSaveAfterPrompt, onAskContext } }`. |
+| `callbacks()` | Returns `{ callbacks: { defaultPrompt, onAskWhetherToSave, onAskContext } }`. |
 
 ## License
 

package/dist/index.cjs

@@ -31,14 +31,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   askContext: () => askContext,
-  askSaveAfterPrompt: () => askSaveAfterPrompt,
+  askWhetherToSave: () => askWhetherToSave,
   callbacks: () => callbacks,
   prompt: () => prompt
 });
 module.exports = __toCommonJS(index_exports);
 var import_inquirer = __toESM(require("inquirer"), 1);
 function prompt() {
-  return async (name, defaultValue) => {
+  return (async (name, defaultValue) => {
     const defaultStr = defaultValue !== void 0 && defaultValue !== null ? String(defaultValue) : "";
     const { value } = await import_inquirer.default.prompt([
       {
@@ -49,10 +49,10 @@ function prompt() {
       }
     ]);
     return value;
-  };
+  });
 }
-function askSaveAfterPrompt() {
-  return async (name, _value, contextNames) => {
+function askWhetherToSave() {
+  return async (name, _value) => {
     const { save } = await import_inquirer.default.prompt([
       {
         type: "confirm",
@@ -61,25 +61,7 @@ function askSaveAfterPrompt() {
         default: true
       }
     ]);
-    if (!save) return null;
-    const choices = [...contextNames];
-    if (choices.length === 0) choices.push("default");
-    choices.push("(new context)");
-    const { context } = await import_inquirer.default.prompt([
-      {
-        type: "list",
-        name: "context",
-        message: "Which context?",
-        choices
-      }
-    ]);
-    if (context === "(new context)") {
-      const { newContext } = await import_inquirer.default.prompt([
-        { type: "input", name: "newContext", message: "Context name:", default: "default" }
-      ]);
-      return newContext.trim() || "default";
-    }
-    return context;
+    return save;
   };
 }
 function askContext() {
@@ -105,18 +87,17 @@ function askContext() {
   };
 }
 function callbacks() {
-  return {
-    callbacks: {
-      defaultPrompt: prompt(),
-      onAskSaveAfterPrompt: askSaveAfterPrompt(),
-      onAskContext: askContext()
-    }
+  const cbs = {
+    defaultPrompt: prompt(),
+    onAskWhetherToSave: askWhetherToSave(),
+    onAskContext: askContext()
   };
+  return { callbacks: cbs };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   askContext,
-  askSaveAfterPrompt,
+  askWhetherToSave,
   callbacks,
   prompt
 });

package/dist/index.d.cts

@@ -1,30 +1,52 @@
+import { ScenvCallbacks, DefaultPromptFn } from 'scenv';
+
 /**
- * Returns a prompt function for use with scenv(): (name, defaultValue) => Promise<T>.
- * Scenv passes the variable name and default (from env/context/default); this uses inquirer to ask for input.
- * Returns string; use a validator (e.g. scenv-zod) for type/coercion.
+ * 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.
+ *
+ * @typeParam T - Value type (default string). Cast or validate in your validator.
+ * @returns A function `(name, defaultValue) => Promise<T>` suitable for scenv's prompt or defaultPrompt.
+ *
+ * @example
+ * const apiUrl = scenv("API URL", { default: "http://localhost:4000", prompt: prompt() });
+ * const url = await apiUrl.get(); // prompts via inquirer if no env/context
  */
-declare function prompt<T = string>(): (name: string, defaultValue: T) => Promise<T>;
+declare function prompt<T = string>(): DefaultPromptFn;
 /**
- * Returns a function suitable for scenv's onAskSaveAfterPrompt callback.
- * Asks "Save '{name}' for next time?" and, if yes, "Which context?" (from contextNames or new).
- * @returns Context name to save to, or null to skip saving
+ * Returns a function suitable for scenv's {@link ScenvCallbacks.onAskWhetherToSave} callback.
+ * Uses inquirer confirm to ask "Save '{name}' for next time?" (y/n). Where to save is
+ * determined by config.saveContextTo or the onAskContext callback when saveContextTo is "ask".
+ * Only called when {@link ScenvConfig.shouldSavePrompt} is "ask" and the user was just prompted. ("always" saves without asking.)
+ *
+ * @returns A function `(name, value) => Promise<boolean>`: true to save, false to skip.
  */
-declare function askSaveAfterPrompt(): (name: string, value: unknown, contextNames: string[]) => Promise<string | null>;
+declare function askWhetherToSave(): NonNullable<ScenvCallbacks["onAskWhetherToSave"]>;
 /**
- * Returns a function suitable for scenv's onAskContext callback.
- * Asks user to choose a context from contextNames or enter a new one.
+ * Returns a function suitable for scenv's {@link ScenvCallbacks.onAskContext} callback.
+ * Uses inquirer list to choose a context from contextNames, with a "(new context)" option
+ * that prompts for a new name. Used when {@link ScenvConfig.saveContextTo} is "ask" or
+ * when saving after a prompt and the destination is "ask".
+ *
+ * @returns A function `(name, contextNames) => Promise<string>` that returns the chosen context name.
  */
-declare function askContext(): (name: string, contextNames: string[]) => Promise<string>;
+declare function askContext(): NonNullable<ScenvCallbacks["onAskContext"]>;
 /**
- * Returns an object suitable for scenv's configure(): { callbacks: { defaultPrompt, onAskSaveAfterPrompt, onAskContext } }.
- * Use as configure(callbacks()) or configure({ ...config, ...callbacks() }) to wire a default inquirer prompt for variables and save/context prompts via inquirer. Variable-level prompt overrides defaultPrompt.
+ * Returns an object with all inquirer-based callbacks for scenv. Pass to {@link configure}
+ * to use inquirer for variable prompts, "save for next time?", and "which context?".
+ * Variable-level `prompt` overrides defaultPrompt.
+ *
+ * @returns `{ callbacks: { defaultPrompt, onAskWhetherToSave, onAskContext } }` – spread into configure() or merge with other config.
+ *
+ * @example
+ * import { configure } from "scenv";
+ * import { callbacks } from "scenv-inquirer";
+ * configure(callbacks());
+ * // or: configure({ ...parseScenvArgs(process.argv.slice(2)), ...callbacks() });
  */
 declare function callbacks(): {
-    callbacks: {
-        defaultPrompt: ReturnType<typeof prompt>;
-        onAskSaveAfterPrompt: ReturnType<typeof askSaveAfterPrompt>;
-        onAskContext: ReturnType<typeof askContext>;
-    };
+    callbacks: ScenvCallbacks;
 };
 
-export { askContext, askSaveAfterPrompt, callbacks, prompt };
+export { askContext, askWhetherToSave, callbacks, prompt };

package/dist/index.d.ts

@@ -1,30 +1,52 @@
+import { ScenvCallbacks, DefaultPromptFn } from 'scenv';
+
 /**
- * Returns a prompt function for use with scenv(): (name, defaultValue) => Promise<T>.
- * Scenv passes the variable name and default (from env/context/default); this uses inquirer to ask for input.
- * Returns string; use a validator (e.g. scenv-zod) for type/coercion.
+ * 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.
+ *
+ * @typeParam T - Value type (default string). Cast or validate in your validator.
+ * @returns A function `(name, defaultValue) => Promise<T>` suitable for scenv's prompt or defaultPrompt.
+ *
+ * @example
+ * const apiUrl = scenv("API URL", { default: "http://localhost:4000", prompt: prompt() });
+ * const url = await apiUrl.get(); // prompts via inquirer if no env/context
  */
-declare function prompt<T = string>(): (name: string, defaultValue: T) => Promise<T>;
+declare function prompt<T = string>(): DefaultPromptFn;
 /**
- * Returns a function suitable for scenv's onAskSaveAfterPrompt callback.
- * Asks "Save '{name}' for next time?" and, if yes, "Which context?" (from contextNames or new).
- * @returns Context name to save to, or null to skip saving
+ * Returns a function suitable for scenv's {@link ScenvCallbacks.onAskWhetherToSave} callback.
+ * Uses inquirer confirm to ask "Save '{name}' for next time?" (y/n). Where to save is
+ * determined by config.saveContextTo or the onAskContext callback when saveContextTo is "ask".
+ * Only called when {@link ScenvConfig.shouldSavePrompt} is "ask" and the user was just prompted. ("always" saves without asking.)
+ *
+ * @returns A function `(name, value) => Promise<boolean>`: true to save, false to skip.
  */
-declare function askSaveAfterPrompt(): (name: string, value: unknown, contextNames: string[]) => Promise<string | null>;
+declare function askWhetherToSave(): NonNullable<ScenvCallbacks["onAskWhetherToSave"]>;
 /**
- * Returns a function suitable for scenv's onAskContext callback.
- * Asks user to choose a context from contextNames or enter a new one.
+ * Returns a function suitable for scenv's {@link ScenvCallbacks.onAskContext} callback.
+ * Uses inquirer list to choose a context from contextNames, with a "(new context)" option
+ * that prompts for a new name. Used when {@link ScenvConfig.saveContextTo} is "ask" or
+ * when saving after a prompt and the destination is "ask".
+ *
+ * @returns A function `(name, contextNames) => Promise<string>` that returns the chosen context name.
  */
-declare function askContext(): (name: string, contextNames: string[]) => Promise<string>;
+declare function askContext(): NonNullable<ScenvCallbacks["onAskContext"]>;
 /**
- * Returns an object suitable for scenv's configure(): { callbacks: { defaultPrompt, onAskSaveAfterPrompt, onAskContext } }.
- * Use as configure(callbacks()) or configure({ ...config, ...callbacks() }) to wire a default inquirer prompt for variables and save/context prompts via inquirer. Variable-level prompt overrides defaultPrompt.
+ * Returns an object with all inquirer-based callbacks for scenv. Pass to {@link configure}
+ * to use inquirer for variable prompts, "save for next time?", and "which context?".
+ * Variable-level `prompt` overrides defaultPrompt.
+ *
+ * @returns `{ callbacks: { defaultPrompt, onAskWhetherToSave, onAskContext } }` – spread into configure() or merge with other config.
+ *
+ * @example
+ * import { configure } from "scenv";
+ * import { callbacks } from "scenv-inquirer";
+ * configure(callbacks());
+ * // or: configure({ ...parseScenvArgs(process.argv.slice(2)), ...callbacks() });
  */
 declare function callbacks(): {
-    callbacks: {
-        defaultPrompt: ReturnType<typeof prompt>;
-        onAskSaveAfterPrompt: ReturnType<typeof askSaveAfterPrompt>;
-        onAskContext: ReturnType<typeof askContext>;
-    };
+    callbacks: ScenvCallbacks;
 };
 
-export { askContext, askSaveAfterPrompt, callbacks, prompt };
+export { askContext, askWhetherToSave, callbacks, prompt };

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/index.ts
 import inquirer from "inquirer";
 function prompt() {
-  return async (name, defaultValue) => {
+  return (async (name, defaultValue) => {
     const defaultStr = defaultValue !== void 0 && defaultValue !== null ? String(defaultValue) : "";
     const { value } = await inquirer.prompt([
       {
@@ -12,10 +12,10 @@ function prompt() {
       }
     ]);
     return value;
-  };
+  });
 }
-function askSaveAfterPrompt() {
-  return async (name, _value, contextNames) => {
+function askWhetherToSave() {
+  return async (name, _value) => {
     const { save } = await inquirer.prompt([
       {
         type: "confirm",
@@ -24,25 +24,7 @@ function askSaveAfterPrompt() {
         default: true
       }
     ]);
-    if (!save) return null;
-    const choices = [...contextNames];
-    if (choices.length === 0) choices.push("default");
-    choices.push("(new context)");
-    const { context } = await inquirer.prompt([
-      {
-        type: "list",
-        name: "context",
-        message: "Which context?",
-        choices
-      }
-    ]);
-    if (context === "(new context)") {
-      const { newContext } = await inquirer.prompt([
-        { type: "input", name: "newContext", message: "Context name:", default: "default" }
-      ]);
-      return newContext.trim() || "default";
-    }
-    return context;
+    return save;
   };
 }
 function askContext() {
@@ -68,17 +50,16 @@ function askContext() {
   };
 }
 function callbacks() {
-  return {
-    callbacks: {
-      defaultPrompt: prompt(),
-      onAskSaveAfterPrompt: askSaveAfterPrompt(),
-      onAskContext: askContext()
-    }
+  const cbs = {
+    defaultPrompt: prompt(),
+    onAskWhetherToSave: askWhetherToSave(),
+    onAskContext: askContext()
   };
+  return { callbacks: cbs };
 }
 export {
   askContext,
-  askSaveAfterPrompt,
+  askWhetherToSave,
   callbacks,
   prompt
 };

package/package.json

@@ -1,24 +1,20 @@
 {
   "name": "scenv-inquirer",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Inquirer prompt for scenv variables",
-  "repository": { "type": "git", "url": "https://github.com/PKWadsy/scenv" },
-  "publishConfig": { "access": "public", "provenance": true },
+  "repository": {"type": "git", "url": "https://github.com/PKWadsy/scenv"},
+  "publishConfig": {"access": "public", "provenance": true},
   "keywords": ["scenv", "inquirer", "prompt"],
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
+  "exports": {".": {"import": "./dist/index.js", "require": "./dist/index.cjs", "types": "./dist/index.d.ts"}},
   "files": ["dist"],
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean"
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "peerDependencies": {
     "inquirer": "^8.0.0 || ^9.0.0",
@@ -29,6 +25,7 @@
     "inquirer": "^9.2.0",
     "scenv": "workspace:*",
     "tsup": "^8.0.0",
-    "typescript": "^5.3.0"
+    "typescript": "^5.3.0",
+    "vitest": "^2.0.0"
   }
 }