https://github.com/lnquy065/inquirer-interrupted-prompt
Turning any existing inquirer and its plugin prompts into prompts that can be interrupted with a custom key.
https://github.com/lnquy065/inquirer-interrupted-prompt
input inquirer javascript prompt
Last synced: 2 months ago
JSON representation
Turning any existing inquirer and its plugin prompts into prompts that can be interrupted with a custom key.
- Host: GitHub
- URL: https://github.com/lnquy065/inquirer-interrupted-prompt
- Owner: lnquy065
- License: mit
- Created: 2022-04-03T10:57:11.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-26T03:09:26.000Z (about 2 years ago)
- Last Synced: 2024-10-07T03:17:07.844Z (8 months ago)
- Topics: input, inquirer, javascript, prompt
- Language: TypeScript
- Homepage:
- Size: 68.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# inquirer-interrupted-prompt
Allows turning any existing [inquirer](https://github.com/SBoudrias/Inquirer.js) and its plugin prompts into prompts that can be interrupted with a custom key.
It works for menu and submenu programs. For example, we have an application that allows browsing and editing files:
```
==== File browser ====
Search file
> Create new file
Edit file
```
Now we will create new file by select the second option. A promts will be shown to ask the file name:
```
==== Create new file ====
? Input new file name:
```
Assuming we don't want to create a file anymore, we want to go back to the main menu. Now, with an interrupted prompt, we can easily go back by pressing the `Esc` key or whatever key you want.
One convenient thing is that you don't need to register for this type of prompt, you just need to convert existing inquirer and its plugin prompts to this format with just one function.
View demo menu code at: /example/ts-demo/src/index.ts
# Installation
`npm install inquirer-interrupted-prompt --save`
or
`yarn add inquirer-interrupted-prompt`
_Note: projects are using inquirer < 9, please use version 2.x.x_
```
npm install inquirer-interrupted-prompt@^2
yarn add inquirer-interrupted-prompt@^2
```
# Usage
After importing the package, we need to register new interrupted prompts to `inquirer`.
_Note: Examples below are written in ESModule, you can use CommonJS as well_
## To turn all prompts to interrupted prompts
```javascript
import inquirer from "inquirer";
import InterruptedPrompt from "inquirer-interrupted-prompt";
InterruptedPrompt.fromAll(inquirer);
```
Now all **default inquirer prompts** and **its plugins** will be converted to interrupted form. You can reuse your code without changing anything:
```javascript
import inquirer from "inquirer";
import InterruptedPrompt from "inquirer-interrupted-prompt";
import autocompletePrompt from "inquirer-autocomplete-prompt"; // working with plugin as well
InterruptedPrompt.fromAll(inquirer);
inquirer
.prompt([
{
type: "input",
name: "intr-input",
message: "Interrupted input",
},
{
type: "number",
name: "intr-number",
message: "Interrupted number",
},
])
.then((answers) => {
console.log(answers);
})
.catch((error) => {
if (error.isTtyError) {
} else {
if (error === InterruptedPrompt.EVENT_INTERRUPTED) {
console.log("Prompt has been interrupted");
}
}
});
```
## To turn a specific prompt to interrupted prompt
If you don't want to convert all prompts, you can use the `from` function to convert a specific prompt that you want.
```javascript
import inquirer from "inquirer";
import inquirerInputPrompt from "inquirer/lib/prompts/input";
import InterruptedPrompt from "inquirer-interrupted-prompt";
inquirer.registerPrompt("input", InterruptedPrompt.from(inquirerInputPrompt));
```
With plugin prompt
```javascript
import autocompletePrompt from "inquirer-autocomplete-prompt";
import InterruptedPrompt from "inquirer-interrupted-prompt";
inquirer.registerPrompt(
"autocomplete",
InterruptedPrompt.from(autocompletePrompt)
);
```
## Customize interrupted key
You can set any key name you want via `interruptedKeyName` in question option:
```javascript
inquirer
.prompt([
{
type: "input",
name: "intr-input",
message: "Interrupted input with default key",
},
{
type: "input",
name: "intr-input-2",
message: "Interrupted input with key",
interruptedKeyName: "a",
},
])
.then((answers) => {
console.log(answers);
})
.catch((error) => {
if (error.isTtyError) {
} else {
if (error === InterruptedPrompt.EVENT_INTERRUPTED) {
console.log("Prompt has been interrupted");
}
}
});
```
### With Combined Keys
**Ctrl**
```javascript
{
interruptedKeyName: "ctrl+f"
}
```
**Alt**
```javascript
{
interruptedKeyName: "meta+f"
}
```
**Shift**
```javascript
{
interruptedKeyName: "shift+f"
}
```
## Exception handler
If an interrupted event has been triggered, it will throw an exception. There are two ways you can do to handle the exception from interruption:
### Promise
```javascript
inquirer
.prompt([])
.then((answers) => {})
.catch((error) => {
if (error === InterruptedPrompt.EVENT_INTERRUPTED) {
console.log("Prompt has been interrupted");
}
});
```
### Try - catch
```javascript
try {
await inquirer.prompt([]);
} catch (error) {
if (error === InterruptedPrompt.EVENT_INTERRUPTED) {
console.log("Prompt has been interrupted");
}
}
```
## License
MIT © [lnquy065](https://github.com/lnquy065)