Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 1.2 KB

.verb.md

File metadata and controls

64 lines (52 loc) · 1.2 KB

{{#block "demo"}} ![{%= alias %} prompt example](https://raw.githubusercontent.com/{%= repo %}/master/example.gif) {{/block}}

Install

{%= include("install-npm", {save: true}) %}

Usage

var Editor = require('{%= name %}');
var editor = new Editor({
  type: 'editor',
  name: 'background',
  message: 'Please tell us about yourself in 3 lines or more.',
  validate: function (text) {
    if (text.split('\n').length < 3) {
      return 'Must be at least 3 lines.';
    }
    return true;
  }
});

editor.run()
  .then(function(answers) {
    console.log(answers)
  });

Enquirer usage

var Enquirer = require('enquirer');
var enquirer = new Enquirer();

enquirer.register('editor', require('{%= name %}'));
var questions = [
  {
    type: 'editor',
    name: 'bio',
    message: 'Please write a short bio of at least 3 lines.',
    validate: function (text) {
      if (text.split('\n').length < 3) {
        return 'Must be at least 3 lines.';
      }
      return true;
    }
  }
];

enquirer.ask(questions)
  .then(function(answers) {
    console.log(answers)
  });

Prompts

Related prompt modules: {%= related(verb.related.prompts) %}

Attribution

Based on the editor prompt in inquirer.