Easily create a normalized inquirer choices question. Supports all of the `choices` question types: checkbox, list, rawlist, expand
npm install to-choices> Easily create a normalized inquirer choices question. Supports all of the choices question types: checkbox, list, rawlist, expand
Install with npm:
``sh`
$ npm install to-choices --save
Breaking changes made in v02.0!
The main export now returns a function that takes an options object and, when called, returns the toChoices function to be usef for creating the question object.
`js
var toChoices = require('to-choices')([options]);
var question = toChoices('foo', ['a', 'b', 'c']);
console.log(question);
`
The default type is checkbox, so the above code results in:
`js`
{ type: 'checkbox',
name: 'foo',
message: 'foo',
choices:
[ { name: 'all', value: ['a', 'b', 'c'] },
{ type: 'separator', line: '\u001b[90m————\u001b[39m' },
{ name: 'a' },
{ name: 'b' },
{ name: 'c' } ] }
In addition to checkbox, the following types are also supported:
* expand
*
*
Signature and all params are the same. Just pass the type to the main export.
Example
Create a list question:
`js`
var toQuestions = require('to-choices')({type: 'list'});
var question = toChoices('favorite color?', [
'red',
'blue',
'green'
]);
console.log(question);
Results in:
`js`
{ type: 'list',
choices: [ 'red', 'blue', 'green' ],
name: 'favorite color',
message: 'favorite color' }
See the inquirer2 documentation for more details about question objects and supported properties.
* answer-store: Store answers to user prompts, based on locale and/or current working directory. | homepage
* question-store: Ask questions, persist the answers. Basic support for i18n and storing answers based on current… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
`sh`
$ npm install verb && npm run docs
Or, if verb is installed globally:
`sh`
$ verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2016 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb, v0.9.0, on February 27, 2016._