base-list

base-runner plugin that prompts the user to choose from a list of registered applications and their available tasks.

Install

Install with npm:

$ npm i base-list --save

Usage

var list = require('base-list');
app.use(list());

API

.baseListPlugin

Build grouped lists of tasks.

Params

• prop {String}: e.g. generators
• options {String}: Additional options to control output styling
• options.appColor {String}: Color to use when displaying the app names.
• options.taskColor {String}: Color to use when displaying task names.
• options.depColor {String}: Color to use when displaying task dependencies.
• options.appMsg {String}: Message to display for the app name. This is a template that may contain :name where the app name should be. (defaults to ":name")
• options.taskMsg {String}: Message to display for the task name. This is a template that may contain :name and :deps where the task name and the task depdencies should be. (defaults to ":name :deps")

displayTasks

Display the application hierarchy of apps and tasks in a formatted tree.

Example

app.displayTasks()

chooseTasks

Present a multiple choice list of apps and tasks to run. Return results from a user making choices.

Params

• cb {Function}: Callback function that will return any errors or the results of the user choices.

Example

app.chooseTasks(function(err, results) {
  if (err) return console.error(err);
  console.log(results);
});

Related projects

• base-methods: base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• base-runner: Orchestrate multiple instances of base-methods at once. | homepage
• base-tree: Add a tree method to generate a hierarchical tree structure representing nested applications and child… more | homepage
• use: Easily add plugin support to your node.js application. | homepage

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

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016 Brian Woodward Released under the MIT license.

This file was generated by verb on January 14, 2016.