prompt-improved

Prompts for beautiful and configurable CLI interfaces

npm install prompt-improved
24 downloads in the last week
49 downloads in the last month

Prompts Improved

Node.js prompts like you always wanted. Style them to your heart's content using Chalk, an amazing CLI package for colors and text styling. Features include:

  • Default options
  • Boolean questions (simple y/n answers get converted to true/false)
  • Input validation (using regex's or functions)
  • Input filters (both before validation and after)
  • Required fields
  • Input attempt limits (think limiting password tries)
  • Ask single or multiple questions
  • When asking multiple questions, subsequent questions can be dependant on previous input. Allows for simple logic in prompt path.
  • Configurable prefixs and suffixes
  • Override defaults at runtime (overrideDefaults: {key: value})
  • Custom error messaging
  • Confirmation prompt for input of multiple questions
  • Input timeouts
  • Per-prompt configuration
  • Convient error handeling
  • (Coming Soon) Multiple choice questions

Examples

Just ask your user a question:

var Prompt = require('prompt-imporved');

var prompt = new Prompt({
    // Some options for all prompts
    prefix: '[?] ',
    prefixTheme: Prompt.chalk.green
});

prompt.ask('Where in the world is Carmen Sandiego?', function(err, res) {
    if (err) return console.error(err); // err is null if no errors
    console.log('Response: ' + res);
});

// Outputs: [?] Where in the world is Carmen Sandiego?:

Options can be provided for all prompts or overridden on a per-prompt basis:

var Prompt = require('prompt-imporved');

var prompt = new Prompt({
    suffix: '? '
});

prompt.ask('How is your day going beautiful', function(err, res) {
    if (err) return console.error(err);
    console.log('Response: ' + res);
});

// Outputs: How is your day going beautiful?

Asking multiple questions:

var Prompt = require('prompt-imporved');
var prompt = new Prompt();
prompt.ask([{
    question: 'Who\'s your daddy?',
    key: 'father',
}, {
    question: 'What is your Mothers name?',
}], function(err, res) {
    if (err) return console.error(err);
    console.log('Father\'s name: ' res.father);
    console.log('Mother\'s name: ' res['What is your Mothers name?']);
});

Full example will all options:

var Prompt = require('prompt-imporved');

// These are all the defaults
var prompt = new Prompt({
    prefix        : '',
    suffix        : ': ',
    defaultPrefix : ' (',
    defaultSuffix : ')',
    textTheme     : Prompt.chalk.bold,
    prefixTheme   : Prompt.chalk.white,
    suffixTheme   : Prompt.chalk.white,
    defaultTheme  : Prompt.chalk.white,
    inputError    : 'Error encountered, try again.',
    requiredError : 'Required! Try again.',
    invalidError  : 'Invalid input: ',
    attemptsError : 'Maximum attempts reached!',
    stdin         : process.stdin,
    stdout        : process.stdout,
    stderr        : process.stderr,
    timeout       : null
});

// Each question can have it's own options
prompt.ask([{
    question: 'A yes or no question',
    key: 'answer-key',
    attempts: 3,
    required: true,
    default: 'Y',
    boolean: true
}{
    question: 'Something where the first letter should be uppercase',
    key: 'answer-key1',
    before: function(val) {
        return val.charAt(0).toUpperCase() + val.slice(1);
    },
    depends: function(answers) {
        return !!answers['answer-key'];
    }
}], function(err, res) {
    if (err) return console.error(err);
    console.log('Response: ' + res);
});

Tests

Unit tests and test coverage are available:

// runs the tests and watches for file changes
$ grunt 

// Runs the coverage generator and opens your borwser to the results
$ grunt coverage

Contributions

Please contribute. Make pull requests against the develop branch.

npm loves you