Base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to your Base application.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your â¤ï¸ and support.
InstallInstall with npm:
Usage$ npm install --save base-task
const Base = require('base');
const tasks = require('base-task');
const base = new Base();
Â
base.use(tasks());
Â
Â
base.task('foo', cb => {
  console.log('this is foo!');
  cb();
});
Â
base.task('bar', cb => {
  console.log('this is bar!');
  cb();
});
Â
Â
base.build(['foo', 'bar'])
  .then(() => {
   Â
   Â
    console.log('done!');
  })
  .catch(console.error)
See the composer documentation for more details, or to create bug reports related to running or registering tasks.
API .taskRegister 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 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
.buildconst task = app.task('site');
Run a task or array of tasks.
Promise examples
app.build();
app.build('default');
Â
app.build(['foo', 'bar'])
  .then(() => console.log('done!'))
  .catch(console.error);
Callback examples
.seriesapp.build(function(err, results) {
  if (err) return console.error(err);
  console.log(results);
});
Â
app.build('default', function(err, results) {
  if (err) return console.error(err);
  console.log(results);
});
Â
app.build(['foo', 'bar'], function(err, results) {
  if (err) return console.error(err);
  console.log(results);
});
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
.parallelapp.task('foo', cb => {
  console.log('this is foo');
  cb();
});
Â
const build = app.series('foo', cb => {
  console.log('this is bar');
  cb();
});
Â
build(function(err)Â {
  if (err) return console.error(err);
  console.log('finished');
});
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
Eventsapp.task('foo', cb => {
  setTimeout(function() {
    console.log('this is foo');
    cb();
  }, 500);
});
Â
const build = app.parallel('foo', cb => {
  console.log('this is bar');
  cb();
});
Â
build(function(err)Â {
  if (err) return console.error(err);
  console.log('finished');
});
The following events are emitted by composer. See the composer docs for more details
on.taskEmitted when a task
is register
, starting
and finished
.
on.buildapp.on('task', function(task) {
  console.log(task.status);
 Â
});
Emitted when a build
is starting
and finished
.
History v2.0.0app.on('build', function(build) {
  console.log(build.status);
 Â
});
.watch
method is no longer included by default. To add .watch
, use the base-watch plugin.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running TestsRunning 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:
Building docs$ npm install && npm test
(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:
Related projects$ npm install -g verbose/verb#dev verb-generate-readme && verb
Other base plugins you might be interested in:
base
application. | homepageoption
, enable
and disable
. See the readme⦠more | homepageJon Schlinkert
LicenseCopyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on November 22, 2018.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4