@inquirer/input 4.1.11 → 4.2.0

package/README.md

@@ -73,7 +73,8 @@ const answer = await input({ message: 'Enter your name' });
 | Property    | Type                                                        | Required | Description                                                                                                                                                                                                             |
 | ----------- | ----------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | message     | `string`                                                    | yes      | The question to ask                                                                                                                                                                                                     |
-| default     | `string`                                                    | no       | Default value if no answer is provided (press `backspace` to clear the default; press `tab` to inline the value for edits)                                                                                              |
+| default     | `string`                                                    | no       | Default value if no answer is provided; see the prefill option below for governing it's behaviour.                                                                                                                      |
+| prefill     | `'tab' \| 'editable'`                                       | no       | Defaults to `'tab'`. If set to `'tab'`, pressing `backspace` will clear the default and pressing `tab` will inline the value for edits; If set to `'editable'`, the default value will already be inlined to edit.      |
 | required    | `boolean`                                                   | no       | Defaults to `false`. If set to true, `undefined` (empty) will not be accepted for this.                                                                                                                                 |
 | transformer | `(string, { isFinal: boolean }) => string`                  | no       | Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual, modify the answer in your code if needed.                                   |
 | validate    | `string => boolean \| string \| Promise<boolean \| string>` | no       | On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |

package/dist/commonjs/index.d.ts

@@ -6,6 +6,7 @@ type InputTheme = {
 type InputConfig = {
     message: string;
     default?: string;
+    prefill?: 'tab' | 'editable';
     required?: boolean;
     transformer?: (value: string, { isFinal }: {
         isFinal: boolean;

package/dist/commonjs/index.js

@@ -5,7 +5,7 @@ const inputTheme = {
     validationFailureMode: 'keep',
 };
 exports.default = (0, core_1.createPrompt)((config, done) => {
-    const { required, validate = () => true } = config;
+    const { required, validate = () => true, prefill = 'tab' } = config;
     const theme = (0, core_1.makeTheme)(inputTheme, config.theme);
     const [status, setStatus] = (0, core_1.useState)('idle');
     const [defaultValue = '', setDefaultValue] = (0, core_1.useState)(config.default);
@@ -53,6 +53,14 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
             setError(undefined);
         }
     });
+    // If prefill is set to 'editable' cut out the default value and paste into current state and the user's cli buffer
+    // They can edit the value immediately instead of needing to press 'tab'
+    (0, core_1.useEffect)((rl) => {
+        if (prefill === 'editable' && defaultValue) {
+            rl.write(defaultValue);
+            setValue(defaultValue);
+        }
+    }, []);
     const message = theme.style.message(config.message, status);
     let formattedValue = value;
     if (typeof config.transformer === 'function') {

package/dist/esm/index.d.ts

@@ -6,6 +6,7 @@ type InputTheme = {
 type InputConfig = {
     message: string;
     default?: string;
+    prefill?: 'tab' | 'editable';
     required?: boolean;
     transformer?: (value: string, { isFinal }: {
         isFinal: boolean;

package/dist/esm/index.js

@@ -1,9 +1,9 @@
-import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, isBackspaceKey, makeTheme, } from '@inquirer/core';
+import { createPrompt, useState, useKeypress, useEffect, usePrefix, isEnterKey, isBackspaceKey, makeTheme, } from '@inquirer/core';
 const inputTheme = {
     validationFailureMode: 'keep',
 };
 export default createPrompt((config, done) => {
-    const { required, validate = () => true } = config;
+    const { required, validate = () => true, prefill = 'tab' } = config;
     const theme = makeTheme(inputTheme, config.theme);
     const [status, setStatus] = useState('idle');
     const [defaultValue = '', setDefaultValue] = useState(config.default);
@@ -51,6 +51,14 @@ export default createPrompt((config, done) => {
             setError(undefined);
         }
     });
+    // If prefill is set to 'editable' cut out the default value and paste into current state and the user's cli buffer
+    // They can edit the value immediately instead of needing to press 'tab'
+    useEffect((rl) => {
+        if (prefill === 'editable' && defaultValue) {
+            rl.write(defaultValue);
+            setValue(defaultValue);
+        }
+    }, []);
     const message = theme.style.message(config.message, status);
     let formattedValue = value;
     if (typeof config.transformer === 'function') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/input",
-  "version": "4.1.11",
+  "version": "4.2.0",
   "description": "Inquirer input text prompt",
   "keywords": [
     "answer",
@@ -74,12 +74,12 @@
     "tsc": "tshy"
   },
   "dependencies": {
-    "@inquirer/core": "^10.1.12",
+    "@inquirer/core": "^10.1.14",
     "@inquirer/type": "^3.0.7"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.1",
-    "@inquirer/testing": "^2.1.47",
+    "@inquirer/testing": "^2.1.48",
     "tshy": "^3.0.2"
   },
   "engines": {
@@ -105,5 +105,5 @@
       "optional": true
     }
   },
-  "gitHead": "85d4642b4a7a2229ea60167fc7cc25fe6fea2f18"
+  "gitHead": "43b7bb94390c1e2b6473af1b790ff2fd1c8007c8"
 }