base-task
Version:
Base plugin that provides a very thin wrapper around <https://github.com/doowb/composer> for adding task methods to your Base application.
299 lines (208 loc) • 8.89 kB
Markdown
# base-task [](https://www.npmjs.com/package/base-task) [](https://npmjs.org/package/base-task) [](https://npmjs.org/package/base-task) [](https://travis-ci.org/base/base-task)
> Base plugin that provides a very thin wrapper around [https://github.com/doowb/composer](https://github.com/doowb/composer) for adding task methods to your Base application.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save base-task
```
## Usage
```js
const Base = require('base');
const tasks = require('base-task');
const base = new Base();
base.use(tasks());
/**
* Define tasks
*/
base.task('foo', cb => {
console.log('this is foo!');
cb();
});
base.task('bar', cb => {
console.log('this is bar!');
cb();
});
/**
* Build tasks
*/
base.build(['foo', 'bar'])
.then(() => {
// this is foo!
// this is bar!
console.log('done!');
})
.catch(console.error)
```
See the [composer](https://github.com/doowb/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](https://github.com/doowb/composer) know when the task is finished.
**Examples**
Register a task.
```js
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):
```js
app.task('site', ['styles'], function() {
return app.src('pages/*.hbs')
.pipe(app.dest('dist'));
});
app.task('default', ['site']);
```
**Get a task**
```js
const task = app.task('site');
```
### .build
Run a task or array of tasks.
**Promise examples**
```js
// run the "default" task, if defined
app.build();
app.build('default');
// run an array of tasks
app.build(['foo', 'bar'])
.then(() => console.log('done!'))
.catch(console.error);
```
**Callback examples**
```js
// run the "default" task, if defined
app.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);
});
```
### .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**
```js
app.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');
});
//=> 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**
```js
app.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');
});
//=> this is bar
//=> this is foo
//=> finished
```
## Events
The following events are emitted by [composer](https://github.com/doowb/composer). See the composer docs for more details
### on.task
Emitted when a `task` is `register`, `starting` and `finished`.
```js
app.on('task', function(task) {
console.log(task.status);
//=> 'register'
});
```
### on.build
Emitted when a `build` is `starting` and `finished`.
```js
app.on('build', function(build) {
console.log(build.status);
//=> 'starting'
});
```
## History
### v2.0.0
* Bumped [composer](https://github.com/doowb/composer) to v2.0.0.
### v0.3.0
* Bumped [composer](https://github.com/doowb/composer) to v0.11.0, so the `.watch` method is no longer included by default. To add `.watch`, use the [base-watch](https://github.com/node-base/base-watch) plugin.
## About
<details>
<summary><strong>Contributing</strong></summary>
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
</details>
<details>
<summary><strong>Running Tests</strong></summary>
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:
```sh
$ npm install && npm test
```
</details>
<details>
<summary><strong>Building docs</strong></summary>
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
</details>
### Related projects
Other base plugins you might be interested in:
* [base-cli](https://www.npmjs.com/package/base-cli): Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… [more](https://github.com/node-base/base-cli) | [homepage](https://github.com/node-base/base-cli "Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a few plugins, like 'base-store', 'base-options' and 'base-data'.")
* [base-generators](https://www.npmjs.com/package/base-generators): Adds project-generator support to your `base` application. | [homepage](https://github.com/node-base/base-generators "Adds project-generator support to your `base` application.")
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://github.com/node-base/base-option) | [homepage](https://github.com/node-base/base-option "Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.")
* [base-plugins](https://www.npmjs.com/package/base-plugins): Adds 'smart plugin' support to your base application. | [homepage](https://github.com/node-base/base-plugins "Adds 'smart plugin' support to your base application.")
* [base-store](https://www.npmjs.com/package/base-store): Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… [more](https://github.com/node-base/base-store) | [homepage](https://github.com/node-base/base-store "Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object that exposes all of the methods from the data-store library. Also now supports sub-stores!")
* [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks")
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 60 | [jonschlinkert](https://github.com/jonschlinkert) |
| 6 | [doowb](https://github.com/doowb) |
| 2 | [davequick](https://github.com/davequick) |
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 22, 2018._