prompt-expand

    1.0.1 • Public • Published

    prompt-expand NPM version NPM monthly downloads NPM total downloads

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

    prompt-expand example

    Install

    Install with npm:

    $ npm install --save prompt-expand

    Usage

    var Prompt = require('prompt-expand');
    var prompt = new Prompt({
      message: 'What action should be taken on file.js?',
      name: 'conflict',
      default: 'x',
      choices: [
        {
          key: 'y',
          name: 'Overwrite',
          value: 'overwrite'
        },
        {
          key: 'a',
          name: 'Overwrite this one and all next',
          value: 'overwrite_all'
        },
        {
          key: 'd',
          name: 'Show diff',
          value: 'diff'
        },
        new Prompt.Separator(),
        {
          key: 'x',
          name: 'Abort',
          value: 'abort'
        }
      ]
    });
     
    // async
    prompt.ask(function(answer) {
      console.log({file: answer});
    });
     
    // promise
    prompt.run()
      .then(function(answer) {
        console.log({file: answer});
      })
      .catch(function(err) {
        console.log(err);
      });

    Enquirer usage

    Register as a plugin with enquirer.

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

    Functional-style questions

    Define questions using the .question method.

    enquirer.question('file', 'Conflict on `file.js`: ', {
      type: 'expand',
      // "default" can be the index of the default choice, 
      // or the `key` or `name` of the default choice
      default: 'x', 
      choices: [
        {
          key: 'y',
          name: 'Overwrite',
          value: 'overwrite'
        },
        {
          key: 'a',
          name: 'Overwrite this one and all next',
          value: 'overwrite_all'
        },
        {
          key: 'd',
          name: 'Show diff',
          value: 'diff'
        },
        enquirer.separator(),
        {
          key: 'x',
          name: 'Abort',
          value: 'abort'
        }
      ]
    });
     
    enquirer.ask(questions)
      .then(function(answers) {
        console.log(answers);
      })
      .catch(function(err) {
        console.log(err);
      });

    Declarative-style questions

    Define questions using a declarative, Inquirer-style format.

    var questions = [
      {
        type: 'expand',
        message: 'Conflict on `file.js`: ',
        default: 'x',
        name: 'file',
        choices: [
          {
            key: 'y',
            name: 'Overwrite',
            value: 'overwrite'
          },
          {
            key: 'a',
            name: 'Overwrite this one and all next',
            value: 'overwrite_all'
          },
          {
            key: 'd',
            name: 'Show diff',
            value: 'diff'
          },
          enquirer.separator(),
          {
            key: 'x',
            name: 'Abort',
            value: 'abort'
          }
        ]
      }
    ];
     
    enquirer.ask(questions)
      .then(function(answers) {
        console.log(answers);
      })
      .catch(function(err) {
        console.log(err);
      });

    Attribution

    Based on the expand 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 May 27, 2017.

    Install

    npm i prompt-expand

    DownloadsWeekly Downloads

    12,173

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    13 kB

    Total Files

    4

    Last publish

    Collaborators

    • jonschlinkert