Nascent Personality Manifestation

    superprompt

    1.3.2 • Public • Published

    Superprompt

    Build Status

    Superprompt is a commandline prompting tool. It supports string, boolean, number and array fields.

    Installation

    npm install superprompt

    Usage

    const questions = [{
      name: 'name',
      type: 'string',
      question: 'Enter an username'
    }, {
      name: 'isHuman',
      type: 'boolean',
      question: 'Are you a human? [yes/no]'
    }, {
      name: 'list',
      type: 'array',
      question: 'Add a few items'
    }]
    
    const superprompt = require('superprompt')
    
    superprompt.prompt(questions).then((answers) => {
      console.log(answers)
    }).catch((err) => {
      console.error(err)
    })
    
    //Result may looks like:
    {
      name: 'Andi',
      isHuman: true,
      list: [
        'banana',
        'pear',
        'mango'
      ]
    }

    Options

    Name Description
    name Set a property name
    type Set a prompt type. Could be 'string', 'boolean', 'number', 'array' or 'input'. Defaults to 'string'.
    default Default value
    only Ask question only if flag is true or value is a function which evaluates to true

    Field types

    string

    Creates a simple prompt. If you hint enter, the prompt gets closed and next question will be asked.

    number

    Same as above, the entered value gets converted into a number.

    boolean

    Creates a boolean prompt. The anwser can be [y]es or [n]o. It gets re-asked if you enter something else then y, yes, n, no.

    array

    Prompt for entering a set of values. Each line is one set. It gets re-asked until a blank line was entered.

    input

    This field opens a multiline prompt. Hit <ctrl>-d to submit the prompt or <ctrl>-c to cancel it.

    Install

    npm i superprompt

    DownloadsWeekly Downloads

    77

    Version

    1.3.2

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    16

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar