https://github.com/doowb/question-helper
Ask questions when running templates for Templates, Handlebars, or Lodash.
https://github.com/doowb/question-helper
Last synced: about 1 year ago
JSON representation
Ask questions when running templates for Templates, Handlebars, or Lodash.
- Host: GitHub
- URL: https://github.com/doowb/question-helper
- Owner: doowb
- License: mit
- Created: 2014-11-10T23:57:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-16T03:04:29.000Z (almost 11 years ago)
- Last Synced: 2025-05-08T04:54:02.238Z (about 1 year ago)
- Language: JavaScript
- Size: 141 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# question-helper [](http://badge.fury.io/js/question-helper) [](https://travis-ci.org/doowb/question-helper)
> Helper used to ask questions and output the answer. Useful with Template, Handlebars, and Loadash.
Inspired by conversations with [Jon Schlinkert](https://github.com/jonschlinkert)
## Install with [npm](npmjs.org)
```bash
npm i question-helper --save
```
## Usage
```js
var question = require('question-helper');
var context = {questions: {name: "What's your name?"}};
// Prompt a user for a question and get an answer back.
question.call({ctx: context}, "name", function (err, answer) {
if (err) return console.log('error', err);
console.log('Answer', answer);
});
```
**Params**
* `key` **{String}**: Either a key on a `questions` object on the context or a question to ask.
* `options` **{String}**: Additional options to pass.
* `next` **{Function}**: Callback function that will be passed an error and/or the results of asking the question.
### Template
To use with [template]:
```bash
npm i template --save
```
Then add to your project.
```js
var template = require('template');
```
**handebars**
Register [handlebars as an engine][engine-handlebars]:
```js
template.engine('hbs', require('engine-handlebars'));
var question = require('question-helper');
var context = {questions: {name: "What's your name?"}};
template.page('author.hbs', "Author: {{question 'name'}}");
template.render('author.hbs', context, function (err, content) {
if (err) return console.log('error', err);
console.log(content);
});
```
**Lo-Dash**
Register [Lo-Dash as an engine][engine-lodash]:
```js
template.engine('html', require('engine-lodash'));
var context = {questions: {name: "What's your name?"}};
template.page('author.html', "Author: <%= question('name') %>");
template.render('author.html', context, function (err, content) {
if (err) return console.log('error', err);
console.log(content);
});
```
## Running tests
Install dev dependencies.
```bash
npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/question-helper/issues)
## Related
* [template-helpers](https://github.com/jonschlinkert/template-helpers): Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.
* [handlebars-helpers](https://github.com/assemble/handlebars-helpers): 120+ Handlebars helpers in ~20 categories, for Assemble, YUI, Ghost or any Handlebars project. Includes helpers like {{i18}}, {{markdown}}, {{relative}}, {{extend}}, {{moment}}, and so on.
* [template](https://github.com/jonschlinkert/template): Render templates from any engine. Make custom template types, use layouts on pages, partials or any custom template type, custom delimiters, helpers, middleware, routes, loaders, and lots more. Powers Assemble v0.6.0, Verb v0.3.0 and your application.
* [engine-handlebars](https://github.com/jonschlinkert/engine-handlebars): Handlebars engine, consolidate.js style but with enhancements. This works with Assemble, express.js, engine-cache or any application that follows consolidate.js conventions.
* [engine-lodash](https://github.com/jonschlinkert/engine-lodash): Lo-Dash engine, consolidate.js style but with enhancements. Works with Assemble, express.js, engine-cache or any application that follows consolidate.js conventions.
## Author
**Brian Woodward**
+ [github/doowb](https://github.com/doowb)
+ [twitter/doowb](http://twitter.com/doowb)
## License
Copyright (c) 2015 Brian Woodward
Released under the MIT license
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 05, 2015._
[engine-handlebars]: https://github.com/jonschlinkert/engine-handlebars
[engine-lodash]: https://github.com/jonschlinkert/engine-lodash
[template]: https://github.com/jonschlinkert/template