helper-ask

helper-ask

Async helper that prompts the user for a value and uses the answer as context for rendering the template.

Install

Install with npm:

$ npm install --save helper-ask

Compatibility

This helper can be used with the following applications:

• assemble
• verb
• update
• generate
• templates

Usage

This helper requires the base-questions plugin to be registered first. Uses the ask-when library to conditionally prompt the user. See that project for available options and additional API documentation.

var ask = require('helper-ask');
var questions = require('base-questions');
var templates = require('templates');
var app = templates();

app.use(questions());

// register the helper, make sure to pass `app` to the function
app.asyncHelper('ask', ask(app));

Example

If you're using templates directly, you'll need to create a collection and add a template engine.

app.create('pages');
app.engine('*', require('engine-base'));
app.option('engine', '*');

With the other apps you should be able to do the following:

var page = app.page('foo', {content: '<%= ask("name") %>'});
app.option('askWhen', 'not-answered');
app.data('name', 'Brian');

app.render(page, function(err, view) {
  if (err) return cb(err);
  console.log(view.contents.toString());
  //=> 'Brian'
  cb();
});

API

Params

• app {Object}
• returns {Function}: Returns the helper function

Example

<%= ask('author.name') %>

About

Related projects

• handlebars-helpers: More than 130 Handlebars helpers in ~20 categories. Helpers can be used with Assemble, Generate… more | homepage
• template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or… more | homepage

Contributing

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

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.1.31, on October 01, 2016.