@inquirer/input 2.1.12 → 2.2.1

package/README.md

@@ -6,12 +6,29 @@ Interactive free text input component for command line interfaces. Supports vali
 
 # Installation
 
+<table>
+<tr>
+  <th>npm</th>
+  <th>yarn</th>
+</tr>
+<tr>
+<td>
+
 ```sh
 npm install @inquirer/input
+```
+
+</td>
+<td>
 
+```sh
 yarn add @inquirer/input
 ```
 
+</td>
+</tr>
+</table>
+
 # Usage
 
 ```js
@@ -26,6 +43,7 @@ const answer = await input({ message: 'Enter your name' });
 | ----------- | ----------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | message     | `string`                                                    | yes      | The question to ask                                                                                                                                                                                                     |
 | default     | `string`                                                    | no       | Default value if no answer is provided (clear it by pressing backspace)                                                                                                                                                 |
+| 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. |
 | theme       | [See Theming](#Theming)                                     | no       | Customize look of the prompt.                                                                                                                                                                                           |

package/dist/cjs/index.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@inquirer/core");
 exports.default = (0, core_1.createPrompt)((config, done) => {
-    const { validate = () => true } = config;
+    const { required, validate = () => true } = config;
     const theme = (0, core_1.makeTheme)(config.theme);
     const [status, setStatus] = (0, core_1.useState)('pending');
     const [defaultValue = '', setDefaultValue] = (0, core_1.useState)(config.default);
@@ -27,7 +27,7 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
         if ((0, core_1.isEnterKey)(key)) {
             const answer = value || defaultValue;
             setStatus('loading');
-            const isValid = yield validate(answer);
+            const isValid = required && !answer ? 'You must provide a value' : yield validate(answer);
             if (isValid === true) {
                 setValue(answer);
                 setStatus('done');

package/dist/cjs/types/index.d.ts

@@ -3,6 +3,7 @@ import type { PartialDeep } from '@inquirer/type';
 type InputConfig = {
     message: string;
     default?: string;
+    required?: boolean;
     transformer?: (value: string, { isFinal }: {
         isFinal: boolean;
     }) => string;

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
 import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, isBackspaceKey, makeTheme, } from '@inquirer/core';
 export default createPrompt((config, done) => {
-    const { validate = () => true } = config;
+    const { required, validate = () => true } = config;
     const theme = makeTheme(config.theme);
     const [status, setStatus] = useState('pending');
     const [defaultValue = '', setDefaultValue] = useState(config.default);
@@ -16,7 +16,7 @@ export default createPrompt((config, done) => {
         if (isEnterKey(key)) {
             const answer = value || defaultValue;
             setStatus('loading');
-            const isValid = await validate(answer);
+            const isValid = required && !answer ? 'You must provide a value' : await validate(answer);
             if (isValid === true) {
                 setValue(answer);
                 setStatus('done');

package/dist/esm/types/index.d.mts

@@ -3,6 +3,7 @@ import type { PartialDeep } from '@inquirer/type';
 type InputConfig = {
     message: string;
     default?: string;
+    required?: boolean;
     transformer?: (value: string, { isFinal }: {
         isFinal: boolean;
     }) => string;

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+import { type Theme } from '@inquirer/core';
+import type { PartialDeep } from '@inquirer/type';
+type InputConfig = {
+    message: string;
+    default?: string;
+    required?: boolean;
+    transformer?: (value: string, { isFinal }: {
+        isFinal: boolean;
+    }) => string;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    theme?: PartialDeep<Theme>;
+};
+declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/input",
-  "version": "2.1.12",
+  "version": "2.2.1",
   "description": "Inquirer input text prompt",
   "main": "./dist/cjs/index.js",
   "typings": "./dist/cjs/types/index.d.ts",
@@ -54,11 +54,11 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/input/README.md",
   "dependencies": {
-    "@inquirer/core": "^9.0.0",
+    "@inquirer/core": "^9.0.2",
     "@inquirer/type": "^1.4.0"
   },
   "devDependencies": {
-    "@inquirer/testing": "^2.1.24"
+    "@inquirer/testing": "^2.1.25"
   },
   "scripts": {
     "tsc": "yarn run tsc:esm && yarn run tsc:cjs",
@@ -86,5 +86,5 @@
     }
   },
   "sideEffects": false,
-  "gitHead": "fc27d575bceb96466cb8da8524c26d4eb2a77df0"
+  "gitHead": "95d2d65d3aca2c0fab66c7fd40b5dc413dfc894f"
 }