-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add @inquirer/prompts new homepage documentation
- Loading branch information
Showing
2 changed files
with
189 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| <img width="75px" height="75px" align="right" alt="Inquirer Logo" src="https://raw.githubusercontent.com/SBoudrias/Inquirer.js/master/assets/inquirer_readme.svg?sanitize=true" title="Inquirer.js"/> | ||
|
|
||
| # Inquirer | ||
|
|
||
| [](https://badge.fury.io/js/@inquirer%2Finput.svg) | ||
| [](https://codecov.io/gh/SBoudrias/Inquirer.js) | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2FSBoudrias%2FInquirer.js?ref=badge_shield) | ||
|
|
||
| A collection of common interactive command line user interfaces. | ||
|
|
||
|  | ||
|
|
||
| # Installation | ||
|
|
||
| ```sh | ||
| npm install @inquirer/prompts | ||
|
|
||
| yarn add @inquirer/prompts | ||
| ``` | ||
|
|
||
| Inquirer recently underwent a rewrite from the ground up to reduce the package size and improve performance. The previous version of the package is still maintained (though not actively developed), and offered hundreds of community contributed prompts that might not have been migrated to the latest API. If this is what you're looking for, the [previous package is over here](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/inquirer). | ||
|
|
||
| # Usage | ||
|
|
||
| ```js | ||
| import { input } from '@inquirer/prompts'; | ||
|
|
||
| const answer = await input({ message: 'Enter your name' }); | ||
| ``` | ||
|
|
||
| # Prompts | ||
|
|
||
| ## [Select](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/select) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { select } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/select) for usage example and options documentation. | ||
|
|
||
| ## [Raw List](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/rawlist) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { rawlist } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/rawlist) for usage example and options documentation. | ||
|
|
||
| ## [Expand](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/expand) | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ```js | ||
| import { expand } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/expand) for usage example and options documentation. | ||
|
|
||
| ## [Checkbox](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/checkbox) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { checkbox } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/checkbox) for usage example and options documentation. | ||
|
|
||
| ## [Confirm](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/confirm) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { confirm } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/confirm) for usage example and options documentation. | ||
|
|
||
| ## [Input](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/input) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { input } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/input) for usage example and options documentation. | ||
|
|
||
| ## [Password](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/password) | ||
|
|
||
|  | ||
|
|
||
| ```js | ||
| import { password } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/password) for usage example and options documentation. | ||
|
|
||
| ## [Editor](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/editor) | ||
|
|
||
| Launches an instance of the users preferred editor on a temporary file. Once the user exits their editor, the content of the temporary file is read as the answer. The editor used is determined by reading the $VISUAL or $EDITOR environment variables. If neither of those are present, the OS default is used (notepad on Windows, vim on Mac or Linux.) | ||
|
|
||
| ```js | ||
| import { editor } from '@inquirer/prompts'; | ||
| ``` | ||
|
|
||
| [See documentation](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/editor) for usage example and options documentation. | ||
|
|
||
| # Create your own prompts | ||
|
|
||
| The [API documentation is over here](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/core), and our [testing utilities here](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/testing). | ||
|
|
||
| # Advanced usage | ||
|
|
||
| All inquirer prompts are a function taking 2 arguments. The first argument is the prompt configuration. The second is providing contextual or runtime configuration. | ||
|
|
||
| The context options are: | ||
|
|
||
| | Property | Type | Required | Description | | ||
| | ----------------- | ----------------------- | -------- | ------------------------------------------------------------ | | ||
| | input | `NodeJS.ReadableStream` | no | The stdin stream (defaults to `process.stdin`) | | ||
| | output | `NodeJS.WritableStream` | no | The stdout stream (defaults to `process.stdout`) | | ||
| | clearPromptOnDone | `boolean` | no | If true, we'll clear the screen after the prompt is answered | | ||
|
|
||
| Example: | ||
|
|
||
| ```js | ||
| import { confirm } from '@inquirer/prompts'; | ||
|
|
||
| const allowEmail = await confirm( | ||
| { message: 'Do you allow us to send you email?' }, | ||
| { | ||
| output: new Stream.Writable({ | ||
| write(chunk, _encoding, next) { | ||
| // Do something | ||
| next(); | ||
| }, | ||
| }), | ||
| clearPromptOnDone: true, | ||
| } | ||
| ); | ||
| ``` | ||
|
|
||
| # Recipes | ||
|
|
||
| ## Get answers in an object | ||
|
|
||
| When asking many questions, you might not want to keep one variable per answer everywhere. In which case, you can put the answer inside an object. | ||
|
|
||
| ```js | ||
| import { input, confirm } from '@inquirer/prompts'; | ||
|
|
||
| const answers = { | ||
| firstName: await input({ message: 'What\'s your first name?' }), | ||
| allowEmail: await confirm({ message: 'Do you allow us to send you email?' }), | ||
| }; | ||
|
|
||
| console.log(answers.firstName); | ||
| ``` | ||
|
|
||
| ## Ask a question conditionally | ||
|
|
||
| Maybe some questions depend on some other question's answer. | ||
|
|
||
| ```js | ||
| import { input, confirm } from '@inquirer/prompts'; | ||
|
|
||
| const allowEmail = await confirm({ message: 'Do you allow us to send you email?' }); | ||
|
|
||
| let email; | ||
| if (allowEmail) { | ||
| email = await input({ message: 'What is your email address' }); | ||
| } | ||
| ``` | ||
|
|
||
| # 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! | ||
|
|
||
| # License | ||
|
|
||
| Copyright (c) 2023 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart)) | ||
| Licensed under the MIT license. |