-
-# Inquirer.js
-
-[](http://badge.fury.io/js/inquirer)
-[](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.
-
-## Table of Contents
-
-1. [Documentation](#documentation)
- 1. [Installation](#installation)
- 2. [Examples](#examples)
- 3. [Methods](#methods)
- 4. [Objects](#objects)
- 5. [Questions](#questions)
- 6. [Answers](#answers)
- 7. [Separator](#separator)
- 8. [Prompt Types](#prompt)
-2. [User Interfaces and Layouts](#layouts)
- 1. [Reactive Interface](#reactive)
-3. [Support](#support)
-4. [Known issues](#issues)
-5. [News](#news)
-6. [Contributing](#contributing)
-7. [License](#license)
-8. [Plugins](#plugins)
-
-## Goal and Philosophy
-
-**`Inquirer.js`** strives to be an easily embeddable and beautiful command line interface for [Node.js](https://nodejs.org/) (and perhaps the "CLI [Xanadu](https://en.wikipedia.org/wiki/Citizen_Kane)").
-
-**`Inquirer.js`** should ease the process of
-
-- providing _error feedback_
-- _asking questions_
-- _parsing_ input
-- _validating_ answers
-- managing _hierarchical prompts_
-
-> **Note:** **`Inquirer.js`** provides the user interface and the inquiry session flow. If you're searching for a full blown command line program utility, then check out [commander](https://github.com/visionmedia/commander.js), [vorpal](https://github.com/dthree/vorpal) or [args](https://github.com/leo/args).
-
-## [Documentation](#documentation)
-
-
-
-### Installation
-
-
-
-```shell
-npm install inquirer
-```
-
-```javascript
-var inquirer = require('inquirer');
-inquirer
- .prompt([
- /* Pass your questions in here */
- ])
- .then((answers) => {
- // Use user feedback for... whatever!!
- })
- .catch((error) => {
- if (error.isTtyError) {
- // Prompt couldn't be rendered in the current environment
- } else {
- // Something else went wrong
- }
- });
-```
-
-
-
-### Examples (Run it and see it)
-
-Check out the [`packages/inquirer/examples/`](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/inquirer/examples) folder for code and interface examples.
-
-```shell
-node packages/inquirer/examples/pizza.js
-node packages/inquirer/examples/checkbox.js
-# etc...
-```
-
-### Methods
-
-
-
-#### `inquirer.prompt(questions, answers) -> promise`
-
-Launch the prompt interface (inquiry session)
-
-- **questions** (Array) containing [Question Object](#question) (using the [reactive interface](#reactive-interface), you can also pass a `Rx.Observable` instance)
-- **answers** (object) contains values of already answered questions. Inquirer will avoid asking answers already provided here. Defaults `{}`.
-- returns a **Promise**
-
-#### `inquirer.registerPrompt(name, prompt)`
-
-Register prompt plugins under `name`.
-
-- **name** (string) name of the this new prompt. (used for question `type`)
-- **prompt** (object) the prompt object itself (the plugin)
-
-#### `inquirer.createPromptModule() -> prompt function`
-
-Create a self contained inquirer module. If you don't want to affect other libraries that also rely on inquirer when you overwrite or add new prompt types.
-
-```js
-var prompt = inquirer.createPromptModule();
-
-prompt(questions).then(/* ... */);
-```
-
-### Objects
-
-
-
-#### Question
-
-
-A question object is a `hash` containing question related values:
-
-- **type**: (String) Type of the prompt. Defaults: `input` - Possible values: `input`, `number`, `confirm`,
- `list`, `rawlist`, `expand`, `checkbox`, `password`, `editor`
-- **name**: (String) The name to use when storing the answer in the answers hash. If the name contains periods, it will define a path in the answers hash.
-- **message**: (String|Function) The question to print. If defined as a function, the first parameter will be the current inquirer session answers. Defaults to the value of `name` (followed by a colon).
-- **default**: (String|Number|Boolean|Array|Function) Default value(s) to use if nothing is entered, or a function that returns the default value(s). If defined as a function, the first parameter will be the current inquirer session answers.
-- **choices**: (Array|Function) Choices array or a function returning a choices array. If defined as a function, the first parameter will be the current inquirer session answers.
- Array values can be simple `numbers`, `strings`, or `objects` containing a `name` (to display in list), a `value` (to save in the answers hash), and a `short` (to display after selection) properties. The choices array can also contain [a `Separator`](#separator).
-- **validate**: (Function) Receive the user input and answers hash. Should return `true` if the value is valid, and an error message (`String`) otherwise. If `false` is returned, a default error message is provided.
-- **filter**: (Function) Receive the user input and answers hash. Returns the filtered value to be used inside the program. The value returned will be added to the _Answers_ hash.
-- **transformer**: (Function) Receive the user input, answers hash and option flags, and return a transformed value to display to the user. The transformation only impacts what is shown while editing. It does not modify the answers hash.
-- **when**: (Function, Boolean) Receive the current user answers hash and should return `true` or `false` depending on whether or not this question should be asked. The value can also be a simple boolean.
-- **pageSize**: (Number) Change the number of lines that will be rendered when using `list`, `rawList`, `expand` or `checkbox`.
-- **prefix**: (String) Change the default _prefix_ message.
-- **suffix**: (String) Change the default _suffix_ message.
-- **askAnswered**: (Boolean) Force to prompt the question if the answer already exists.
-- **loop**: (Boolean) Enable list looping. Defaults: `true`
-
-`default`, `choices`(if defined as functions), `validate`, `filter` and `when` functions can be called asynchronously. Either return a promise or use `this.async()` to get a callback you'll call with the final value.
-
-```javascript
-{
- /* Preferred way: with promise */
- filter() {
- return new Promise(/* etc... */);
- },
-
- /* Legacy way: with this.async */
- validate: function (input) {
- // Declare function as asynchronous, and save the done callback
- var done = this.async();
-
- // Do async stuff
- setTimeout(function() {
- if (typeof input !== 'number') {
- // Pass the return value in the done callback
- done('You need to provide a number');
- return;
- }
- // Pass the return value in the done callback
- done(null, true);
- }, 3000);
- }
-}
-```
-
-### Answers
-
-
-A key/value hash containing the client answers in each prompt.
-
-- **Key** The `name` property of the _question_ object
-- **Value** (Depends on the prompt)
- - `confirm`: (Boolean)
- - `input` : User input (filtered if `filter` is defined) (String)
- - `number`: User input (filtered if `filter` is defined) (Number)
- - `rawlist`, `list` : Selected choice value (or name if no value specified) (String)
-
-### Separator
-
-
-A separator can be added to any `choices` array:
-
-```
-// In the question object
-choices: [ "Choice A", new inquirer.Separator(), "choice B" ]
-
-// Which'll be displayed this way
-[?] What do you want to do?
- > Order a pizza
- Make a reservation
- --------
- Ask opening hours
- Talk to the receptionist
-```
-
-The constructor takes a facultative `String` value that'll be use as the separator. If omitted, the separator will be `--------`.
-
-Separator instances have a property `type` equal to `separator`. This should allow tools façading Inquirer interface from detecting separator types in lists.
-
-
-
-### Prompt types
-
----
-
-> **Note:**: _allowed options written inside square brackets (`[]`) are optional. Others are required._
-
-#### List - `{type: 'list'}`
-
-Take `type`, `name`, `message`, `choices`[, `default`, `filter`, `loop`] properties.
-(Note: `default` must be set to the `index` or `value` of one of the entries in `choices`)
-
-
-
----
-
-#### Raw List - `{type: 'rawlist'}`
-
-Take `type`, `name`, `message`, `choices`[, `default`, `filter`, `loop`] properties.
-(Note: `default` must be set to the `index` of one of the entries in `choices`)
-
-
-
----
-
-#### Expand - `{type: 'expand'}`
-
-Take `type`, `name`, `message`, `choices`[, `default`] properties.
-Note: `default` must be the `index` of the desired default selection of the array. If `default` key not provided, then `help` will be used as default choice
-
-Note that the `choices` object will take an extra parameter called `key` for the `expand` prompt. This parameter must be a single (lowercased) character. The `h` option is added by the prompt and shouldn't be defined by the user.
-
-See `examples/expand.js` for a running example.
-
-
-
-
----
-
-#### Checkbox - `{type: 'checkbox'}`
-
-Take `type`, `name`, `message`, `choices`[, `filter`, `validate`, `default`, `loop`] properties. `default` is expected to be an Array of the checked choices value.
-
-Choices marked as `{checked: true}` will be checked by default.
-
-Choices whose property `disabled` is truthy will be unselectable. If `disabled` is a string, then the string will be outputted next to the disabled choice, otherwise it'll default to `"Disabled"`. The `disabled` property can also be a synchronous function receiving the current answers as argument and returning a boolean or a string.
-
-
-
----
-
-#### Confirm - `{type: 'confirm'}`
-
-Take `type`, `name`, `message`, [`default`] properties. `default` is expected to be a boolean if used.
-
-
-
----
-
-#### Input - `{type: 'input'}`
-
-Take `type`, `name`, `message`[, `default`, `filter`, `validate`, `transformer`] properties.
-
-
-
----
-
-#### Input - `{type: 'number'}`
-
-Take `type`, `name`, `message`[, `default`, `filter`, `validate`, `transformer`] properties.
-
----
-
-#### Password - `{type: 'password'}`
-
-Take `type`, `name`, `message`, `mask`,[, `default`, `filter`, `validate`] properties.
-
-
-
----
-
-Note that `mask` is required to hide the actual user input.
-
-#### Editor - `{type: 'editor'}`
-
-Take `type`, `name`, `message`[, `default`, `filter`, `validate`, `postfix`] properties
-
-Launches an instance of the users preferred editor on a temporary file. Once the user exits their editor, the contents of the temporary file are read in as the result. The editor to use is determined by reading the $VISUAL or $EDITOR environment variables. If neither of those are present, notepad (on Windows) or vim (Linux or Mac) is used.
-
-The `postfix` property is useful if you want to provide an extension.
-
-
-
-### Use in Non-Interactive Environments
-
-`prompt()` requires that it is run in an interactive environment. (I.e. [One where `process.stdin.isTTY` is `true`](https://nodejs.org/docs/latest-v12.x/api/process.html#process_a_note_on_process_i_o)). If `prompt()` is invoked outside of such an environment, then `prompt()` will return a rejected promise with an error. For convenience, the error will have a `isTtyError` property to programmatically indicate the cause.
-
-## User Interfaces and layouts
-
-Along with the prompts, Inquirer offers some basic text UI.
-
-#### Bottom Bar - `inquirer.ui.BottomBar`
-
-This UI present a fixed text at the bottom of a free text zone. This is useful to keep a message to the bottom of the screen while outputting command outputs on the higher section.
-
-```javascript
-var ui = new inquirer.ui.BottomBar();
-
-// pipe a Stream to the log zone
-outputStream.pipe(ui.log);
-
-// Or simply write output
-ui.log.write('something just happened.');
-ui.log.write('Almost over, standby!');
-
-// During processing, update the bottom bar content to display a loader
-// or output a progress bar, etc
-ui.updateBottomBar('new bottom bar content');
-```
-
-
-
-## Reactive interface
-
-Internally, Inquirer uses the [JS reactive extension](https://github.com/ReactiveX/rxjs) to handle events and async flows.
-
-This mean you can take advantage of this feature to provide more advanced flows. For example, you can dynamically add questions to be asked:
-
-```js
-var prompts = new Rx.Subject();
-inquirer.prompt(prompts);
-
-// At some point in the future, push new questions
-prompts.next({
- /* question... */
-});
-prompts.next({
- /* question... */
-});
-
-// When you're done
-prompts.complete();
-```
-
-And using the return value `process` property, you can access more fine grained callbacks:
-
-```js
-inquirer.prompt(prompts).ui.process.subscribe(onEachAnswer, onError, onComplete);
-```
-
-## Support (OS Terminals)
-
-
-
-You should expect mostly good support for the CLI below. This does not mean we won't
-look at issues found on other command line - feel free to report any!
-
-- **Mac OS**:
- - Terminal.app
- - iTerm
-- **Windows ([Known issues](#issues))**:
- - [ConEmu](https://conemu.github.io/)
- - cmd.exe
- - Powershell
- - Cygwin
-- **Linux (Ubuntu, openSUSE, Arch Linux, etc)**:
- - gnome-terminal (Terminal GNOME)
- - konsole
-
-## Known issues
-
-
-
-Running Inquirer together with network streams in Windows platform inside some terminals can result in process hang.
-Workaround: run inside another terminal.
-Please refer to the https://github.com/nodejs/node/issues/21771
-
-Calling a node script that uses Inquirer from grunt-exec can cause the program to crash. To fix this, add to your grunt-exec config `stdio: 'inherit'`.
-Please refer to https://github.com/jharding/grunt-exec/issues/85
-
-## News on the march (Release notes)
-
-
-
-Please refer to the [GitHub releases section for the changelog](https://github.com/SBoudrias/Inquirer.js/releases)
-
-## Contributing
-
-
-
-**Unit test**
-Unit test are written in [Mocha](https://mochajs.org/). Please add a unit test for every new feature or bug fix. `npm test` to run the test suite.
-
-**Documentation**
-Add documentation for every API change. Feel free to send typo fixes and better docs!
-
-We're looking to offer good support for multiple prompts and environments. If you want to
-help, we'd like to keep a list of testers for each terminal/OS so we can contact you and
-get feedback before release. Let us know if you want to be added to the list (just tweet
-to [@vaxilart](https://twitter.com/Vaxilart)) or just add your name to [the wiki](https://github.com/SBoudrias/Inquirer.js/wiki/Testers)
-
-## License
-
-
-
-Copyright (c) 2022 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))
-Licensed under the MIT license.
-
-## Plugins
-
-
-
-### Prompts
-
-[**autocomplete**](https://github.com/mokkabonna/inquirer-autocomplete-prompt)-Presents a list of options as the user types, compatible with other packages such as fuzzy (for search)
-
- - -[**checkbox-plus**](https://github.com/faressoft/inquirer-checkbox-plus-prompt)
-Checkbox list with autocomplete and other additions
-
- - -[**inquirer-date-prompt**](https://github.com/haversnail/inquirer-date-prompt)
-Customizable date/time selector with localization support
-
- - -[**datetime**](https://github.com/DerekTBrown/inquirer-datepicker-prompt)
-Customizable date/time selector using both number pad and arrow keys
-
- - -[**inquirer-select-line**](https://github.com/adam-golab/inquirer-select-line)
-Prompt for selecting index in array where add new element
-
- - -[**command**](https://github.com/sullof/inquirer-command-prompt)
-Simple prompt with command history and dynamic autocomplete
- -[**inquirer-fuzzy-path**](https://github.com/adelsz/inquirer-fuzzy-path)
-Prompt for fuzzy file/directory selection.
-
- - -[**inquirer-emoji**](https://github.com/tannerntannern/inquirer-emoji)
-Prompt for inputting emojis.
-
- - -[**inquirer-chalk-pipe**](https://github.com/LitoMore/inquirer-chalk-pipe)
-Prompt for input chalk-pipe style strings
-
- - -[**inquirer-search-checkbox**](https://github.com/clinyong/inquirer-search-checkbox)
-Searchable Inquirer checkbox
- -[**inquirer-search-list**](https://github.com/robin-rpr/inquirer-search-list)
-Searchable Inquirer list
-
- - -[**inquirer-prompt-suggest**](https://github.com/olistic/inquirer-prompt-suggest)
-Inquirer prompt for your less creative users.
-
- - -[**inquirer-s3**](https://github.com/HQarroum/inquirer-s3)
-An S3 object selector for Inquirer.
-
- - -[**inquirer-autosubmit-prompt**](https://github.com/yaodingyd/inquirer-autosubmit-prompt)
-Auto submit based on your current input, saving one extra enter
- -[**inquirer-file-tree-selection-prompt**](https://github.com/anc95/inquirer-file-tree-selection)
-Inquirer prompt for to select a file or directory in file tree
-
- - -[**inquirer-tree-prompt**](https://github.com/insightfuls/inquirer-tree-prompt)
-Inquirer prompt to select from a tree
-
- - -[**inquirer-table-prompt**](https://github.com/eduardoboucas/inquirer-table-prompt)
-A table-like prompt for Inquirer.
-
- - -[**inquirer-interrupted-prompt**](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.
-
- - -[**inquirer-press-to-continue**](https://github.com/leonzalion/inquirer-press-to-continue)
-A "press any key to continue" prompt for Inquirer.js
-
- - diff --git a/packages/cli/node_modules/inquirer/lib/inquirer.js b/packages/cli/node_modules/inquirer/lib/inquirer.js deleted file mode 100644 index 0f91e4be..00000000 --- a/packages/cli/node_modules/inquirer/lib/inquirer.js +++ /dev/null @@ -1,93 +0,0 @@ -'use strict'; -/** - * Inquirer.js - * A collection of common interactive command line user interfaces. - */ - -const inquirer = module.exports; - -/** - * Client interfaces - */ - -inquirer.prompts = {}; - -inquirer.Separator = require('./objects/separator'); - -inquirer.ui = { - BottomBar: require('./ui/bottom-bar'), - Prompt: require('./ui/prompt'), -}; - -/** - * Create a new self-contained prompt module. - */ -inquirer.createPromptModule = function (opt) { - const promptModule = function (questions, answers) { - let ui; - try { - ui = new inquirer.ui.Prompt(promptModule.prompts, opt); - } catch (error) { - return Promise.reject(error); - } - const promise = ui.run(questions, answers); - - // Monkey patch the UI on the promise object so - // that it remains publicly accessible. - promise.ui = ui; - - return promise; - }; - - promptModule.prompts = {}; - - /** - * Register a prompt type - * @param {String} name Prompt type name - * @param {Function} prompt Prompt constructor - * @return {inquirer} - */ - - promptModule.registerPrompt = function (name, prompt) { - promptModule.prompts[name] = prompt; - return this; - }; - - /** - * Register the defaults provider prompts - */ - - promptModule.restoreDefaultPrompts = function () { - this.registerPrompt('list', require('./prompts/list')); - this.registerPrompt('input', require('./prompts/input')); - this.registerPrompt('number', require('./prompts/number')); - this.registerPrompt('confirm', require('./prompts/confirm')); - this.registerPrompt('rawlist', require('./prompts/rawlist')); - this.registerPrompt('expand', require('./prompts/expand')); - this.registerPrompt('checkbox', require('./prompts/checkbox')); - this.registerPrompt('password', require('./prompts/password')); - this.registerPrompt('editor', require('./prompts/editor')); - }; - - promptModule.restoreDefaultPrompts(); - - return promptModule; -}; - -/** - * Public CLI helper interface - * @param {Array|Object|Rx.Observable} questions - Questions settings array - * @param {Function} cb - Callback being passed the user answers - * @return {inquirer.ui.Prompt} - */ - -inquirer.prompt = inquirer.createPromptModule(); - -// Expose helper functions on the top level for easiest usage by common users -inquirer.registerPrompt = function (name, prompt) { - inquirer.prompt.registerPrompt(name, prompt); -}; - -inquirer.restoreDefaultPrompts = function () { - inquirer.prompt.restoreDefaultPrompts(); -}; diff --git a/packages/cli/node_modules/inquirer/lib/objects/choice.js b/packages/cli/node_modules/inquirer/lib/objects/choice.js deleted file mode 100644 index 46c2364b..00000000 --- a/packages/cli/node_modules/inquirer/lib/objects/choice.js +++ /dev/null @@ -1,37 +0,0 @@ -'use strict'; - -/** - * Choice object - * Normalize input as choice object - * @constructor - * @param {Number|String|Object} val Choice value. If an object is passed, it should contains - * at least one of `value` or `name` property - */ - -module.exports = class Choice { - constructor(val, answers) { - // Don't process Choice and Separator object - if (val instanceof Choice || val.type === 'separator') { - // eslint-disable-next-line no-constructor-return - return val; - } - - if (typeof val === 'string' || typeof val === 'number') { - this.name = String(val); - this.value = val; - this.short = String(val); - } else { - Object.assign(this, val, { - name: val.name || val.value, - value: 'value' in val ? val.value : val.name, - short: val.short || val.name || val.value, - }); - } - - if (typeof val.disabled === 'function') { - this.disabled = val.disabled(answers); - } else { - this.disabled = val.disabled; - } - } -}; diff --git a/packages/cli/node_modules/inquirer/lib/objects/choices.js b/packages/cli/node_modules/inquirer/lib/objects/choices.js deleted file mode 100644 index 9e89b200..00000000 --- a/packages/cli/node_modules/inquirer/lib/objects/choices.js +++ /dev/null @@ -1,123 +0,0 @@ -'use strict'; -const assert = require('assert'); -const _ = { - filter: require('lodash/filter'), - map: require('lodash/map'), -}; -const Separator = require('./separator'); -const Choice = require('./choice'); - -/** - * Choices collection - * Collection of multiple `choice` object - */ -module.exports = class Choices { - /** @param {Array} choices All `choice` to keep in the collection */ - constructor(choices, answers) { - this.choices = choices.map((val) => { - if (val.type === 'separator') { - if (!(val instanceof Separator)) { - val = new Separator(val.line); - } - - return val; - } - - return new Choice(val, answers); - }); - - this.realChoices = this.choices - .filter(Separator.exclude) - .filter((item) => !item.disabled); - - Object.defineProperty(this, 'length', { - get() { - return this.choices.length; - }, - set(val) { - this.choices.length = val; - }, - }); - - Object.defineProperty(this, 'realLength', { - get() { - return this.realChoices.length; - }, - set() { - throw new Error('Cannot set `realLength` of a Choices collection'); - }, - }); - } - - /** - * Get a valid choice from the collection - * @param {Number} selector The selected choice index - * @return {Choice|Undefined} Return the matched choice or undefined - */ - - getChoice(selector) { - assert(typeof selector === 'number'); - return this.realChoices[selector]; - } - - /** - * Get a raw element from the collection - * @param {Number} selector The selected index value - * @return {Choice|Undefined} Return the matched choice or undefined - */ - - get(selector) { - assert(typeof selector === 'number'); - return this.choices[selector]; - } - - /** - * Match the valid choices against a where clause - * @param {Object} whereClause Lodash `where` clause - * @return {Array} Matching choices or empty array - */ - - where(whereClause) { - return _.filter(this.realChoices, whereClause); - } - - /** - * Pluck a particular key from the choices - * @param {String} propertyName Property name to select - * @return {Array} Selected properties - */ - - pluck(propertyName) { - return _.map(this.realChoices, propertyName); - } - - // Expose usual Array methods - indexOf(...args) { - return this.choices.indexOf(...args); - } - - forEach(...args) { - return this.choices.forEach(...args); - } - - filter(...args) { - return this.choices.filter(...args); - } - - reduce(...args) { - return this.choices.reduce(...args); - } - - find(func) { - return this.choices.find(func); - } - - push(...args) { - const objs = args.map((val) => new Choice(val)); - this.choices.push(...objs); - this.realChoices = this.choices - .filter(Separator.exclude) - .filter((item) => !item.disabled); - return this.choices; - } -}; diff --git a/packages/cli/node_modules/inquirer/lib/objects/separator.js b/packages/cli/node_modules/inquirer/lib/objects/separator.js deleted file mode 100644 index c7708628..00000000 --- a/packages/cli/node_modules/inquirer/lib/objects/separator.js +++ /dev/null @@ -1,37 +0,0 @@ -'use strict'; -const chalk = require('chalk'); -const figures = require('figures'); - -/** - * Separator object - * Used to space/separate choices group - * @constructor - * @param {String} line Separation line content (facultative) - */ - -class Separator { - constructor(line) { - this.type = 'separator'; - this.line = chalk.dim(line || new Array(15).join(figures.line)); - } - - /** - * Stringify separator - * @return {String} the separator display string - */ - toString() { - return this.line; - } -} - -/** - * Helper function returning false if object is a separator - * @param {Object} obj object to test against - * @return {Boolean} `false` if object is a separator - */ - -Separator.exclude = function (obj) { - return obj.type !== 'separator'; -}; - -module.exports = Separator; diff --git a/packages/cli/node_modules/inquirer/lib/prompts/base.js b/packages/cli/node_modules/inquirer/lib/prompts/base.js deleted file mode 100644 index 81dfb77e..00000000 --- a/packages/cli/node_modules/inquirer/lib/prompts/base.js +++ /dev/null @@ -1,180 +0,0 @@ -'use strict'; -/** - * Base prompt implementation - * Should be extended by prompt types. - */ -const _ = { - defaults: require('lodash/defaults'), - clone: require('lodash/clone'), -}; -const chalk = require('chalk'); -const runAsync = require('run-async'); -const { filter, flatMap, share, take, takeUntil } = require('rxjs/operators'); -const Choices = require('../objects/choices'); -const ScreenManager = require('../utils/screen-manager'); - -class Prompt { - constructor(question, rl, answers) { - // Setup instance defaults property - Object.assign(this, { - answers, - status: 'pending', - }); - - // Set defaults prompt options - this.opt = _.defaults(_.clone(question), { - validate: () => true, - validatingText: '', - filter: (val) => val, - filteringText: '', - when: () => true, - suffix: '', - prefix: chalk.green('?'), - }); - - // Make sure name is present - if (!this.opt.name) { - this.throwParamError('name'); - } - - // Set default message if no message defined - if (!this.opt.message) { - this.opt.message = this.opt.name + ':'; - } - - // Normalize choices - if (Array.isArray(this.opt.choices)) { - this.opt.choices = new Choices(this.opt.choices, answers); - } - - this.rl = rl; - this.screen = new ScreenManager(this.rl); - } - - /** - * Start the Inquiry session and manage output value filtering - * @return {Promise} - */ - - run() { - return new Promise((resolve, reject) => { - this._run( - (value) => resolve(value), - (error) => reject(error) - ); - }); - } - - // Default noop (this one should be overwritten in prompts) - _run(cb) { - cb(); - } - - /** - * Throw an error telling a required parameter is missing - * @param {String} name Name of the missing param - * @return {Throw Error} - */ - - throwParamError(name) { - throw new Error('You must provide a `' + name + '` parameter'); - } - - /** - * Called when the UI closes. Override to do any specific cleanup necessary - */ - close() { - this.screen.releaseCursor(); - } - - /** - * Run the provided validation method each time a submit event occur. - * @param {Rx.Observable} submit - submit event flow - * @return {Object} Object containing two observables: `success` and `error` - */ - handleSubmitEvents(submit) { - const self = this; - const validate = runAsync(this.opt.validate); - const asyncFilter = runAsync(this.opt.filter); - const validation = submit.pipe( - flatMap((value) => { - this.startSpinner(value, this.opt.filteringText); - return asyncFilter(value, self.answers).then( - (filteredValue) => { - this.startSpinner(filteredValue, this.opt.validatingText); - return validate(filteredValue, self.answers).then( - (isValid) => ({ isValid, value: filteredValue }), - (err) => ({ isValid: err, value: filteredValue }) - ); - }, - (err) => ({ isValid: err }) - ); - }), - share() - ); - - const success = validation.pipe( - filter((state) => state.isValid === true), - take(1) - ); - const error = validation.pipe( - filter((state) => state.isValid !== true), - takeUntil(success) - ); - - return { - success, - error, - }; - } - - startSpinner(value, bottomContent) { - value = this.getSpinningValue(value); - // If the question will spin, cut off the prefix (for layout purposes) - const content = bottomContent - ? this.getQuestion() + value - : this.getQuestion().slice(this.opt.prefix.length + 1) + value; - - this.screen.renderWithSpinner(content, bottomContent); - } - - /** - * Allow override, e.g. for password prompts - * See: https://github.com/SBoudrias/Inquirer.js/issues/1022 - * - * @return {String} value to display while spinning - */ - getSpinningValue(value) { - return value; - } - - /** - * Generate the prompt question string - * @return {String} prompt question string - */ - getQuestion() { - let message = - (this.opt.prefix ? this.opt.prefix + ' ' : '') + - chalk.bold(this.opt.message) + - this.opt.suffix + - chalk.reset(' '); - - // Append the default if available, and if question isn't touched/answered - if ( - this.opt.default != null && - this.status !== 'touched' && - this.status !== 'answered' - ) { - // If default password is supplied, hide it - if (this.opt.type === 'password') { - message += chalk.italic.dim('[hidden] '); - } else { - message += chalk.dim('(' + this.opt.default + ') '); - } - } - - return message; - } -} - -module.exports = Prompt; diff --git a/packages/cli/node_modules/inquirer/lib/prompts/checkbox.js b/packages/cli/node_modules/inquirer/lib/prompts/checkbox.js deleted file mode 100644 index 64992cc0..00000000 --- a/packages/cli/node_modules/inquirer/lib/prompts/checkbox.js +++ /dev/null @@ -1,275 +0,0 @@ -'use strict'; -/** - * `list` type prompt - */ - -const chalk = require('chalk'); -const cliCursor = require('cli-cursor'); -const figures = require('figures'); -const { map, takeUntil } = require('rxjs/operators'); -const Base = require('./base'); -const observe = require('../utils/events'); -const Paginator = require('../utils/paginator'); -const incrementListIndex = require('../utils/incrementListIndex'); - -class CheckboxPrompt extends Base { - constructor(questions, rl, answers) { - super(questions, rl, answers); - - if (!this.opt.choices) { - this.throwParamError('choices'); - } - - if (Array.isArray(this.opt.default)) { - this.opt.choices.forEach(function (choice) { - if (this.opt.default.indexOf(choice.value) >= 0) { - choice.checked = true; - } - }, this); - } - - this.pointer = 0; - - // Make sure no default is set (so it won't be printed) - this.opt.default = null; - - const shouldLoop = this.opt.loop === undefined ? true : this.opt.loop; - this.paginator = new Paginator(this.screen, { isInfinite: shouldLoop }); - } - - /** - * Start the Inquiry session - * @param {Function} cb Callback when prompt is done - * @return {this} - */ - - _run(cb) { - this.done = cb; - - const events = observe(this.rl); - - const validation = this.handleSubmitEvents( - events.line.pipe(map(this.getCurrentValue.bind(this))) - ); - validation.success.forEach(this.onEnd.bind(this)); - validation.error.forEach(this.onError.bind(this)); - - events.normalizedUpKey - .pipe(takeUntil(validation.success)) - .forEach(this.onUpKey.bind(this)); - events.normalizedDownKey - .pipe(takeUntil(validation.success)) - .forEach(this.onDownKey.bind(this)); - events.numberKey - .pipe(takeUntil(validation.success)) - .forEach(this.onNumberKey.bind(this)); - events.spaceKey - .pipe(takeUntil(validation.success)) - .forEach(this.onSpaceKey.bind(this)); - events.aKey.pipe(takeUntil(validation.success)).forEach(this.onAllKey.bind(this)); - events.iKey.pipe(takeUntil(validation.success)).forEach(this.onInverseKey.bind(this)); - - // Init the prompt - cliCursor.hide(); - this.render(); - this.firstRender = false; - - return this; - } - - /** - * Render the prompt to screen - * @return {CheckboxPrompt} self - */ - - render(error) { - // Render question - let message = this.getQuestion(); - let bottomContent = ''; - - if (!this.dontShowHints) { - message += - '(Press ' + - chalk.cyan.bold('
-
-
- 
-
-
-
-
-
-> Terminal string styling done right
-
-[](https://travis-ci.org/chalk/chalk) [](https://coveralls.io/github/chalk/chalk?branch=master) [](https://www.npmjs.com/package/chalk?activeTab=dependents) [](https://www.npmjs.com/package/chalk) [](https://www.youtube.com/watch?v=9auOCbH5Ns4) [](https://github.com/xojs/xo)  [](https://repl.it/github/chalk/chalk)
-
-
-
-- ---- - -
-
-
- -
-
-
-
- -
-
-
-
- -
- -
-
----
-
--
- - Sindre Sorhus' open source work is supported by the community on GitHub Sponsors and Dev - -
- Special thanks to: --
- -
-
- -
- -
-
- -
- -
- 
-
- All your environment variables, in one place
-
-
- Stop struggling with scattered API keys, hacking together home-brewed tools,
-
- and avoiding access controls. Keep your team and servers in sync with Doppler. -
-
- - and avoiding access controls. Keep your team and servers in sync with Doppler. -
- -
- 
-
-
-
-
- - -## Highlights - -- Expressive API -- Highly performant -- Ability to nest styles -- [256/Truecolor color support](#256-and-truecolor-color-support) -- Auto-detects color support -- Doesn't extend `String.prototype` -- Clean and focused -- Actively maintained -- [Used by ~50,000 packages](https://www.npmjs.com/browse/depended/chalk) as of January 1, 2020 - -## Install - -```console -$ npm install chalk -``` - -## Usage - -```js -const chalk = require('chalk'); - -console.log(chalk.blue('Hello world!')); -``` - -Chalk comes with an easy to use composable API where you just chain and nest the styles you want. - -```js -const chalk = require('chalk'); -const log = console.log; - -// Combine styled and normal strings -log(chalk.blue('Hello') + ' World' + chalk.red('!')); - -// Compose multiple styles using the chainable API -log(chalk.blue.bgRed.bold('Hello world!')); - -// Pass in multiple arguments -log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz')); - -// Nest styles -log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!')); - -// Nest styles of the same type even (color, underline, background) -log(chalk.green( - 'I am a green line ' + - chalk.blue.underline.bold('with a blue substring') + - ' that becomes green again!' -)); - -// ES2015 template literal -log(` -CPU: ${chalk.red('90%')} -RAM: ${chalk.green('40%')} -DISK: ${chalk.yellow('70%')} -`); - -// ES2015 tagged template literal -log(chalk` -CPU: {red ${cpu.totalPercent}%} -RAM: {green ${ram.used / ram.total * 100}%} -DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%} -`); - -// Use RGB colors in terminal emulators that support it. -log(chalk.keyword('orange')('Yay for orange colored text!')); -log(chalk.rgb(123, 45, 67).underline('Underlined reddish color')); -log(chalk.hex('#DEADED').bold('Bold gray!')); -``` - -Easily define your own themes: - -```js -const chalk = require('chalk'); - -const error = chalk.bold.red; -const warning = chalk.keyword('orange'); - -console.log(error('Error!')); -console.log(warning('Warning!')); -``` - -Take advantage of console.log [string substitution](https://nodejs.org/docs/latest/api/console.html#console_console_log_data_args): - -```js -const name = 'Sindre'; -console.log(chalk.green('Hello %s'), name); -//=> 'Hello Sindre' -``` - -## API - -### chalk.`