prompt-rawlist

2.0.1 • Public • Published

prompt-rawlist NPM version NPM monthly downloads NPM total downloads Linux Build Status

Rawlist prompt. Can be used as a standalone prompt, or with a prompt system like Enquirer.

prompt-rawlist example

Install

Install with npm:

$ npm install --save prompt-rawlist

Usage

var RawList = require('prompt-rawlist');
var prompt = new RawList({
  name: 'colors',
  message: 'Favorite flavor?',
  choices: [
    'chocolate',
    'strawberry',
    'vanilla'
  ]
});
 
// async
prompt.ask(function(answer) {
  console.log(answer);
  // chocolate
});
 
// promise
prompt.run()
  .then(function(answer) {
    console.log(answer);
    // chocolate
  });

Enquirer usage

Register as a plugin with enquirer:

var Enquirer = require('enquirer');
var enquirer = new Enquirer();
enquirer.register('rawlist', require('prompt-rawlist'));

Declarative format

Define questions using a declarative style, similar to Inquirer.

var questions = [
  {
    type: 'rawlist',
    name: 'dinner',
    message: 'What would you like to do?',
    choices: [
      'Order a pizza',
      'Make a reservation',
      enquirer.separator(),,
      'Ask opening hours',
      'Talk to the receptionist'
    ]
  },
  {
    type: 'rawlist',
    name: 'size',
    message: 'What size would you like?',
    choices: ['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro']
  }
];
 
enquirer.ask(questions)
  .then(function (answers) {
    console.log(answers);
  });

Expressive format

Register questions using enquirer's .question method:

enquirer.question('dinner', {
  type: 'rawlist',
  message: 'What would you like to do?',
  choices: [
    'Order a pizza',
    'Make a reservation',
    enquirer.separator(),
    'Ask opening hours',
    'Talk to the receptionist'
  ]
});
 
enquirer.question('size', 'What size would you like?', {
  type: 'rawlist',
  choices: ['Jumbo', 'Large', 'Standard', 'Medium', 'Small', 'Micro']
});
 
enquirer.ask(['dinner', 'size'])
  .then(function (answers) {
    console.log(answers);
    //=> { dinner: 'Order a pizza', size: 'Large' }
  });

Attribution

Originally based on the rawlist prompt in inquirer.

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on June 04, 2017.

Package Sidebar

Install

npm i prompt-rawlist

Weekly Downloads

6,123

Version

2.0.1

License

MIT

Last publish

Collaborators

  • doowb
  • jonschlinkert