@inquirer/prompts 2.0.0 → 2.1.0

package/README.md

@@ -200,20 +200,40 @@ if (allowEmail) {
 ## Get default value after timeout
 
 ```js
+import { setTimeout } from 'node:timers/promises';
 import { input } from '@inquirer/prompts';
 
 const answer = input(...);
 
-const defaultValue = new Promise(resolve => {
-	setTimeout(() => {
-		resolve(...);
-		answer.cancel();
-	}, 5000);
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/prompts",
-  "version": "2.0.0",
+  "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.3.0",
-    "@inquirer/confirm": "^2.0.0",
-    "@inquirer/core": "^2.0.0",
-    "@inquirer/editor": "^1.1.0",
-    "@inquirer/expand": "^1.1.0",
-    "@inquirer/input": "^1.2.0",
-    "@inquirer/password": "^1.1.0",
-    "@inquirer/rawlist": "^1.2.0",
-    "@inquirer/select": "^1.2.0"
+    "@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": "86531864067faf1d6e76f1581c9aa72cb1b03753"
+  "gitHead": "d48ecde923e5875de631f7b50f67cfaf00384947"
 }