base-task

base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to your application.

You might also be interested in base-watch.

Install

Install with npm:

$ npm install --save base-task

Usage

var Base = require('base');
var tasks = require('base-task');

var base = new Base();
// Since some applications have multiple types of plugins, you must 
// set "isApp" on the instance you want base-task to run on 
base.isApp = true;
base.use(tasks());

/**
 * Define tasks
 */

base.task('foo', function(cb) {
  console.log('this is foo!');
  cb();
});
base.task('bar', function(cb) {
  console.log('this is bar!');
  cb();
});

/**
 * Build tasks
 */

base.build(['foo', 'bar'], function(err) {
  // this is foo!
  // this is bar!
  console.log('done!');
});

See the composer documentation for more details, or to create bug reports related to running or registering tasks.

API

.task

Register a task

Params

• name {String}: Task name to register (tasks are cached on app.tasks)
• dependencies {String|Array|Function}: String, list or array of tasks.
• callback {Function}: Function to be called when the task is executed. Task functions should either return a stream or call the callback to let composer know when the task is finished.

Examples

Register a task.

app.task('default', function() {
  // return the stream to signal "done"
  return app.src('pages/*.hbs')
    .pipe(app.dest('dist'));
});

Register a task with dependencies (other tasks to run before executing the task):

app.task('site', ['styles'], function() {
  return app.src('pages/*.hbs')
    .pipe(app.dest('dist'));
});

app.task('default', ['site']);

Get a task

var task = app.task('site');

.build

Run a task or array of tasks.

Example

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

.series

Compose task or list of tasks into a single function that runs the tasks in series.

Params

• tasks {String|Array|Function}: List of tasks by name, function, or array of names/functions.
• returns {Function}: Composed function that may take a callback function.

Example

app.task('foo', function(cb) {
  console.log('this is foo');
  cb();
});

var fn = app.series('foo', function(cb) {
  console.log('this is bar');
  cb();
});

fn(function(err) {
  if (err) return console.error(err);
  console.log('finished');
});
//=> this is foo
//=> this is bar
//=> finished

.parallel

Compose task or list of tasks into a single function that runs the tasks in parallel.

Params

• tasks {String|Array|Function}: List of tasks by name, function, or array of names/functions.
• returns {Function}: Composed function that may take a callback function.

Example

app.task('foo', function(cb) {
  setTimeout(function() {
    console.log('this is foo');
    cb();
  }, 500);
});

var fn = app.parallel('foo', function(cb) {
  console.log('this is bar');
  cb();
});

fn(function(err) {
  if (err) return console.error(err);
  console.log('finished');
});
//=> this is bar
//=> this is foo
//=> finished

Events

The following events are emitted by composer. See the composer docs for more details

on.task

Emitted when a task is register, starting and finished.

app.on('task', function(task) {
  console.log(task.status);
  //=> 'register'
});

on.build

Emitted when a build is starting and finished.

app.on('build', function(build) {
  console.log(build.status);
  //=> 'starting'
});

History

v0.3.0

• Bumped composer to v0.11.0, so the .watch method is no longer included by default. To add .watch, use the base-watch plugin.

About

Related projects

• base-cli: Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… more | homepage
• base-generators: Adds project-generator support to your base application. | homepage
• base-option: Adds a few options methods to base, like option, enable and disable. See the readme… more | homepage
• base-plugins: Adds 'smart plugin' support to your base application. | homepage
• base-store: Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… more | homepage
• base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage

Contributing

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

Contributors

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 17, 2017.