@inquirer/prompts 1.2.3 → 2.1.0

package/README.md

@@ -9,6 +9,12 @@ A collection of common interactive command line user interfaces.
 
 ![List prompt](https://cdn.rawgit.com/SBoudrias/Inquirer.js/28ae8337ba51d93e359ef4f7ee24e79b69898962/assets/screenshots/list.svg)
 
+Give it a try in your own terminal!
+
+```sh
+npx @inquirer/demo@latest
+```
+
 # Installation
 
 ```sh
@@ -145,6 +151,20 @@ const allowEmail = await confirm(
 );
 ```
 
+## Canceling prompt
+
+All prompt functions are returning a cancelable promise. This special promise type has a `cancel` method that'll cancel and cleanup the prompt.
+
+On calling `cancel`, the answer promise will become rejected.
+
+```js
+import { confirm } from '@inquirer/prompts';
+
+const answer = confirm(...); // note: for this you cannot use `await`
+
+answer.cancel();
+```
+
 # Recipes
 
 ## Get answers in an object
@@ -177,6 +197,43 @@ if (allowEmail) {
 }
 ```
 
+## Get default value after timeout
+
+```js
+import { setTimeout } from 'node:timers/promises';
+import { input } from '@inquirer/prompts';
+
+const answer = input(...);
+
+const defaultValue = setTimeout(5000).then(() => {
+  answer.cancel();
+  return 'default answer';
+});
+
+const answer = await Promise.race([defaultValue, answer])
+```
+
+## Using as pre-commit/git hooks, or scripts
+
+By default scripts ran from tools like `husky`/`lint-staged` might not run inside an interactive shell. In non-interactive shell, Inquirer cannot run, and users cannot send keypress events to the process.
+
+For it to work, you must make sure you start a `tty` (or "interactive" input stream.)
+
+If those scripts are set within your `package.json`, you can define the stream like so:
+
+```json
+  "precommit": "my-script < /dev/tty"
+```
+
+Or if in a shell script file, you'll do it like so: (on Windows that's likely your only option)
+
+```sh
+#!/bin/sh
+exec < /dev/tty
+
+node my-script.js
+```
+
 # Community prompts
 
 If you created a cool prompt, [send us a PR adding it](https://github.com/SBoudrias/Inquirer.js/edit/master/README.md) to the list below!

package/dist/cjs/index.js

@@ -1,9 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Separator = exports.select = exports.rawlist = exports.password = exports.input = exports.expand = exports.editor = exports.confirm = exports.checkbox = void 0;
+exports.select = exports.rawlist = exports.password = exports.input = exports.expand = exports.editor = exports.confirm = exports.checkbox = void 0;
 const checkbox_1 = __importDefault(require("@inquirer/checkbox"));
 exports.checkbox = checkbox_1.default;
 const confirm_1 = __importDefault(require("@inquirer/confirm"));
@@ -20,5 +34,4 @@ const rawlist_1 = __importDefault(require("@inquirer/rawlist"));
 exports.rawlist = rawlist_1.default;
 const select_1 = __importDefault(require("@inquirer/select"));
 exports.select = select_1.default;
-const core_1 = require("@inquirer/core");
-Object.defineProperty(exports, "Separator", { enumerable: true, get: function () { return core_1.Separator; } });
+__exportStar(require("@inquirer/core"), exports);

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

@@ -6,5 +6,5 @@ import input from '@inquirer/input';
 import password from '@inquirer/password';
 import rawlist from '@inquirer/rawlist';
 import select from '@inquirer/select';
-import { Separator } from '@inquirer/core';
-export { checkbox, confirm, editor, expand, input, password, rawlist, select, Separator };
+export * from '@inquirer/core';
+export { checkbox, confirm, editor, expand, input, password, rawlist, select };

package/dist/esm/index.mjs

@@ -6,5 +6,5 @@ import input from '@inquirer/input';
 import password from '@inquirer/password';
 import rawlist from '@inquirer/rawlist';
 import select from '@inquirer/select';
-import { Separator } from '@inquirer/core';
-export { checkbox, confirm, editor, expand, input, password, rawlist, select, Separator };
+export * from '@inquirer/core';
+export { checkbox, confirm, editor, expand, input, password, rawlist, select };

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

@@ -6,5 +6,5 @@ import input from '@inquirer/input';
 import password from '@inquirer/password';
 import rawlist from '@inquirer/rawlist';
 import select from '@inquirer/select';
-import { Separator } from '@inquirer/core';
-export { checkbox, confirm, editor, expand, input, password, rawlist, select, Separator };
+export * from '@inquirer/core';
+export { checkbox, confirm, editor, expand, input, password, rawlist, select };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/prompts",
-  "version": "1.2.3",
+  "version": "2.1.0",
   "description": "Inquirer prompts, combined in a single package",
   "main": "./dist/cjs/index.js",
   "typings": "./dist/cjs/types/index.d.cts",
@@ -77,16 +77,16 @@
     }
   },
   "dependencies": {
-    "@inquirer/checkbox": "^1.2.8",
-    "@inquirer/confirm": "^1.0.11",
-    "@inquirer/core": "^1.3.0",
-    "@inquirer/editor": "^1.0.11",
-    "@inquirer/expand": "^1.0.11",
-    "@inquirer/input": "^1.1.2",
-    "@inquirer/password": "^1.0.11",
-    "@inquirer/rawlist": "^1.1.3",
-    "@inquirer/select": "^1.1.7"
+    "@inquirer/checkbox": "^1.3.1",
+    "@inquirer/confirm": "^2.0.1",
+    "@inquirer/core": "^2.1.0",
+    "@inquirer/editor": "^1.2.0",
+    "@inquirer/expand": "^1.1.1",
+    "@inquirer/input": "^1.2.1",
+    "@inquirer/password": "^1.1.1",
+    "@inquirer/rawlist": "^1.2.1",
+    "@inquirer/select": "^1.2.1"
   },
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/prompts/README.md",
-  "gitHead": "235c18f13650735b201a8853b28eda001f953d0f"
+  "gitHead": "d48ecde923e5875de631f7b50f67cfaf00384947"
 }