maelstrom

A collection of gulp tasks

Installation

npm install --save maelstrom

Before installing maelstrom, make sure you have installed all the required software, packages and gems.

How to use

After installation you can configure maelstrom by creating a maelstrom config file in your project root folder (same folder as where your package.json and gulpfile.js files are located). See config for more detailed information and all available options.

Using all default plugins and tasks

If you would like maelstrom to add all of it's default tasks to gulp. you only have to have the following two lines in your gulpfile.js:

var gulp      = require('gulp');
var maelstrom = require('maelstrom').init(gulp);

Note that you should pass gulp to the maelstrom.init function wich is returned by require('maelstrom'). Without this, maelstrom will not work.

Using a specific plugin/task

When you only want to use a certain plugin and/or task, you'll have to add a little bit more code. Below you'll find an example of what is possible. For a better explanation of the used maelstrom functions, check the API.

var gulp      = require('gulp');
var maelstrom = require('maelstrom');

// init maelstrom
maelstrom.init(gulp, false);
// add one of maelstrom's default tasks to gulp
maelstrom.task('some-default-maelstrom-task');

// or you can use a maelstrom plugin in your own task
gulp.task('my-custom-task', function()
{
    // replace 'pluginName' with the name of the plugin you'd like to use
    gulp.src( maelstrom.pluginName.src() ) // <-- use src from plugin
        .pipe( maelstrom.pluginName() ) // <-- add plugin to the stream
        .pipe( gulp.dest('path/to/dest/') );
});

// call the plugin's default watch function
gulp.task('watch', function()
{
    maelstrom.watch('some-default-maelstrom-task');
});

When using maelstrom.watch(), don't forget to first add the task with maelstrom.task().

Ofcourse you can combine the above examples by requiring maelstrom so it'll add all default tasks, and still be able to use the plugins in your own custom tasks!

More info

Requirements: What software, packages and gems are required?
Config: All available config options described and explained.
API: Want to know how to use the maelstrom functions?
Plugins: Detailed descriptions for all default maelstrom plugins.
Tasks: More info about maelstrom's default gulp tasks.

roeldev/maelstrom