API-first task runner with three methods: task, run and watch.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your :heart: and support.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm install --save composer
Heads up the .watch method was removed in version 0.11.0. If you need watch functionality, use base-tasks and base-watch.
const Composer = require('composer');
const composer = new Composer();
composer.task('default', cb => {
console.log('Task: ', this.name);
cb();
});
composer.build('default')
.then(() => console.log('done!'))
.catch(console.error);
Example
const composer = new Composer();
Dependencies may also be specified as a glob pattern. Be aware that the order cannot be guarenteed when using a glob pattern.
Params
name {String}: Name of the task to registeroptions {Object}: Options to set dependencies or control flow.options.deps {Object}: array of dependenciesoptions.flow {Object}: How this task will be executed with it's dependencies (series, parallel, settleSeries, settleParallel)deps {String|Array|Function}: Additional dependencies for this task.fn {Function}: Final function is the task to register.returns {Object}: Return the instance for chainingExample
// register task "site" with composer
app.task('site', ['styles'], function() {
return app.src('templates/pages/*.hbs')
.pipe(app.dest('_gh_pages'));
});
Params
tasks {String|Array}: Array of task names to build. (Defaults to [default]).options {Object}: Optional options object to merge onto each task's options when building.cb {Function}: Optional callback function to be called when all tasks are finished building. If omitted, a Promise is returned.returns {Promise}: When cb is omitted, a Promise is returned that will resolve when the tasks are finished building.Example
app.build('default', function(err, results) {
if (err) return console.error(err);
console.log(results);
});
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(done) {
console.log('this is foo');
done();
});
const fn = app.series('foo', function bar(done) {
console.log('this is bar');
done();
});
fn(function(err) {
if (err) return console.error(err);
console.log('done');
});
//=> this is foo
//=> this is bar
//=> done
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(done) {
setTimeout(function() {
console.log('this is foo');
done();
}, 500);
});
const fn = app.parallel('foo', function bar(done) {
console.log('this is bar');
done();
});
fn(function(err) {
if (err) return console.error(err);
console.log('done');
});
//=> this is bar
//=> this is foo
//=> done
When an individual task is run, a new Run instance is created with start, end, and duration information. This run object is emitted with some events and also exposed on the task instance as the .runInfo property.
The run instance has the the following properties
.date
The .date property is an object containing the .start and .end date timestamps created with new Date().
.hr
The .hr property is an object containing the .start, .end and .duration properties that are created by using process.hrtime(). These properties are the actual arrays returned from process.hrtime().
There is also .diff and .offset computed properties that use the other properties to calculate the difference between .start and .end times (.diff) and the offset (error for time calculations) between the .duration and the .diff (this is usually very small).
.duration
The .duration property is a computed property that uses pretty-time to format the .hr.duration value into a human readable format.
composer is an event emitter that may emit the following events:
This event is emitted when the build is starting and when it's finished. The event emits an object containing the build runtime information.
app.on('build', build => {});
build properties.app (object) - instance of Composer.status (string) - current build status[1], either register, starting or finished..date (object) - with a .start property indicating start time as a Date object..hr (object) - with a .start property indicating the start time as an hrtime array..duration (string) - that will provide the duration in a human readable format..diff (string) - diff between the start and end times..offset (string) offset between the start date and the start hr timeThis event is emitted when the task is registered, starting, and when it's finished. The event emits 2 arguments, the current instance of the task object and an object containing the task runtime information.
app.on('task', (task, run) => {});
task properties.status (string) - current status[2] of the task. May be register, starting, or finished.run properties.date (object) - has a .start property indicating the start time as a Date object..hr (object) - has a .start property indicating the start time as an hrtime array..duration (string) that will provide the duration in a human readable format..diff (string) that will provide the diff between the start and end times..offset (string) offset between the start date and the start hr timeThis event is emitted when an error occurrs during a build. The event emits an Error object with extra properties for debugging the build and task that were running when the error occurred.
app.on('error', err => {});
app: current composer instance running the buildbuild: current build runtime informationtask: current task instance running when the error occurredrun: current task runtime information.build to return a promise when the callback is not passed in. see issue #281.0.0.'in task "foo":' prefixed to the error message. see issue #22.runInfo on the task object for use in event listeners and task functions..duration to the .run/.runInfo object that shows the duration in a human friendly format. This will also show the current duration from the time the task started to the time it's called if used inside a task function. see issue #23app.task('foo', function(cb) {
console.log(this.runInfo.duration);
});
options.skip option to the name of the task or an array of task names.err properties non-enumerable to cut down on error output..task() method by passing only the name. Instead do var task = app.tasks[name];.task() will result in a noop task being created.options may be passed to .build(), .series() and .parallel()options passed to .build() will be merged onto task options before running the task.options.run option to false..task()..watch(). Watch functionality can be added to base applications using base-watch.session.default when no tasks are passed to .build().task when adding a task through .task().task(name) with only a name.task:* events instead of generic * events. See event docs for more information..task() is called without a name..task() is called without a name.err instances and emitting instead of emitting multiple parameters..run() to .build().watch returns an instance of FSWatcher.task() without a name.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 222 | doowb |
| 39 | jonschlinkert |
Brian Woodward
Copyright © 2018, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on March 02, 2018.
FAQs
Run and compose async tasks. Easily define groups of tasks to run in series or parallel.
The npm package composer receives a total of 5,870 weekly downloads. As such, composer popularity was classified as popular.
We found that composer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.