generate-ask

generate-ask

Adds user prompts to your generator for getting data that is commonly for rendering templates, like author name, project name, etc.

Install

Install with npm:

$ npm i generate-ask --save

Usage

getting started

If you're not already familiar with generate, you might find generate's getting started guide useful before continuining.

extend your generator

Extend your generator with features and settings from generate-ask:

module.exports = function(app) {
  app.extendWith(require('generate-ask'));

  // do generator stuff
};

That's it! you should now be able to use any features from generate-ask as if they were created in your own generator.

Advanced usage

Lazily-extend your generator

Call the ask to lazily add the features and settings from generate-ask.

This approach offers the advantage of choosing when and where to invoke generate-ask inside your own generator.

module.exports = function(app) {
  app.extendWith(require('generate-ask'));

  app.task('foo', function(cb) {
    // do task stuff
    cb();
  });

  // before running task `foo`, you MUST RUN the `ask`
  // to get the features from generate-ask loaded onto your
  // generator's instance
  app.task('default', ['ask', 'foo']);
};

Compatibility

This generator works with:

• generate
• verb
• update (soon)
• assemble (soon)

Generate docs

Generate readme and API documentation with verb:

$ npm i -d && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on February 20, 2016.