@inquirer/input 4.0.2 → 4.1.0

package/README.md

@@ -86,9 +86,12 @@ type Theme = {
     error: (text: string) => string;
     defaultAnswer: (text: string) => string;
   };
+  validationFailureMode: 'keep' | 'clear';
 };
 ```
 
+`validationFailureMode` defines the behavior of the prompt when the value submitted is invalid. By default, we'll keep the value allowing the user to edit it. When the theme option is set to `clear`, we'll remove and reset to an empty string.
+
 # License
 
 Copyright (c) 2023 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))<br/>

package/dist/commonjs/index.d.ts

@@ -1,5 +1,8 @@
 import { type Theme } from '@inquirer/core';
 import type { PartialDeep } from '@inquirer/type';
+type InputTheme = {
+    validationFailureMode: 'keep' | 'clear';
+};
 type InputConfig = {
     message: string;
     default?: string;
@@ -8,7 +11,7 @@ type InputConfig = {
         isFinal: boolean;
     }) => string;
     validate?: (value: string) => boolean | string | Promise<string | boolean>;
-    theme?: PartialDeep<Theme>;
+    theme?: PartialDeep<Theme<InputTheme>>;
 };
 declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
 export default _default;

package/dist/commonjs/index.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@inquirer/core");
+const inputTheme = {
+    validationFailureMode: 'keep',
+};
 exports.default = (0, core_1.createPrompt)((config, done) => {
     const { required, validate = () => true } = config;
-    const theme = (0, core_1.makeTheme)(config.theme);
+    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);
     const [errorMsg, setError] = (0, core_1.useState)();
@@ -24,9 +27,14 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
                 done(answer);
             }
             else {
-                // Reset the readline line value to the previous value. On line event, the value
-                // get cleared, forcing the user to re-enter the value instead of fixing it.
-                rl.write(value);
+                if (theme.validationFailureMode === 'clear') {
+                    setValue('');
+                }
+                else {
+                    // Reset the readline line value to the previous value. On line event, the value
+                    // get cleared, forcing the user to re-enter the value instead of fixing it.
+                    rl.write(value);
+                }
                 setError(isValid || 'You must provide a valid value');
                 setStatus('idle');
             }

package/dist/esm/index.d.ts

@@ -1,5 +1,8 @@
 import { type Theme } from '@inquirer/core';
 import type { PartialDeep } from '@inquirer/type';
+type InputTheme = {
+    validationFailureMode: 'keep' | 'clear';
+};
 type InputConfig = {
     message: string;
     default?: string;
@@ -8,7 +11,7 @@ type InputConfig = {
         isFinal: boolean;
     }) => string;
     validate?: (value: string) => boolean | string | Promise<string | boolean>;
-    theme?: PartialDeep<Theme>;
+    theme?: PartialDeep<Theme<InputTheme>>;
 };
 declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
 export default _default;

package/dist/esm/index.js

@@ -1,7 +1,10 @@
 import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, isBackspaceKey, makeTheme, } from '@inquirer/core';
+const inputTheme = {
+    validationFailureMode: 'keep',
+};
 export default createPrompt((config, done) => {
     const { required, validate = () => true } = config;
-    const theme = makeTheme(config.theme);
+    const theme = makeTheme(inputTheme, config.theme);
     const [status, setStatus] = useState('idle');
     const [defaultValue = '', setDefaultValue] = useState(config.default);
     const [errorMsg, setError] = useState();
@@ -22,9 +25,14 @@ export default createPrompt((config, done) => {
                 done(answer);
             }
             else {
-                // Reset the readline line value to the previous value. On line event, the value
-                // get cleared, forcing the user to re-enter the value instead of fixing it.
-                rl.write(value);
+                if (theme.validationFailureMode === 'clear') {
+                    setValue('');
+                }
+                else {
+                    // Reset the readline line value to the previous value. On line event, the value
+                    // get cleared, forcing the user to re-enter the value instead of fixing it.
+                    rl.write(value);
+                }
                 setError(isValid || 'You must provide a valid value');
                 setStatus('idle');
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/input",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Inquirer input text prompt",
   "keywords": [
     "answer",
@@ -74,12 +74,12 @@
     "tsc": "tshy"
   },
   "dependencies": {
-    "@inquirer/core": "^10.1.0",
+    "@inquirer/core": "^10.1.1",
     "@inquirer/type": "^3.0.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.0",
-    "@inquirer/testing": "^2.1.37",
+    "@inquirer/testing": "^2.1.38",
     "@repo/tsconfig": "workspace:*",
     "tshy": "^3.0.2"
   },
@@ -101,5 +101,5 @@
   "peerDependencies": {
     "@types/node": ">=18"
   },
-  "gitHead": "84e49bdb552e1cb4f035d644190913f367a66e74"
+  "gitHead": "5713287885155c0081fca4190c17c18c598d9602"
 }