Package Exports
- gear
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gear) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Gear.js
Task-Based Build System
Gear.js is a scriptable build system using simple tasks that act like a sequence of piped commands.
Features include:
- Basic building blocks that can be combined to perform complex builds.
- Tasks are simply defined and keep system internals to a minimum.
- Asynchronous execution.
- Extensible task loading via NPM, file, or directory.
- Advanced flow control for complex task execution.
Installation
To get the most out of Gear.js, you will want to install gear-lib which contains tasks for linting, minifying, and deploying JS/CSS assets.
$ npm install gear
$ npm install gear-libQuick Examples
Chaining Tasks
new Queue()
.load('foo.js')
.log('read foo.js')
.inspect()
.write('foobarbaz.js')
.run();Execute Tasks Using Array Style
new Queue()
.load(['foo.js', {name: 'bar.js'}, 'baz.js'])
.log('read foo.js')
.inspect()
.write(['newfoo.js', 'newbar.js']) // Not writing 'baz.js'
.run();Complex Task Execution
new Queue()
.load('foo.js')
.log('Complex Task')
.tasks({
read: {task: 'load', options: ['foo.js', 'bar.js', 'baz.js']}
combine: {task: 'concat', requires: 'read'}
minify: {task: 'jsminify', requires: 'combine'}
print: {task: 'inspect', requires: ['read', 'combine', 'minify']} // Runs when read, combine, and minify complete
parallel: {task: 'log', options: "Hello gear world!"} // Run parallel to read
}).run();Documentation
Core
Core Tasks
Library Tasks
Custom Tasks
## Core ### Queue(options)Queue constructor.
Arguments
- options.registry - Registry loaded with available tasks.
Example
new Queue()
.log('test')
.run();### Queue.task(name, options)
Helper method to run the specified task. Preferred task execution style is to call the task directly i.e. inspect() instead of task('inspect').
Arguments
- name - Name of task in registry.
Example
new Queue()
.task('log', 'Hello, world!')
.run();### Queue.run(callback)
Runs the queue.
Arguments
- callback - (optional) Callback accepting (err, results)
Example
new Queue()
.log('test')
.run();### Registry()
Creates a new Registry instance. Registries contain available tasks.
Arguments
- options - (optional) Same as .load
Example
new Registry();### Registry.load(options)
Load tasks from NPM, directory, or file.
Arguments
- options.module - Module to load tasks from.
- options.dirname - Directory to load tasks from.
- options.filename - File to load tasks from.
- options.tasks - Object to load tasks from.
Example
new Registry().load({dirname: 'foo'});## Tasks ### load(sources)
Loads blobs from different sources.
Arguments
- sources - List of sources.
Example
// source - Filename or object to load.
// source.name - Filename of resource.
.load('foo')
.load(['foo', 'baz'])
.load([{name: 'foo'}, {name: 'bar'}, {name: 'baz'}])### write(options)
Arguments
- options.name - File to write, will replace {checksum} with hash of blob content.
Write the blob to disk.
Example
.write('foo')
.write({name: 'foo'})### concat()
Concatenates blobs.
Example
.concat()### inspect()
Inspects blobs.
Example
.inspect()### log(string)
Arguments
- string - String to log.
Log a message.
Example
.log('Finished')### tasks(workflow)
Arguments
- workflow - Task workflow.
Execute tasks in parallel with optional dependencies. Data is joined on completion.
Example
// label - Task instance name.
// label.task - Task name.
// label.options - Task options.
// label.requires - List of labels that must be executed before this task runs.
.tasks({
label_1: {task: 'log', options: 'Hello, world!'}
label_2: {task: 'log', options: 'Hello, world 2!', requires: 'label_1'}
})Install gear-lib which contains tasks such as:
- jslint
- jsminify
- csslint
- cssminify
- s3
$ npm install gear-libWriting a task is especially easy compared to other Node build systems. There is no need to use Gear.js internals within a task. Tasks operate on immutable blobs. Blobs have a body property. The task returns transformed data via its callback.
Arguments
- options - Options for the task.
- blob - Immutable blob.
- done(err, result) - Callback executed when task is complete.
Example
// example.js
// Example task creates new blob containing `string`
exports.example = function(string, blob, done) {
done(null, new blob.constructor(string)); // blob.constructor() is equivalent to Blob()
};Running Example Task
new Queue({registry: new Registry({filename: 'example.js'})})
.example('EXAMPLE')
.run();Who's Using Gear.js
- Mojito Shaker by Yahoo.
Special Thanks
Gear.js takes inspiration from a few sources: